node package manager
Love JavaScript? Your insights can make it even better. Take the 2017 JavaScript Ecosystem Survey »

@storybook/cli

Storybook CLI

Build Status on CircleCI CodeFactor Known Vulnerabilities BCH compliance codecov
Storybook Slack Backers on Open Collective Sponsors on Open Collective


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

First install the storybook CLI globally.

npm i -g @storybook/cli

Then go to your project run:

getstorybook

That's all you've to do.


Yarn support

It also 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:

getstorybook --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.

getstorybook --parser flow

For more information visit: storybook.js.org