CLI 选项

Storybook 命令行接口 (CLI) 是你用来构建和开发 Storybook 的主要工具。

¥The Storybook command line interface (CLI) is the main tool you use to build and develop Storybook.

API 命令

¥API commands

通过运行 storybook --help，可以在 CLI 中获得以下所有文档。

¥All of the following documentation is available in the CLI by running storybook --help.

dev

编译并提供 Storybook 的开发版本，以实时反映浏览器中的源代码更改。它应该从项目的根目录运行。

¥Compiles and serves a development build of your Storybook that reflects your source code changes in the browser in real-time. It should be run from the root of your project.

storybook dev [options]

选项包括：

¥Options include:

build

编译你的 Storybook 实例，以便它可以是 deployed。它应该从项目的根目录运行。

¥Compiles your Storybook instance so it can be deployed. It should be run from the root of your project.

storybook build [options]

选项包括：

¥Options include:

init

在你的项目中安装并初始化指定版本（例如 @latest、@8、@next）的 Storybook。在 安装指南 中阅读更多内容。

¥Installs and initializes the specified version (e.g., @latest, @8, @next) of Storybook into your project. Read more in the installation guide.

storybook[@version] init [options]

例如，storybook@latest init 会将最新版本的 Storybook 安装到你的项目中。

¥For example, storybook@latest init will install the latest version of Storybook into your project.

选项包括：

¥Options include:

add

安装 Storybook 插件并为其配置你的项目。在 插件安装指南 中阅读更多内容。

¥Installs a Storybook addon and configures your project for it. Read more in the addon installation guide.

storybook add [addon] [options]

选项包括：

¥Options include:

remove

从项目中删除 Storybook 插件。在 插件安装指南 中阅读更多内容。

¥Deletes a Storybook addon from your project. Read more in the addon installation guide.

storybook remove [addon] [options]

选项包括：

¥Options include:

upgrade

将 Storybook 实例升级到指定版本（例如 @latest、@8、@next）。在 升级指南 中阅读更多内容。

¥Upgrades your Storybook instance to the specified version (e.g., @latest, @8, @next). Read more in the upgrade guide.

storybook[@version] upgrade [options]

例如，storybook@latest upgrade --dry-run 将执行一次试运行（无实际更改），将你的项目升级到最新版本的 Storybook。

¥For example, storybook@latest upgrade --dry-run will perform a dry run (no actual changes) of upgrading your project to the latest version of Storybook.

选项包括：

¥Options include:

migrate

运行提供的 codemod 以确保你的 Storybook 项目与指定版本兼容。在 迁移指南 中阅读更多内容。

¥Runs the provided codemod to ensure your Storybook project is compatible with the specified version. Read more in the migration guide.

storybook[@version] migrate [codemod] [options]

例如，storybook@latest migrate csf-2-to-3 --dry-run 检查你的项目以验证是否可以在不进行任何更改的情况下应用 codemod，并为你提供哪些文件会受到影响的报告。

¥For example, storybook@latest migrate csf-2-to-3 --dry-run, checks your project to verify if the codemod can be applied without making any changes, providing you with a report of which files would be affected.

选项包括：

¥Options include:

automigrate

执行标准配置检查以确定你的 Storybook 项目是否可以自动迁移到指定版本。在 迁移指南 中阅读更多内容。

¥Perform standard configuration checks to determine if your Storybook project can be automatically migrated to the specified version. Read more in the migration guide.

storybook[@version] automigrate [fixId] [options]

例如，storybook@latest automigrate --dry-run 会扫描你的项目以查找可以自动应用的潜在迁移而无需进行任何更改。

¥For example, storybook@latest automigrate --dry-run scans your project for potential migrations that can be applied automatically without making any changes.

选项包括：

¥Options include:

doctor

对你的 Storybook 项目执行健康检查以查找常见问题（例如，重复的依赖、不兼容的插件或不匹配的版本）并提供有关如何修复它们的建议。适用于 upgrading Storybook 版本。

¥Performs a health check on your Storybook project for common issues (e.g., duplicate dependencies, incompatible addons or mismatched versions) and provides suggestions on how to fix them. Applicable when upgrading Storybook versions.

storybook doctor [options]

选项包括：

¥Options include:

info

报告有关你的环境的有用调试信息。有助于在打开问题或讨论时提供信息。

¥Reports useful debugging information about your environment. Helpful in providing information when opening an issue or a discussion.

storybook info

示例输出：

¥Example output:

Storybook Environment Info:
 
  System:
    OS: macOS 14.2
    CPU: (8) arm64 Apple M3
    Shell: 5.9 - /bin/zsh
  Binaries:
    Node: 18.19.0 - ~/.nvm/versions/node/v18.19.0/bin/node
    npm: 10.2.3 - ~/.nvm/versions/node/v18.19.0/bin/npm <----- active
  Browsers:
    Chrome: 120.0.6099.199
  npmPackages:
    @storybook/addon-essentials: ^7.6.6 => 7.6.6
    @storybook/addon-interactions: ^7.6.6 => 7.6.6
    @storybook/addon-links: ^7.6.6 => 7.6.6
    @storybook/addon-onboarding: ^1.0.10 => 1.0.10
    @storybook/blocks: ^7.6.6 => 7.6.6
    @storybook/preset-create-react-app: ^7.6.6 => 7.6.6
    @storybook/react: ^7.6.6 => 7.6.6
    @storybook/react-webpack5: ^7.6.6 => 7.6.6
    @storybook/test: ^7.6.6 => 7.6.6
    storybook: ^7.6.6 => 7.6.6
  npmGlobalPackages:
    chromatic: ^10.2.0 => 10.2.0

sandbox

使用指定版本（例如 @latest、@8、@next）生成本地沙盒项目，以根据支持的 frameworks 列表测试 Storybook 功能。适用于打开问题或讨论时重现错误。

¥Generates a local sandbox project using the specified version (e.g., @latest, @8, @next) for testing Storybook features based on the list of supported frameworks. Useful for reproducing bugs when opening an issue or a discussion.

storybook[@version] sandbox [framework-filter] [options]

例如，storybook@next sandbox 将使用最新的预发布版本的 Storybook 生成沙箱。

¥For example, storybook@next sandbox will generated sandboxes using the newest pre-release version of Storybook.

framework-filter 参数是可选的，可以过滤可用框架列表。例如，storybook@next sandbox react 只会提供基于 React 的沙箱生成。

¥The framework-filter argument is optional and can filter the list of available frameworks. For example, storybook@next sandbox react will only offer to generate React-based sandboxes.

选项包括：

¥Options include: