https://github.com/chromaui/chromatic-cli

Chromatic CLI: `npx chromatic`
https://github.com/chromaui/chromatic-cli

cli storybook

Last synced: 6 days ago
JSON representation

Chromatic CLI: `npx chromatic`

• Host: GitHub
• URL: https://github.com/chromaui/chromatic-cli
• Owner: chromaui
• License: mit
• Created: 2019-08-13T08:23:34.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-01-14T21:16:45.000Z (7 days ago)
• Last Synced: 2025-01-15T03:56:52.515Z (7 days ago)
• Topics: cli, storybook
• Language: TypeScript
• Homepage: https://www.chromatic.com/docs/cli
• Size: 42 MB
• Stars: 289
• Watchers: 15
• Forks: 72
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: SECURITY.md
  • Support: SUPPORT.md

Awesome Lists containing this project

README

        
# Chromatic CLI

Publishes your Storybook to Chromatic and kicks off tests if they're enabled.





  





  



## Documentation

👉 Read the [Chromatic CLI docs](https://www.chromatic.com/docs/cli)

📝 View the [Changelog](https://github.com/chromaui/chromatic-cli/blob/main/CHANGELOG.md)

## System requirements

The Chromatic CLI (and GitHub Action) is built to run in a variety of environments. We provide support for the following platforms:

- Latest (LTS) versions of Ubuntu, Windows (Server), macOS

- Node.js Current, Active or Maintenance (LTS) versions, according to their [release schedule](https://github.com/nodejs/release#release-schedule)

- Storybook 6.5+

Other platforms/versions may work, but are not officially supported. Certain features may not be available on certain platforms/versions, even if otherwise supported.

## Contributing

Contributions of any kind are welcome! If you're a maintainer, refer to the following [instructions](./docs/DEVELOPMENT.md) to set up your development environment with Chromatic.

### Compatibility & versioning

Compatibility is guaranteed between this package and Chromatic like so:

- Production Chromatic ensures it’s compatible with what’s on npm

- What's on the Git tag is equal to what's published on npm for that version

- This package ensures it’s compatible with production Chromatic

To facilitate upgrading in the future, removing and adding features, this is the process:

- Any new features will have to be on Chromatic production before they could be used in this package

- We can add feature flags to be able to test new functionality

- Chromatic production can not remove any features this package depends on until after the usage has been removed from this package in addition to a grace period to allow users to upgrade