@storybook/cli
Advanced tools
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.
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 initAdd 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 reactAddons 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-essentialsSimilar 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 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 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.
Storybook CLI (Command Line Interface) is the easiest way to add Storybook to your project.
Go to your project and run:
cd my-app
npx storybook@latest init
In addition to init, the CLI also has other commands:
add - add an addon and register itinfo - print out system information for bug reportsupgrade - upgrade to the latest version of Storybook (or a specific version)migrate - run codemods to migrate your codeSee the command-line help with -h (including other useful commands) for details.
This package has multiple sub-exports to can be used to gain access to storybook's APIs.
storybook/componentsThis export contains a list of components very useful for building out addons. We recommend addon-authors to use these components to ensure a consistent look and feel, and to reduce the amount of code they need to write.
storybook/themingThis export exposes a few utility functions to help writing components that automatically adapt to the current theme. Useful for addon authors who want to make their addons theme-aware.
storybook/preview-apiThis export contains the API that is available in the preview iframe.
storybook/manager-apiThis export contains the API that is available in the manager iframe.
storybook/typesThis export exposes a lot of TypeScript interfaces used throughout storybook, including for storybook configuration, addons etc.
8.6.0
The 8.6 release focuses on Storybook Test, which brings realtime component, accessibility, and visual UI tests to your favorite component workshop.
Here’s what’s new:
--yes and fix --features - #30534, thanks @ghengeveld!UniversalStore API to sync state/events between multiple environments - #30445, thanks @JReinhold!node_modules - #30643, thanks @ndelangen!addon-essentials not working when used with getAbsolutePath - #30557, thanks @JReinhold!+page.svelte files - #30369, thanks @xeho91!vitest.config.ts with workspaces, otherwise create vitest.workspace.ts - #30583, thanks @ghengeveld!FAQs
Storybook CLI
The npm package @storybook/cli receives a total of 1,629,836 weekly downloads. As such, @storybook/cli popularity was classified as popular.
We found that @storybook/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 12 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
FSF files an amicus brief against Neo4j, defending the AGPL and warning against adding restrictive terms that undermine free software rights.
Research
Security News
Malicious PyPI package ‘set-utils’ steals Ethereum private keys by exfiltrating them through blockchain transactions via the Polygon RPC.
Research
Security News
Malicious Go packages are impersonating popular libraries to install hidden loader malware on Linux and macOS, targeting developers with obfuscated payloads.