import
Import an existing design system into Subframe by discovering files on disk, building a manifest, and uploading via the CLI.
Goal state: All design system files are uploaded to Subframe for processing.
Credentials
The CLI needs an auth token and project ID. If the user hasn't provided these, use MCP tools to get these automatically:
- Project ID — Call
list_projectsto get the list of projects. Each project includes aprojectId,name,teamId, andteamName.- One project: Use it automatically.
- Multiple projects: Always ask the user which project to use. Present each project with its
teamNameto disambiguate. If the user already mentioned a specific team or project name, match it against theteamNameandnamefields — but still confirm before proceeding. Never silently pick a project when multiple exist.
- Auth token — Call
generate_auth_tokenwith theteamIdfrom the user's selected project. Do not use ateamIdfrom a different project.
The project ID is also visible in any Subframe URL: app.subframe.com/<PROJECT_ID>/...
Fallback: If the MCP tools are not available, direct the user to https://app.subframe.com/cli/auth to get their auth token and project ID.
Workflow
1. Discover design system files
We only want visual/presentational layer files — the reusable UI primitives that make up the design system. Skip anything that's deeply coupled to business logic, data models, API calls, or application state.
Include:
- Pure UI components (buttons, inputs, cards, modals, badges, etc.)
- Layout primitives (containers, grids, stacks, etc.)
- Theme/styling files
- Stories
Exclude:
- Components that fetch data, call APIs, or manage application state
- Page-level components that wire together business logic
- Utility functions, hooks, or helpers that aren't visual
- Test files (other than stories)
Use Glob and Read tools to find files. Look for:
Theme files (global styling):
tailwind.config.*- Global CSS files (e.g.
globals.css,global.css,app.css,index.css) - Design token files (e.g.
tokens.json,tokens.ts,theme.ts)
Component files:
- React component files (
.tsx,.jsx) in component directories - Story files (
.stories.tsx,.stories.jsx,.stories.ts) - Component CSS modules
Use these search strategies:
- Look for
tailwind.config.*at the project root - Look for global CSS in
src/styles/,src/,app/,styles/ - Look for components in common directories:
src/components/,components/,src/ui/,ui/,lib/components/
When unsure whether a component is a design system primitive or an application component, quickly read the file — if it imports data-fetching libraries, stores, or API clients, skip it.
2. Group files by component
For each component, separate files into two categories:
entrypoint — the path to the main component file. Must reference one of the sourceFiles.
sourceFiles — the primary component implementation:
- The component source file(s) (
.tsx,.jsx) containing markup and styles
supportingFiles — everything else that helps understand the component:
- Story files (
.stories.tsx,.stories.jsx,.stories.ts) - CSS modules (
.module.css,.module.scss) - Documentation files (
.md)
Group by logical design system component — e.g. Button.tsx is a source file, while Button.stories.tsx, Button.module.css, and Button.md are supporting files for the "Button" component.
3. Write manifest
Create the .subframe/ directory if it doesn't exist, then write the manifest:
mkdir -p .subframe
Write the manifest to .subframe/import-design-system.json:
{
"theme": [
"tailwind.config.ts",
"src/styles/globals.css"
],
"components": [
{
"name": "Button",
"entrypoint": "src/components/Button.tsx",
"sourceFiles": [
"src/components/Button.tsx"
],
"supportingFiles": [
"src/components/Button.stories.tsx",
"src/components/Button.module.css"
]
}
]
}
Component names must be unique. If there are conflicting component names, ask the user how they would like to resolve them, e.g. by adding a prefix based on the directory.
4. Show summary before uploading
Before running the CLI, print a summary so the user can spot any issues:
- List of component names
- List of theme files
- Total file count
Then proceed with the upload. The user can interrupt if something looks wrong.
5. Submit for import
Run the CLI to submit the design system for import. This uploads the files to Subframe and kicks off an asynchronous import job — it does not complete the import inline.
Always pass the auth token so the CLI doesn't prompt interactively.
npx @subframe/cli@latest import -p {PROJECT_ID} --manifest .subframe/import-design-system.json --auth-token {TOKEN}
If any files are missing the CLI will abort with an error. Otherwise, report to the user that the import has been submitted and will be processed shortly.
Error Handling
- If the CLI exits with an error, show the full error output to the user
- Auth errors: try generating a new token with
generate_auth_token, or suggest the user re-authenticate athttps://app.subframe.com/cli/auth - Network errors: suggest checking connectivity and retrying
- If the manifest JSON is malformed, fix it and retry — don't ask the user to debug JSON