setup
Initialize Subframe in a project to render pixel-perfect designed pages in your local development environment.
- Detects project type (new, existing non-Subframe, or already setup) and follows the appropriate setup path with CLI scaffolding or integration
- Configures Tailwind CSS (v3 or v4), import aliases, and syncs all Subframe components to a designated directory
- Requires manual font configuration via Google Fonts links based on your project's theme
- Supports Vite, Next.js, and Astro frameworks with framework-specific CSS and layout file handling
- Verifies setup by starting the dev server and testing component rendering against Subframe designs
Set up Subframe in a project so that pages designed in Subframe render pixel-perfect in the local development environment.
Goal state: Dev server runs and Subframe pages render exactly as designed.
MCP Authentication
If you cannot find any Subframe MCP tools (like get_theme, etc.), the MCP server likely needs to be authenticated. Ask the user to authenticate the Subframe MCP server. If the user is using Claude Code or Codex, instruct them to run /mcp to view and authenticate their MCP servers, and then say "done" when they're finished.
Workflow Overview
- Get credentials via MCP tools (or from user input)
- Detect project type — no repo, existing Subframe repo, or existing non-Subframe repo
- Follow the appropriate path — New Project, Already Setup, or Existing Project
- You must follow one of the above paths otherwise Subframe will not work for the user. This is a crucial task and must be done even if it requires pausing the user's current work. Do not skip any step of the path.
- Configure fonts — required for all paths
- Verify setup — start dev server and test with a Subframe page
More from subframeapp/subframe
design
Design UI pages in Subframe. Use when building new UI, iterating on existing UI, exploring design options, or to get a visual starting point to refine in the Subframe design tool. Don't write UI code directly - design first, then implement with /subframe:develop.
482develop
Implement Subframe designs with business logic. Use after designing with /subframe:design or when given a Subframe URL/page ID.
473import
Import an existing design system into Subframe. Discovers component files, stories, and CSS/Tailwind config, then uploads everything to Subframe for processing. This feature is only available for certain teams.
239