@percy/agent

A low-level Node process for interacting with Percy.

• Usage
• Commands

Usage

$ npm install -g chattermill-percy
$ chattermill-percy COMMAND
running command...
$ chattermill-percy (-v|--version|version)
chattermill-percy/0.27.9 darwin-x64 node-v12.16.3
$ chattermill-percy --help [COMMAND]
USAGE
  $ chattermill-percy COMMAND
...

Commands

• chattermill-percy exec
• chattermill-percy finalize
• chattermill-percy help [COMMAND]
• chattermill-percy snapshot [SNAPSHOTDIRECTORY]
• chattermill-percy start
• chattermill-percy stop
• chattermill-percy upload [UPLOADDIRECTORY]

chattermill-percy exec

Start and stop Percy around a supplied command.

USAGE
  $ chattermill-percy exec

OPTIONS
  -c, --config=config                              Path to percy config file
  -h, --allowed-hostname=allowed-hostname          Allowable hostname(s) to capture assets from
  -p, --port=port                                  [default: 5338] Port
  -t, --network-idle-timeout=network-idle-timeout  [default: 125] Asset discovery network idle timeout (in milliseconds)

  --cache-responses                                [default: true] Caches successful network responses in asset
                                                   discovery

EXAMPLES
  $ percy exec -- echo "percy is running around this echo command"
  $ percy exec -- bash -c "echo foo && echo bar"

See code: dist/commands/exec.ts

chattermill-percy finalize

Finalize a build. Commonly used for parallelized builds, especially when the number of parallelized processes is unknown.

USAGE
  $ chattermill-percy finalize

OPTIONS
  -a, --all  (required)

EXAMPLE
  $ percy finalize --all
  [percy] Finalized parallel build.

See code: dist/commands/finalize.ts

chattermill-percy help [COMMAND]

display help for chattermill-percy

USAGE
  $ chattermill-percy help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

chattermill-percy snapshot [SNAPSHOTDIRECTORY]

Snapshot a directory containing a pre-built static website.

USAGE
  $ chattermill-percy snapshot [SNAPSHOTDIRECTORY]

ARGUMENTS
  SNAPSHOTDIRECTORY  [default: .] A path to the directory you would like to snapshot

OPTIONS
  -b, --base-url=base-url                          [default: /] If your static files will be hosted in a subdirectory,
                                                   instead of the webserver's root path, set that subdirectory with this
                                                   flag.

  -c, --config=config                              Path to percy config file

  -d, --dry-run                                    Print the list of paths to snapshot without creating a new build

  -h, --allowed-hostname=allowed-hostname          Allowable hostname(s) to capture assets from

  -i, --ignore-files=ignore-files                  [default: ] Glob or comma-seperated string of globs for matching the
                                                   files and directories to ignore.

  -p, --port=port                                  [default: 5338] Port

  -s, --snapshot-files=snapshot-files              [default: **/*.html,**/*.htm] Glob or comma-seperated string of globs
                                                   for matching the files and directories to snapshot.

  -t, --network-idle-timeout=network-idle-timeout  [default: 125] Asset discovery network idle timeout (in milliseconds)

EXAMPLES
  $ percy snapshot _site/
  $ percy snapshot _site/ --base-url "/blog/"
  $ percy snapshot _site/ --ignore-files "/blog/drafts/**"

See code: dist/commands/snapshot.ts

chattermill-percy start

Starts the percy process.

USAGE
  $ chattermill-percy start

OPTIONS
  -c, --config=config                              Path to percy config file
  -d, --detached                                   start as a detached process
  -h, --allowed-hostname=allowed-hostname          Allowable hostname(s) to capture assets from
  -p, --port=port                                  [default: 5338] Port
  -t, --network-idle-timeout=network-idle-timeout  [default: 125] Asset discovery network idle timeout (in milliseconds)

EXAMPLE
  $ percy start
  info: percy has started on port 5338.

See code: dist/commands/start.ts

chattermill-percy stop

Stops the percy process.

USAGE
  $ chattermill-percy stop

OPTIONS
  -p, --port=port  [default: 5338] Port

EXAMPLE
  $ percy stop
  info: percy has stopped.

See code: dist/commands/stop.ts

chattermill-percy upload [UPLOADDIRECTORY]

Upload a directory containing static snapshot images.

USAGE
  $ chattermill-percy upload [UPLOADDIRECTORY]

ARGUMENTS
  UPLOADDIRECTORY  [default: .] A path to the directory containing static snapshot images

OPTIONS
  -c, --config=config  Path to percy config file
  -d, --dry-run        Print the list of images to upload without uploading them

  -f, --files=files    [default: **/*.png,**/*.jpg,**/*.jpeg] Glob or comma-seperated string of globs for matching the
                       files and directories to snapshot.

  -i, --ignore=ignore  [default: ] Glob or comma-seperated string of globs for matching the files and directories to
                       ignore.

EXAMPLES
  $ percy upload _images/
  $ percy upload _images/ --files **/*.png

See code: dist/commands/upload.ts