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. Should be run from the root of your project.
Options include:
Option | Description |
---|---|
--help | Output usage information storybook dev --help |
-V , --version | Output 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 |
-s , --static-dir | Deprecated see note. Directory where to load static files from, comma-separated liststorybook dev -s public |
-c , --config-dir [dir-name] | Directory where to load Storybook configurations from storybook dev -c .storybook |
--https | Serve Storybook over HTTPS. Note: You must provide your own certificate informationstorybook dev --https |
--ssl-ca | Provide an SSL certificate authority. (Optional with --https, required if using a self-signed certificate)storybook dev --ssl-ca my-certificate |
--ssl-cert | Provide an SSL certificate. (Required with --https)storybook dev --ssl-cert my-ssl-certificate |
--ssl-key | Provide an SSL key. (Required with --https)storybook dev --ssl-key my-ssl-key |
--smoke-test | Exit after successful startstorybook dev --smoke-test |
--ci | CI mode (skip interactive prompts, don't open browser)storybook dev --ci |
--no-open | Do not open Storybook automatically in the browserstorybook dev --no-open |
--quiet | Suppress verbose build outputstorybook dev --quiet |
--debug-webpack | Display final webpack configurations for debugging purposesstorybook dev --debug-webpack |
--webpack-stats-json | Write Webpack Stats JSON to diskstorybook dev --webpack-stats-json /tmp/webpack-stats |
--docs | Starts Storybook in documentation mode. Learn more about it in herestorybook dev --docs |
--disable-telemetry | Disables Storybook's telemetry. Learn more about it herestorybook dev --disable-telemetry |
Starting in 6.4 the -s
flag is deprecated. Instead, use a configuration object in your .storybook/main.js
file. See the images and assets documentation for more information.
build
Compiles your Storybook instance so it can be deployed. Should be run from the root of your project.
Options include:
Option | Description |
---|---|
-h , --help | Output usage informationstorybook build --help |
-V , --version | Output the version numberstorybook build -V |
-s , --static-dir | Deprecated see note. Directory where to load static files from, comma-separated list storybook build -s public |
-o , --output-dir [dir-name] | Directory where to store built filesstorybook build -o /my-deployed-storybook |
-c , --config-dir [dir-name] | Directory where to load Storybook configurations fromstorybook build -c .storybook |
--loglevel [level] | Controls level of logging during build. Available options: silly , verbose , info (default), warn , error , silent storybook build --loglevel warn |
--quiet | Suppress verbose build outputstorybook build --quiet |
--debug-webpack | Display final webpack configurations for debugging purposesstorybook build --debug-webpack |
--webpack-stats-json | Write Webpack Stats JSON to diskstorybook build --webpack-stats-json /my-storybook/webpack-stats |
--docs | Builds Storybook in documentation mode. Learn more about it in herestorybook build --docs |
--disable-telemetry | Disables Storybook's telemetry. Learn more about it here.storybook build --disable-telemetry |
--test | Optimize 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.
For example, storybook@latest init
will install the latest version of Storybook into your project.
Options include:
Option | Description |
---|---|
-b , --builder | Defines the builder to use for your Storybook instancestorybook@latest init --builder webpack5 |
-f ,--force | Forcefully installs Storybook into your project, prompting you to overwrite existing filesstorybook@latest init --force |
-s , --skip-install | Skips the dependency installation step. Used only when you need to configure Storybook manuallystorybook@latest init --skip-install |
-t , --type | Defines the framework to use for your Storybook instancestorybook@latest init --type solid |
-y , --yes | Skips interactive prompts and automatically installs Storybook per specified versionstorybook@latest init --yes |
--package-manager | Sets the package manager to use when installing the addon. Available package managers include npm , yarn , and pnpm storybook@latest init --package-manager pnpm |
--use-pnp | Enables Plug'n'Play support for Yarn. This option is only available when using Yarn as your package managerstorybook@latest init --use-pnp |
add
Installs a Storybook addon and configures your project for it. Read more in the addon installation guide.
Options include:
Option | Description |
---|---|
--package-manager | Sets 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-postinstall | Skips post-install configuration. Used only when you need to configure the addon yourselfstorybook@latest add [addon] --skip-postinstall |
remove
Deletes a Storybook addon from your project. Read more in the addon installation guide.
Options include:
Option | Description |
---|---|
--package-manager | Sets the package manager to use when removing the addon. Available package managers include npm , yarn , and pnpm storybook 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.
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:
Option | Description |
---|---|
-c , --config-dir | Directory where to load Storybook configurations fromstorybook@latest upgrade --config-dir .storybook |
-n , --dry-run | Checks for version upgrades without installing themstorybook@latest upgrade --dry-run |
-s , --skip-check | Skips the migration check step during the upgrade processstorybook@latest upgrade --skip-check |
-y , --yes | Skips interactive prompts and automatically upgrades Storybook to the latest versionstorybook@latest upgrade --yes |
--package-manager | Sets 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.
Options include:
Option | Description |
---|---|
-c , --config-dir | Directory where to load Storybook configurations fromstorybook doctor --config-dir .storybook |
--package-manager | Sets 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.
Example output:
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.
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:
Option | Description |
---|---|
-o , --output [dir-name] | Configures the location of the sandbox projectstorybook sandbox --output /my-sandbox-project |
--no-init | Generates a sandbox project without without initializing Storybookstorybook sandbox --no-init |
If you're looking for a hosted version of the available sandboxes, see storybook.new.