# chromatic

> Automate visual testing across browsers. Gather UI feedback. Versioned documentation.

Latest version **18.8.1** (published 2026-09-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install chromatic
pnpm add chromatic
yarn add chromatic
bun add chromatic
```

Provides the commands `chroma`, `chromatic`, `chromatic-cli`.

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 18.8.1 |
| Published | 2026-09-11 |
| First published | 2015-07-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=22.0.0 |
| Dependencies | 1 |
| Unpacked size | 7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 337 |
| Author | Chromatic |
| Maintainers | codykaup, tmeasday, shilman, ndelangen, ghengeveld, jmhobbs, thafryer, chromatic-ci-bot, andrewortwein, tevanoff |
| Keywords | storybook-addon, storybook, addon, test, popular |

## Links

- npm: https://www.npmjs.com/package/chromatic
- Repository: https://github.com/chromaui/chromatic-cli
- Homepage: https://www.chromatic.com
- Issues: https://github.com/chromaui/chromatic-cli
- npm.io page: https://npm.io/package/chromatic

## Dependencies (1)

- [semver](https://npm.io/package/semver.md) ^7.3.5

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 18.8.1 (latest) — 2026-09-11
- 18.8.2--canary.1485.34614153841.0 (canary) — 2026-09-11
- 18.8.2--canary.1484.34614158315.0 — 2026-09-11
- 18.8.1--canary.1481.34535106864.0 — 2026-09-10
- 18.8.1--canary.1485.34532187444.1 — 2026-09-10
- 18.8.1--canary.1485.34532187444.0 — 2026-09-10
- 18.8.1--canary.1485.34532186873.0 — 2026-09-10
- 18.8.1--canary.1485.34532187124.0 — 2026-09-10
- 18.8.1--canary.1485.34532187310.0 — 2026-09-10
- 18.8.1--canary.1485.34532186977.0 — 2026-09-10
- 18.8.1--canary.1484.34527942134.0 — 2026-09-10
- 18.8.1--canary.1484.34526052754.0 — 2026-09-10
- 18.8.1--canary.1484.34526052616.0 — 2026-09-10
- 18.8.1--canary.1484.34526047374.0 — 2026-09-10
- 18.9.0--canary.1478.34497647280.0 — 2026-09-10
- … 3506 more at https://npm.io/package/chromatic/versions

## README

# Chromatic CLI

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

<img width="100%" src="https://user-images.githubusercontent.com/321738/82901859-d820ec80-9f5e-11ea-81e7-78d494c103ad.gif" alt="">

<a href="https://www.npmjs.com/package/chromatic">
  <img src="https://badgen.net/npm/v/chromatic" alt="Published on npm">
</a>
<a href="https://www.chromatic.com/builds?appId=5d67dc0374b2e300209c41e7">
  <img src="https://badgen.net/badge/tested%20with/chromatic/fc521f" alt="Tested with Chromatic">
</a>

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

---
_Source: https://npm.io/package/chromatic · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
