@percy/agent
A low-level Node process for interacting with Percy.
Usage
$ npm install -g @percy/agent
$ percy COMMAND
running command...
$ percy (-v|--version|version)
@percy/agent/0.4.6 linux-x64 node-v10.15.3
$ percy --help [COMMAND]
USAGE
$ percy COMMAND
...
Commands
percy exec
Start and stop Percy around a supplied command
USAGE
$ percy exec
OPTIONS
-p, --port=port [default: 5338] port
-t, --network-idle-timeout=network-idle-timeout [default: 50] asset discovery network idle timeout (in milliseconds)
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
percy finalize
finalize a build
USAGE
$ percy finalize
OPTIONS
-a, --all (required)
EXAMPLE
$ percy finalize --all
[percy] Finalized parallel build.
See code: dist/commands/finalize.ts
percy help [COMMAND]
display help for percy
USAGE
$ percy help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
percy snapshot SNAPSHOTDIRECTORY
Snapshot a directory containing a pre-built static website
USAGE
$ percy snapshot SNAPSHOTDIRECTORY
ARGUMENTS
SNAPSHOTDIRECTORY 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.
-i, --ignore-files=ignore-files 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: 50] 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