UNPKG

2.45 kBMarkdownView Raw
1@percy/agent
2============
3
4A low-level Node process for interacting with Percy.
5
6[![Version](https://img.shields.io/npm/v/@percy/agent.svg)](https://npmjs.org/package/@percy/agent)
7[![CircleCI](https://circleci.com/gh/percy/percy-agent/tree/master.svg?style=shield)](https://circleci.com/gh/percy/percy-agent/tree/master)
8[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/percy/percy-agent?branch=master&svg=true)](https://ci.appveyor.com/project/percy/percy-agent/branch/master)
9[![Codecov](https://codecov.io/gh/percy/percy-agent/branch/master/graph/badge.svg)](https://codecov.io/gh/percy/percy-agent)
10[![Downloads/week](https://img.shields.io/npm/dw/@percy/agent.svg)](https://npmjs.org/package/@percy/agent)
11[![License](https://img.shields.io/npm/l/@percy/agent.svg)](https://github.com/percy/percy-agent/blob/master/package.json)
12
13<!-- toc -->
14* [Usage](#usage)
15* [Commands](#commands)
16<!-- tocstop -->
17# Usage
18<!-- usage -->
19```sh-session
20$ npm install -g @percy/agent
21$ percy COMMAND
22running command...
23$ percy (-v|--version|version)
24@percy/agent/0.3.1 linux-x64 node-v10.15.3
25$ percy --help [COMMAND]
26USAGE
27 $ percy COMMAND
28...
29```
30<!-- usagestop -->
31# Commands
32<!-- commands -->
33* [`percy exec`](#percy-exec)
34* [`percy finalize`](#percy-finalize)
35* [`percy help [COMMAND]`](#percy-help-command)
36
37## `percy exec`
38
39Start and stop Percy around a supplied command
40
41```
42USAGE
43 $ percy exec
44
45OPTIONS
46 -p, --port=port [default: 5338] port
47 -t, --network-idle-timeout=network-idle-timeout [default: 50] asset discovery network idle timeout (in milliseconds)
48
49EXAMPLES
50 $ percy exec -- echo "percy is running around this echo command"
51 $ percy exec -- bash -c "echo foo && echo bar"
52```
53
54_See code: [dist/commands/exec.ts](https://github.com/percy/percy-agent/blob/v0.3.1/dist/commands/exec.ts)_
55
56## `percy finalize`
57
58finalize a build
59
60```
61USAGE
62 $ percy finalize
63
64OPTIONS
65 -a, --all (required)
66
67EXAMPLE
68 $ percy finalize --all
69 [percy] Finalized parallel build.
70```
71
72_See code: [dist/commands/finalize.ts](https://github.com/percy/percy-agent/blob/v0.3.1/dist/commands/finalize.ts)_
73
74## `percy help [COMMAND]`
75
76display help for percy
77
78```
79USAGE
80 $ percy help [COMMAND]
81
82ARGUMENTS
83 COMMAND command to show help for
84
85OPTIONS
86 --all see all commands in CLI
87```
88
89_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6/src/commands/help.ts)_
90<!-- commandsstop -->