CLI options
Storybook comes with two CLI utilities: start-storybook
and build-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.
Pass these commands the following options to alter Storybook's behavior.
start-storybook
Options | Description |
---|---|
--help | Output usage information start-storybook --help |
-V , --version | Output the version number start-storybook -V |
-p , --port [number] | Port to run Storybook start-storybook -p 9009 |
-h , --host [string] | Host to run Storybook start-storybook -h my-host.com |
-s , --static-dir | Deprecated see note. Directory where to load static files from, comma-separated liststart-storybook -s public |
-c , --config-dir [dir-name] | Directory where to load Storybook configurations from start-storybook -c .storybook |
--https | Serve Storybook over HTTPS. Note: You must provide your own certificate informationstart-storybook --https |
--ssl-ca | Provide an SSL certificate authority. (Optional with --https, required if using a self-signed certificate)start-storybook --ssl-ca my-certificate |
--ssl-cert | Provide an SSL certificate. (Required with --https)start-storybook --ssl-cert my-ssl-certificate |
--ssl-key | Provide an SSL key. (Required with --https)start-storybook --ssl-key my-ssl-key |
--smoke-test | Exit after successful startstart-storybook --smoke-test |
--ci | CI mode (skip interactive prompts, don't open browser)start-storybook --ci |
--no-open | Do not open Storybook automatically in the browserstart-storybook --no-open |
--quiet | Suppress verbose build outputstart-storybook --quiet |
--no-dll | Do not use dll reference (no-op)start-storybook --no-dll |
--debug-webpack | Display final webpack configurations for debugging purposesstart-storybook --debug-webpack |
--webpack-stats-json | Write Webpack Stats JSON to diskstart-storybook --webpack-stats-json /tmp/webpack-stats |
--docs | Starts Storybook in documentation mode. Learn more about it in herestart-storybook --docs |
--no-manager-cache | Disables Storybook's manager caching mechanism. See note belowstart-storybook --no-manager-cache |
--disable-telemetry | Disables Storybook's telemetry. Learn more about it herestart-storybook --disable-telemetry |
The flag --no-manager-cache
disables the internal caching of Storybook and can severely impact your Storybook loading time, so only use it when you need to refresh Storybook's UI, such as when editing themes.
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-storybook
Options | Description |
---|---|
-h , --help | Output usage informationbuild-storybook --help |
-V , --version | Output the version numberbuild-storybook -V |
-s , --static-dir | Deprecated see note. Directory where to load static files from, comma-separated list build-storybook -s public |
-o , --output-dir [dir-name] | Directory where to store built filesbuild-storybook -o /my-deployed-storybook |
-c , --config-dir [dir-name] | Directory where to load Storybook configurations frombuild-storybook -c .storybook |
--loglevel [level] | Controls level of logging during build. Available options: silly , verbose , info (default), warn , error , silent build-storybook --loglevel warn |
--quiet | Suppress verbose build outputbuild-storybook --quiet |
--no-dll | Do not use dll reference (no-op)build-storybook --no-dll |
--debug-webpack | Display final webpack configurations for debugging purposesbuild-storybook --debug-webpack |
--webpack-stats-json | Write Webpack Stats JSON to diskbuild-storybook --webpack-stats-json /my-storybook/webpack-stats |
--docs | Builds Storybook in documentation mode. Learn more about it in herebuild-storybook --docs |
--disable-telemetry | Disables Storybook's telemetry. Learn more about it here.build-storybook --disable-telemetry |
If you're using npm instead of yarn to publish Storybook, the commands work slightly different. For example, npm run build-storybook -- -o ./path/to/build
.