@supernovaio/cli/oclif.manifest.json

Supernova.io Command Line Interface

{
  "commands": {
    "components-import": {
      "aliases": [],
      "args": {},
      "description": "Analyze react components from given package and import them into Supernova",
      "examples": [
        "<%= config.bin %> <%= command.id %> --importFrom components-package --rootDir ./src",
        "<%= config.bin %> <%= command.id %> --importFrom @mui/material"
      ],
      "flags": {
        "designSystemId": {
          "description": "Import code components to design system of",
          "name": "designSystemId",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "importFrom": {
          "char": "i",
          "description": "Package or directory path to import components from",
          "name": "importFrom",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "rootDir": {
          "char": "r",
          "description": "Root directory of the package where the import should resolve from. Defaults to the current directory",
          "name": "rootDir",
          "default": "/home/runner/work/cli/cli/packages/cli",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "versionId": {
          "description": "Import code components to version of",
          "name": "versionId",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hidden": true,
      "hiddenAliases": [],
      "id": "components-import",
      "pluginAlias": "@supernovaio/cli",
      "pluginName": "@supernovaio/cli",
      "pluginType": "core",
      "strict": true,
      "isESM": true,
      "relativePath": [
        "dist",
        "commands",
        "components-import.js"
      ]
    },
    "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",
      "strict": true,
      "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",
      "strict": true,
      "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",
      "strict": true,
      "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",
      "strict": true,
      "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",
      "strict": true,
      "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",
      "strict": true,
      "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"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "storybook-import",
      "pluginAlias": "@supernovaio/cli",
      "pluginName": "@supernovaio/cli",
      "pluginType": "core",
      "strict": true,
      "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",
      "strict": true,
      "isESM": true,
      "relativePath": [
        "dist",
        "commands",
        "sync-tokens.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",
      "strict": true,
      "isESM": true,
      "relativePath": [
        "dist",
        "commands",
        "whoami.js"
      ]
    }
  },
  "version": "2.0.3"
}