Skip to content

chromaui/chromatic-cli

Folders and files

NameName
Last commit message
Last commit date
Feb 28, 2025
May 31, 2024
Aug 28, 2019
Jun 11, 2024
Jan 8, 2025
Mar 3, 2025
Oct 30, 2024
Mar 5, 2025
Dec 6, 2024
Nov 14, 2019
Oct 3, 2024
Oct 1, 2024
Oct 21, 2024
Dec 14, 2022
Jun 11, 2024
Jun 11, 2024
Mar 3, 2025
Oct 9, 2019
Oct 30, 2024
Aug 19, 2022
Mar 12, 2024
Feb 12, 2025
Oct 21, 2024
Oct 21, 2021
Sep 30, 2024
Sep 30, 2024
Sep 21, 2023
Mar 3, 2025
Oct 27, 2020
Jul 16, 2020
Aug 28, 2019
Mar 3, 2025
Oct 8, 2024
Mar 3, 2025
Sep 11, 2024
Mar 3, 2025

Repository files navigation

Chromatic CLI

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

Published on npm Tested with Chromatic

Documentation

👉 Read the Chromatic CLI docs

📝 View the Changelog

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
  • 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 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