Wondering what’s next for npm?Check out our public roadmap! »

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

    6.2.9 • 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 -p @storybook/cli 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 yarn.lock file, 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

    Install

    npm i @storybook/cli

    DownloadsWeekly Downloads

    184,590

    Version

    6.2.9

    License

    MIT

    Unpacked Size

    485 kB

    Total Files

    409

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar