# @percy/cli-config

> Uses [`@percy/config`](/packages/config) to add CLI commands for creating, validating, and updating Percy configuration files.

Latest version **1.32.12** (published 2026-10-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @percy/cli-config
pnpm add @percy/cli-config
yarn add @percy/cli-config
bun add @percy/cli-config
```

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 1.32.12 |
| Published | 2026-10-21 |
| First published | 2020-07-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=14 |
| Dependencies | 1 |
| Unpacked size | 10 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 87 |
| Maintainers | percy-admin |

## Links

- npm: https://www.npmjs.com/package/@percy/cli-config
- Repository: https://github.com/percy/cli
- Homepage: https://github.com/percy/cli#readme
- Issues: https://github.com/percy/cli/issues
- npm.io page: https://npm.io/package/@percy/cli-config

## Dependencies (1)

- [@percy/cli-command](https://npm.io/package/@percy/cli-command.md) 1.32.12

## Recent versions

- 1.32.12 (latest) — 2026-10-21
- 1.32.12-beta.4 (beta) — 2026-10-21
- 1.31.15-alpha.0 (alpha) — 2026-05-21
- 1.32.12-beta.3 — 2026-10-16
- 1.32.12-beta.2 — 2026-10-09
- 1.32.12-beta.1 — 2026-10-06
- 1.32.12-beta.0 — 2026-10-01
- 1.32.11 — 2026-09-24
- 1.32.11-beta.2 — 2026-09-22
- 1.32.11-beta.1 — 2026-09-22
- 1.32.11-beta.0 — 2026-09-21
- 1.32.10 — 2026-09-17
- 1.32.10-beta.1 — 2026-09-11
- 1.32.10-beta.0 — 2026-09-08
- 1.32.9 — 2026-09-08
- … 392 more at https://npm.io/package/@percy/cli-config/versions

## README

# @percy/cli-config

Uses [`@percy/config`](/packages/config) to add CLI commands for creating, validating, and updating
Percy configuration files.

## Commands
<!-- commands -->
* [`percy config:create`](#percy-configcreate)
* [`percy config:validate`](#percy-configvalidate)
* [`percy config:migrate`](#percy-configmigrate)

### `percy config:create`

Create a Percy config file

```
Usage:
  $ percy config:create [options] [filepath]

Arguments:
  filepath               Optional config filepath

Options:
  --rc                   Create a .percyrc file
  --yaml                 Create a .percy.yaml file
  --yml                  Create a .percy.yml file
  --json                 Create a .percy.json file
  --js                   Create a .percy.js file

Global options:
  -v, --verbose          Log everything
  -q, --quiet            Log errors only
  -s, --silent           Log nothing
  -l, --labels <string>  Associates labels to the build (ex: --labels=dev,prod )
  -h, --help             Display command help

Examples:
  $ percy config:create
  $ percy config:create --yaml
  $ percy config:create --json
  $ percy config:create --js
  $ percy config:create --rc
  $ percy config:create ./config/percy.yml
```

### `percy config:validate`

Validate a Percy config file

```
Usage:
  $ percy config:validate [options] [filepath]

Arguments:
  filepath               Config filepath, detected by default

Global options:
  -v, --verbose          Log everything
  -q, --quiet            Log errors only
  -s, --silent           Log nothing
  -l, --labels <string>  Associates labels to the build (ex: --labels=dev,prod )
  -h, --help             Display command help

Examples:
  $ percy config:validate
  $ percy config:validate ./config/percy.yml
```

### `percy config:migrate`

Migrate a Percy config file to the latest version

```
Usage:
  $ percy config:migrate [options] [filepath] [output]

Arguments:
  filepath               Current config filepath, detected by default
  output                 New config filepath to write to, defaults to 'filepath'

Options:
  -d, --dry-run          Print the new config without writing it

Global options:
  -v, --verbose          Log everything
  -q, --quiet            Log errors only
  -s, --silent           Log nothing
  -l, --labels <string>  Associates labels to the build (ex: --labels=dev,prod )
  -h, --help             Display command help

Examples:
  $ percy config:migrate
  $ percy config:migrate --dry-run
  $ percy config:migrate ./config/percy.yml
  $ percy config:migrate .percy.yml .percy.js
```
<!-- commandsstop -->

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