@storybook/cli
TypeScript icon, indicating that this package has built-in type declarations

8.1.10 • Public • Published

Storybook CLI

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

Screenshot

Go to your project and run:

cd my-app
npx sb init

In addition to init, the CLI also has other commands:

  • add - add an addon and register it
  • info - print out system information for bug reports
  • migrate - run codemods to migrate your code

See the command-line help with -h for details.


Yarn support

The CLI supports yarn. If you have installed yarn in your system and your project has a yarn.lock file, it'll detect it and use yarn to install dependencies.

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

npx sb init --package-manager=npm

If you would like to force a particular version of yarn, you can use the --package-manager flag with a value of yarn1 or yarn2.


PNPM support

The CLI supports pnpm. If you have installed pnpm in your system and your project has a pnpm-lock.yaml file, it'll detect it and use pnpm to install dependencies.

If you don't have a lock file and would like to force pnpm to be used, you can use the --package-manager option like this:

npx sb init --package-manager=pnpm

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 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 sb init --type <type>

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

Package Sidebar

Install

npm i @storybook/cli

Weekly Downloads

3,724,170

Version

8.1.10

License

MIT

Unpacked Size

1.53 MB

Total Files

46

Last publish

Collaborators

  • domyen
  • kasperpeulen
  • valentinpalkovic
  • jreinhold
  • kylegach
  • ndelangen
  • shilman
  • tmeasday
  • ghengeveld
  • winkervsbecks
  • yannbf