New
You're viewing older docs for version 8.0. View latest docs

CLI options

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

Storybook collects completely anonymous data to help us improve user experience. Participation is optional, and you may opt-out if you'd not like to share any information.

API commands

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

Passing options to these commands works slightly differently if you're using npm instead of Yarn. You must prefix all of your options with --. For example, npm run storybook build -- -o ./path/to/build --quiet.

dev

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.

Terminal
Loading...

Options include:

OptionDescription
--helpOutput usage information
storybook dev --help
-V, --versionOutput the version number
storybook dev -V
-p, --port [number]Port to run Storybook
storybook dev -p 9009
-h, --host [string]Host to run Storybook
storybook dev -h my-host.com
-c, --config-dir [dir-name]Directory where to load Storybook configurations from
storybook dev -c .storybook
--httpsServe Storybook over HTTPS. Note: You must provide your own certificate information
storybook dev --https
--ssl-caProvide an SSL certificate authority. (Optional with --https, required if using a self-signed certificate)
storybook dev --ssl-ca my-certificate
--ssl-certProvide an SSL certificate. (Required with --https)
storybook dev --ssl-cert my-ssl-certificate
--ssl-keyProvide an SSL key. (Required with --https)
storybook dev --ssl-key my-ssl-key
--smoke-testExit after successful start
storybook dev --smoke-test
--ciCI mode (skip interactive prompts, don't open browser)
storybook dev --ci
--no-openDo not open Storybook automatically in the browser
storybook dev --no-open
--quietSuppress verbose build output
storybook dev --quiet
--debug-webpackDisplay final webpack configurations for debugging purposes
storybook dev --debug-webpack
--stats-jsonWrite stats JSON to disk
storybook dev ---stats-json /tmp/stats
NOTE: only works for webpack.
--docsStarts Storybook in documentation mode. Learn more about it in here
storybook dev --docs
--disable-telemetryDisables Storybook's telemetry. Learn more about it here
storybook dev --disable-telemetry

With the release of Storybook 8, the -s CLI flag was removed. We recommend using the static directory instead if you need to serve static files.

build

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

Terminal
Loading...

Options include:

OptionDescription
-h, --helpOutput usage information
storybook build --help
-V, --versionOutput the version number
storybook build -V
-o, --output-dir [dir-name]Directory where to store built files
storybook build -o /my-deployed-storybook
-c, --config-dir [dir-name]Directory where to load Storybook configurations from
storybook build -c .storybook
--loglevel [level]Controls level of logging during build.
Available options: silly, verbose, info (default), warn, error, silent
storybook build --loglevel warn
--quietSuppress verbose build output
storybook build --quiet
--debug-webpackDisplay final webpack configurations for debugging purposes
storybook build --debug-webpack
---stats-jsonWrite stats JSON to disk
storybook build -stats-json /my-storybook/-stats
--docsBuilds Storybook in documentation mode. Learn more about it in here
storybook build --docs
--disable-telemetryDisables Storybook's telemetry. Learn more about it here.
storybook build --disable-telemetry
--testOptimize Storybook's production build for performance and tests by removing unnecessary features with the test option. Learn more here.
storybook build --test

init

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

Terminal
Loading...

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

Options include:

OptionDescription
-b, --builderDefines the builder to use for your Storybook instance
storybook@latest init --builder webpack5
-f,--forceForcefully installs Storybook into your project, prompting you to overwrite existing files
storybook@latest init --force
-s, --skip-installSkips the dependency installation step. Used only when you need to configure Storybook manually
storybook@latest init --skip-install
-t, --typeDefines the framework to use for your Storybook instance
storybook@latest init --type solid
-y, --yesSkips interactive prompts and automatically installs Storybook per specified version
storybook@latest init --yes
--package-managerSets the package manager to use when installing the addon.
Available package managers include npm, yarn, and pnpm
storybook@latest init --package-manager pnpm
--use-pnpEnables Plug'n'Play support for Yarn. This option is only available when using Yarn as your package manager
storybook@latest init --use-pnp

add

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

Terminal
Loading...

Options include:

OptionDescription
--package-managerSets the package manager to use when installing the addon.
Available package managers include npm, yarn, and pnpm
storybook@latest add [addon] --package-manager pnpm
-s, --skip-postinstallSkips post-install configuration. Used only when you need to configure the addon yourself
storybook@latest add [addon] --skip-postinstall

remove

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

Terminal
Loading...

Options include:

OptionDescription
--package-managerSets the package manager to use when removing the addon.
Available package managers include npm, yarn, and pnpm
storybook@latest remove [addon]--package-manager pnpm

upgrade

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

Terminal
Loading...

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:

OptionDescription
-c, --config-dirDirectory where to load Storybook configurations from
storybook@latest upgrade --config-dir .storybook
-n, --dry-runChecks for version upgrades without installing them
storybook@latest upgrade --dry-run
-s, --skip-checkSkips the migration check step during the upgrade process
storybook@latest upgrade --skip-check
-y, --yesSkips interactive prompts and automatically upgrades Storybook to the latest version
storybook@latest upgrade --yes
--package-managerSets the package manager to use when installing the addon.
Available package managers include npm, yarn, and pnpm
storybook@latest upgrade --package-manager pnpm

doctor

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.

Terminal
Loading...

Options include:

OptionDescription
-c, --config-dirDirectory where to load Storybook configurations from
storybook doctor --config-dir .storybook
--package-managerSets the package manager to use when running the health check.
Available package managers include npm, yarn, and pnpm
storybook doctor --package-manager pnpm

info

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

Terminal
Loading...

Example output:

Terminal
Loading...

sandbox

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.

Terminal
Loading...

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

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:

OptionDescription
-o, --output [dir-name]Configures the location of the sandbox project
storybook sandbox --output /my-sandbox-project
--no-initGenerates a sandbox project without without initializing Storybook
storybook sandbox --no-init

If you're looking for a hosted version of the available sandboxes, see storybook.new.

Was this page helpful?

Markdown accepted ([link text](url), _italic_, **bold**, etc). Your anonymous feedback will be posted publicly on GitHub.

✍️ Edit on GitHub – PRs welcome!
Storybook
Join the community
6,616 developers and counting
WhyWhy StorybookComponent-driven UI
DocsGuidesTutorialsChangelogTelemetryStatus
CommunityAddonsGet involvedBlog
ShowcaseExploreProjectsComponent glossary
Open source software
Storybook

Maintained by
Chromatic
Special thanks to Netlify and CircleCI