Find file History
Pull request Compare This branch is 75 commits ahead, 1203 commits behind next.
Latest commit 2dd7af6 Jan 17, 2019

README.md

Storybook CLI

Storybook CLI (Command Line Interface) is the easiest way to add Storybook to your project.

In the future it will also add other useful generators and migration tooling.

Screenshot

Just go to your project and run:

cd my-app
npx -p @storybook/cli sb init

That's all you've to do.


Yarn support

The CLI supports yarn. If you have installed yarn in your system, it'll detect it and use yarn instead of npm.

If you don't want to use yarn always you can use the --use-npm option like this:

npx -p @storybook/cli sb init --use-npm

Flow support

It also supports flow files. By default, jscodeshift, the tool used to transform the source files, uses babel to read the files. To be able to transform any flow annotated file, you need to use the flow parser.

npx -p @storybook/cli sb init --parser flow

For more information visit: storybook.js.org


Manually specify project type

If the CLI cannot detect your project type, it will ask you. You can also force it to use a particular project type:

npx -p @storybook/cli sb init --type <type>

Where type is one of the project types defined in project_types.js