@storybook/cli

What is @storybook/cli?

The @storybook/cli package, also known as Storybook CLI, is a command-line tool that helps developers to quickly set up and configure Storybook in their project. Storybook is an open-source tool for developing UI components in isolation for React, Vue, Angular, and many other frameworks. The CLI automates many of the initial setup and configuration processes, making it easier to integrate Storybook into a project.

What are @storybook/cli's main functionalities?

Initialize Storybook

This command sets up Storybook in your project by detecting the project type (e.g., React, Vue, Angular) and installing the necessary dependencies and adding default configurations and examples.

npx -p @storybook/cli sb init

Add Storybook support for a specific type of project

This command explicitly sets up Storybook for a React project. You can replace 'react' with 'vue', 'angular', etc., depending on the project type you are working on.

npx -p @storybook/cli sb init --type react

Addons installation

This command helps in adding specific Storybook addons to enhance its functionality, such as '@storybook/addon-essentials' which includes a set of essential addons.

npx -p @storybook/cli sb add @storybook/addon-essentials

Other packages similar to @storybook/cli

react-scripts

Similar to @storybook/cli, react-scripts is used in the setup and configuration of React applications created with Create React App. It abstracts complex configurations for Babel, Webpack, and other tools. However, it does not specifically focus on component development environments like Storybook.

angular-cli

Angular CLI is a command-line interface tool that is used to initialize, develop, scaffold, and maintain Angular applications directly. It provides a similar ease of setup for Angular projects as @storybook/cli does for setting up Storybook in Angular projects.

vue-cli

Vue CLI is a full system for rapid Vue.js development, similar to Angular CLI for Angular. It provides project scaffolding, development tools, and build optimizations. It is similar to @storybook/cli in that it helps in setting up a development environment but is focused on Vue.js applications rather than component libraries.

README

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.

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