# @percy/cli-exec

> Percy CLI commands for running a local snapshot server using [`@percy/core`](./packages/core).

Latest version **1.32.11** (published 2026-09-24) · MIT license · 0 weekly downloads

## Install

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

## Health

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

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

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 1.32.11 |
| Published | 2026-09-24 |
| First published | 2020-07-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 88 |
| Maintainers | percy-admin |

## Links

- npm: https://www.npmjs.com/package/@percy/cli-exec
- 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-exec

## Recent versions

- 1.32.11 (latest) — 2026-09-24
- 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-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
- 1.32.9-beta.1 — 2026-09-08
- … 391 more at https://npm.io/package/@percy/cli-exec/versions

## README

# @percy/cli-exec

Percy CLI commands for running a local snapshot server using [`@percy/core`](./packages/core).

## Commands
<!-- commands -->
* [`percy exec`](#percy-exec)
* [`percy exec:start`](#percy-execstart)
* [`percy exec:stop`](#percy-execstop)
* [`percy exec:ping`](#percy-execping)

### `percy exec`

Start and stop Percy around a supplied command

```
Usage:
  $ percy exec [options] -- <command>

Subcommands:
  exec:start [options]               Starts a locally running Percy process
  exec:stop [options]                Stops a locally running Percy process
  exec:ping [options]                Pings a locally running Percy process
  help [command]                     Display command help

Options:
  --parallel                         Marks the build as one of many parallel builds
  --partial                          Marks the build as a partial build

Percy options:
  -c, --config <file>                Config file path
  -d, --dry-run                      Print snapshot names only
  -P, --port [number]                Local CLI server port (default: 5338)
  -h, --allowed-hostname <hostname>  Allowed hostnames to capture in asset discovery
  --disallowed-hostname <hostname>   Disallowed hostnames to abort in asset discovery
  -t, --network-idle-timeout <ms>    Asset discovery network idle timeout
  --disable-cache                    Disable asset discovery caches
  --debug                            Debug asset discovery and do not upload snapshots

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 )
  --help                             Display command help

Examples:
  $ percy exec -- echo "percy is running around this echo command"
  $ percy exec -- yarn test
```

### `percy exec:start`

Starts a locally running Percy process

```
Usage:
  $ percy exec:start [options]

Percy options:
  -c, --config <file>                Config file path
  -d, --dry-run                      Print snapshot names only
  -P, --port [number]                Local CLI server port (default: 5338)
  -h, --allowed-hostname <hostname>  Allowed hostnames to capture in asset discovery
  --disallowed-hostname <hostname>   Disallowed hostnames to abort in asset discovery
  -t, --network-idle-timeout <ms>    Asset discovery network idle timeout
  --disable-cache                    Disable asset discovery caches
  --debug                            Debug asset discovery and do not upload snapshots

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 )
  --help                             Display command help

Examples:
  $ percy exec:start &> percy.log
```

### `percy exec:stop`

Stops a locally running Percy process

```
Usage:
  $ percy exec:stop [options]

Percy options:
  -P, --port [number]    Local CLI server port (default: 5338)

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

### `percy exec:ping`

Pings a locally running Percy process

```
Usage:
  $ percy exec:ping [options]

Percy options:
  -P, --port [number]    Local CLI server port (default: 5338)

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
```
<!-- commandsstop -->

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