{ "commands": { "describe-design-system": { "aliases": [ "describe-design-system" ], "args": {}, "description": "Describe structure of single design system by provided ID", "examples": [ "$ @supernovaio/cli describe-design-system --apiKey=\"{xxx-xxx-xxx}\" --designSystemId=\"{1234}\"" ], "flags": { "apiKey": { "description": "API key to use for accessing Supernova instance", "name": "apiKey", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "designSystemId": { "description": "Design System to describe structure of", "name": "designSystemId", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "proxyUrl": { "description": "When set, CLI will use provided proxy URL for all requests", "hidden": true, "name": "proxyUrl", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "describe-design-system", "pluginAlias": "@supernovaio/cli", "pluginName": "@supernovaio/cli", "pluginType": "core", "SKIP_VERSION_CHECK": {}, "isESM": true, "relativePath": [ "dist", "commands", "describe-design-system.js" ] }, "describe-workspaces": { "aliases": [ "describe-workspaces" ], "args": {}, "description": "Describe structure of all workspaces and design systems available under those workspaces available for specified API key", "examples": [ "$ @supernovaio/cli describe-workspaces --apiKey=\"{xxx-xxx-xxx}\"" ], "flags": { "apiKey": { "description": "API key to use for accessing Supernova instance", "name": "apiKey", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "proxyUrl": { "description": "When set, CLI will use provided proxy URL for all requests", "hidden": true, "name": "proxyUrl", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "describe-workspaces", "pluginAlias": "@supernovaio/cli", "pluginName": "@supernovaio/cli", "pluginType": "core", "SKIP_VERSION_CHECK": {}, "isESM": true, "relativePath": [ "dist", "commands", "describe-workspaces.js" ] }, "login": { "aliases": [], "args": {}, "description": "Login to the Supernova", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "login", "pluginAlias": "@supernovaio/cli", "pluginName": "@supernovaio/cli", "pluginType": "core", "SKIP_VERSION_CHECK": {}, "isESM": true, "relativePath": [ "dist", "commands", "login.js" ] }, "logout": { "aliases": [], "args": {}, "description": "Logout from the Supernova", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "logout", "pluginAlias": "@supernovaio/cli", "pluginName": "@supernovaio/cli", "pluginType": "core", "SKIP_VERSION_CHECK": {}, "isESM": true, "relativePath": [ "dist", "commands", "logout.js" ] }, "publish-documentation": { "aliases": [ "publish-documentation" ], "args": {}, "description": "Publish latest version of the documentation", "examples": [ "$ @supernovaio/cli publish-documentation --apiKey=\"{xxx-xxx-xxx}\" --designSystemId=\"{1234}\"" ], "flags": { "apiKey": { "description": "API key to use for accessing Supernova instance", "name": "apiKey", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "awaitPublishJob": { "description": "Whether to block the process until the publishing is done. Setting the flag to false will exit with success as long as documentation publish was successfully triggered, but before the publish is completed. Setting the flag to true will exit once the publish is complete and will throw if documentation publish is not successful.", "name": "awaitPublishJob", "allowNo": false, "type": "boolean" }, "designSystemId": { "description": "Design System to publish the documentation", "name": "designSystemId", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dev": { "description": "When enabled, CLI will target dev server", "hidden": true, "name": "dev", "allowNo": false, "type": "boolean" }, "proxyUrl": { "description": "When set, CLI will use provided proxy URL for all requests", "hidden": true, "name": "proxyUrl", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target": { "description": "Environment to use for publishing: Live or Preview", "name": "target", "required": false, "default": "Live", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "publish-documentation", "pluginAlias": "@supernovaio/cli", "pluginName": "@supernovaio/cli", "pluginType": "core", "SKIP_VERSION_CHECK": {}, "isESM": true, "relativePath": [ "dist", "commands", "publish-documentation.js" ] }, "run-local-exporter": { "aliases": [ "run-local-exporter" ], "args": {}, "description": "Run local exporter package", "examples": [ "$ @supernovaio/cli run-local-exporter --apiKey=\"[API_KEY]\" --designSystemId=\"[DESIGN_SYSTEM_ID]\" --themeId=\"[THEME_ID]\" --brandId=\"[BRAND_ID]\" --exporterDir=\"[./path/to/exporter/dir]\" --outputDir=\"[./path/to/output/dir]\" --allowOverridingOutput\n " ], "flags": { "allowOverridingOutput": { "description": "When enabled, CLI will override output in the output directory if same files where present. When disabled, encountering the same file with throw an error.", "name": "allowOverridingOutput", "required": false, "allowNo": false, "type": "boolean" }, "apiKey": { "description": "API key to use for accessing Supernova instance", "name": "apiKey", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "brandId": { "description": "Brand to export. Will only be used when exporter has usesBrands: true, but then it is required to be provided", "name": "brandId", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "designSystemId": { "description": "Design System to export from", "name": "designSystemId", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "exporterDir": { "description": "Path to exporter package", "name": "exporterDir", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "outputDir": { "description": "Path to output folder. Must be empty, unless `forceClearOutputDir` is set", "name": "outputDir", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "proxyUrl": { "description": "When set, CLI will use provided proxy URL for all requests", "hidden": true, "name": "proxyUrl", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "themeId": { "description": "Theme to export. Will only be used when exporter has usesThemes: true, and is optional", "name": "themeId", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "run-local-exporter", "pluginAlias": "@supernovaio/cli", "pluginName": "@supernovaio/cli", "pluginType": "core", "SKIP_VERSION_CHECK": {}, "isESM": true, "relativePath": [ "dist", "commands", "run-local-exporter.js" ] }, "storybook-import": { "aliases": [], "args": {}, "description": "Import storybook static export to Supernova", "examples": [ "<%= config.bin %> <%= command.id %> import-storybook " ], "flags": { "brandId": { "char": "b", "description": "Import storybooks to brand of", "name": "brandId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "designSystemId": { "char": "d", "description": "Import storybooks to design system of", "name": "designSystemId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "from": { "char": "f", "description": "Directory with storybook static export to import.", "name": "from", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "char": "n", "description": "Import storybooks with name of", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sourceId": { "char": "s", "description": "Import storybooks to source of", "name": "sourceId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "publicAccess": { "description": "Allow public access to the published Storybook website. Can be used in combination with public documentation.", "name": "publicAccess", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "storybook-import", "pluginAlias": "@supernovaio/cli", "pluginName": "@supernovaio/cli", "pluginType": "core", "SKIP_VERSION_CHECK": {}, "isESM": true, "relativePath": [ "dist", "commands", "storybook-import.js" ] }, "sync-tokens": { "aliases": [ "sync-tokens" ], "args": {}, "description": "Synchronize tokens from Figma Tokens plugin to Supernova workspaces", "examples": [ "$ @supernovaio/cli sync-tokens --apiKey=\"{xxx-xxx-xxx}\" --designSystemId={1234} --tokenFilePath \"/path/to/tokens.json\" --configFilePath \"/path/to/config.json\"", "$ @supernovaio/cli sync-tokens --apiKey=\"{xxx-xxx-xxx}\" --designSystemId={1234} --tokenDirPath \"/path/to/tokens/\" --configFilePath \"/path/to/config.json\"" ], "flags": { "apiKey": { "description": "API key to use for accessing Supernova instance", "name": "apiKey", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "apiUrl": { "description": "API url to use for accessing Supernova instance, would ignore defaults", "hidden": true, "name": "apiUrl", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "configFilePath": { "description": "Path to configuration JSON file", "exclusive": [], "name": "configFilePath", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "designSystemId": { "description": "Design System to synchronize contents with", "name": "designSystemId", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "proxyUrl": { "description": "When set, CLI will use provided proxy URL for all requests", "hidden": true, "name": "proxyUrl", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tokenDirPath": { "description": "Path to directory of JSON files containing token definitions", "name": "tokenDirPath", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tokenFilePath": { "description": "Path to JSON file containing token definitions", "name": "tokenFilePath", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "sync-tokens", "pluginAlias": "@supernovaio/cli", "pluginName": "@supernovaio/cli", "pluginType": "core", "SKIP_VERSION_CHECK": {}, "isESM": true, "relativePath": [ "dist", "commands", "sync-tokens.js" ] }, "template-upload": { "aliases": [], "args": {}, "description": "Upload component container template to Supernova", "examples": [ "<%= config.bin %> <%= command.id %> TemplateUpload " ], "flags": { "workspaceId": { "char": "w", "description": "Workspace ID to upload the template to", "name": "workspaceId", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "designSystemId": { "char": "d", "description": "Design system ID to upload the template to", "name": "designSystemId", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Allows overwriting already published version of this template if it exists. This flag has no effect on new versions.", "name": "force", "required": false, "allowNo": false, "type": "boolean" }, "npmToken": { "description": "Allows passing NPM token as a Docker secret. The token will be available as NPM_TOKEN env variable", "name": "npmToken", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "discover": { "description": "Run template and pattern discovery before upload to update package.json", "name": "discover", "required": false, "allowNo": false, "type": "boolean" }, "dockerImageUri": { "description": "Set this flag to upload image to a custom Docker registry, omit to use Supernova Docker registry. The registry needs to be accessible by Supernova, and authentication must be provided using 'dockerUser' and 'dockerPassword' flags", "name": "dockerImageUri", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dockerUser": { "description": "Username for accessing custom Docker registry, to be used in combination with 'dockerImageUri'. Supernova will pass it to 'docker login'.", "name": "dockerUser", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dockerPassword": { "description": "Password for accessing custom Docker registry, to be used in combination with 'dockerImageUri'. Supernova will pass it to 'docker login'. Set this to '-' to accept password from stdin.", "name": "dockerPassword", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "uploadAsTar": { "description": "Export the built Docker image as a tar file and upload it through the files API instead of pushing it to a Docker registry.", "name": "uploadAsTar", "required": false, "allowNo": false, "type": "boolean" }, "imageTar": { "description": "Path to a Docker image exported as tar. When used, CLI will skip internal Docker build and upload the image instead. The image must comply with basic Supernova requirements.", "name": "imageTar", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "debug": { "description": "Preserve shell directory and App.tsx on template build failures for debugging", "hidden": true, "name": "debug", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "template-upload", "pluginAlias": "@supernovaio/cli", "pluginName": "@supernovaio/cli", "pluginType": "core", "SKIP_VERSION_CHECK": {}, "isESM": true, "relativePath": [ "dist", "commands", "template-upload.js" ] }, "whoami": { "aliases": [], "args": {}, "description": "Print information about currently logged in user", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "whoami", "pluginAlias": "@supernovaio/cli", "pluginName": "@supernovaio/cli", "pluginType": "core", "SKIP_VERSION_CHECK": {}, "isESM": true, "relativePath": [ "dist", "commands", "whoami.js" ] }, "code:analyze": { "aliases": [], "args": {}, "description": "# Analyze Code And Push Snapshots\n\nUse `supernova code analyze` to run the full code snapshot pipeline.\n\nAnalyze scans your design system source code, its components, and package adoption across your codebase. Supernova turns the captured metadata and adoption signals into product knowledge that enhances prototyping and AI-assisted documentation flows.\n\n## Typical Flow\n\nRun the full pipeline (components + usage):\n\n```bash\nsupernova code analyze --package @design-system-package\n```\n\nIf you already have packages configured in `supernova.config.json`, you can omit `--package`.\n\nFor multiple packages, repeat the flag:\n\n```bash\nsupernova code analyze --package @design-system-package --package @icons-package\n```\n\nBy default the usage scan runs across all discovered workspace packages. To skip specific packages, repeat `--exclude` — accepts either a package name or a relative path:\n\n```bash\nsupernova code analyze --package @design-system-package --exclude @acme/utils\nsupernova code analyze --package @design-system-package --exclude packages/utils\n```\n\nWizard-selected exclusions and `--exclude` values are persisted to `analyze.excludedPackages` in `supernova.config.json`, so later runs don't need the flag.\n\nRunning `supernova code analyze` with no flags and no saved config launches an interactive wizard. Use `--wizard` to force it even when flags or a saved config are present.\n\n## Command Overview\n\n```bash\nsupernova code analyze --package [--package ...] [--exclude ...] [--includeAllProps]\n```\n\n## Related Commands\n\n```bash\nsupernova code analyze status [--designSystemId ]\n```\n\n## Flags\n\n| Flag | Short | Required | Description |\n| ----------------------- | ----- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `--package ` | `-p` | Conditionally | Package name. Repeatable. Required only when `analyze.packages` is not already stored in `supernova.config.json`. |\n| `--exclude ` | | No | Package name or relative path to exclude from the usage scan. Repeatable. Merged with `analyze.excludedPackages` from config. |\n| `--designSystemId ` | `-d` | No | Design system ID. If omitted, the CLI uses the root `designSystemId` from `supernova.config.json` or prompts before upload. |\n| `--wizard` | | No | Force the interactive wizard even when flags or a saved config are present. |\n| `--dryRun` | | No | Write local snapshots only and skip upload. |\n| `--includeAllProps` | | No | Include inherited framework, DOM, and style props in component API output. By default, the analyzer filters those props to keep snapshots focused on component APIs. |\n| `--no-wait` | | No | Upload snapshots and start processing, but do not wait for backend processing to finish. Useful for CI. |\n\n## Config File\n\nThe CLI reads and writes `supernova.config.json` in the current working directory. If the file does not exist yet, running the command creates it when analyze settings are persisted.\n\nExample:\n\n```json\n{\n \"designSystemId\": \"123\",\n \"analyze\": {\n \"repoId\": \"7c8e9b6b-4c0a-4dbd-8f78-2d5c3d6a9f10\",\n \"packages\": [\"@design-system-package\"],\n \"excludedPackages\": [\"excluded-package\"]\n }\n}\n```\n\nThis means later runs can be shorter. For example, if `packages` is already stored, you can run:\n\n```bash\nsupernova code analyze\n```\n\nThe analyze section currently stores:\n\n- `designSystemId`\n- `analyze.repoId`\n- `analyze.packages`\n- `analyze.excludedPackages`\n\n## What Gets Created\n\nThe analyzer writes snapshot artifacts under:\n\n```text\n/.supernova/snapshots//\n```\n\nMain files:\n\n- `raw/*.json` analyzer outputs\n\n## Monorepo Behavior\n\nFor `supernova code analyze`, the CLI resolves multiple package targets in monorepos.\n\nRules:\n\n- components scans run once per `analyze.packages`\n- usage scans run per workspace package, excluding `excludedPackages`\n- usage scans include all configured packages in each snapshot\n- targets with zero adoption are skipped\n\n## Upload And Processing Behavior\n\n1. CLI uploads snapshot archive(s)\n2. CLI finalizes each snapshot upload\n3. CLI starts a processing run for all uploaded snapshots\n4. CLI waits for processing to finish by default\n\nUse `--no-wait` to skip the final polling step, for example in CI.\n\n### `analyze status`\n\nUse `supernova code analyze status` to watch the processing state of uploaded snapshots for the current user.\n\nOptional flag:\n\n- `--designSystemId ` or `-d`: skip interactive design system selection. If omitted, the command uses the root `designSystemId` from `supernova.config.json` when available.\n\nThe command keeps polling until there are no active processing runs left, or until it times out.\n\n## Dry Run\n\nUse this to verify scan output without uploading anything:\n\n```bash\nsupernova code analyze \\\n --package @design-system-package \\\n --dryRun\n```", "examples": [ "<%= config.bin %> <%= command.id %> --package @acme/ds --dryRun", "<%= config.bin %> <%= command.id %> --designSystemId 1234 --package @acme/ds", "<%= config.bin %> <%= command.id %> --package @acme/ds --package @acme/icons", "<%= config.bin %> <%= command.id %> --package @acme/ds --exclude @acme/utils", "<%= config.bin %> code analyze status --designSystemId 1234" ], "flags": { "designSystemId": { "char": "d", "description": "Design system ID", "name": "designSystemId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package": { "char": "p", "description": "Component package name eg. @design-system-package. Can be repeated.", "name": "package", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude": { "description": "Package name or relative path to exclude from the usage scan (eg. @utility-package or packages/utility). Can be repeated.", "name": "exclude", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "dryRun": { "description": "Run and write local snapshot only. Never uploads.", "name": "dryRun", "allowNo": false, "type": "boolean" }, "includeAllProps": { "description": "Include inherited framework, DOM, and style props in component API output.", "name": "includeAllProps", "allowNo": false, "type": "boolean" }, "noWait": { "description": "Start processing and exit without waiting for completion.", "name": "noWait", "allowNo": false, "type": "boolean" }, "suppressDryRunNotice": { "hidden": true, "name": "suppressDryRunNotice", "allowNo": false, "type": "boolean" }, "wizard": { "description": "Run full wizard flow even when flags or a saved config are present.", "name": "wizard", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "code:analyze", "pluginAlias": "@supernovaio/cli", "pluginName": "@supernovaio/cli", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "code", "analyze.js" ] }, "container:prepare": { "aliases": [], "args": {}, "description": "Prepare a container package to be uploaded to Supernova. This makes sure private packages are available directly in the container. Must be executed in the package root next to package.json file. The package must use NPM as its package manager.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "container:prepare", "pluginAlias": "@supernovaio/cli", "pluginName": "@supernovaio/cli", "pluginType": "core", "SKIP_VERSION_CHECK": {}, "isESM": true, "relativePath": [ "dist", "commands", "container", "prepare.js" ] }, "prototyping:setup": { "aliases": [], "args": {}, "description": "Supernova Create Setup", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --restart" ], "flags": { "debug": { "description": "Enable setup debug shortcuts like skipping scan or upload steps", "hidden": true, "name": "debug", "allowNo": false, "type": "boolean" }, "restart": { "description": "Restart setup from the beginning and ignore unfinished setup state", "name": "restart", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "prototyping:setup", "pluginAlias": "@supernovaio/cli", "pluginName": "@supernovaio/cli", "pluginType": "core", "SKIP_VERSION_CHECK": {}, "isESM": true, "relativePath": [ "dist", "commands", "prototyping", "setup.js" ] }, "code:analyze:status": { "aliases": [], "args": {}, "description": "Show code snapshot processing status for current user", "examples": [ "<%= config.bin %> <%= command.id %> --designSystemId 123" ], "flags": { "designSystemId": { "char": "d", "description": "Design system ID", "name": "designSystemId", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "code:analyze:status", "pluginAlias": "@supernovaio/cli", "pluginName": "@supernovaio/cli", "pluginType": "core", "SKIP_VERSION_CHECK": {}, "isESM": true, "relativePath": [ "dist", "commands", "code", "analyze", "status.js" ] } }, "version": "2.2.5" }