@useoptic/agent-cli

@useoptic/agent-cli

• Usage
• Commands

Usage

$ npm install -g @useoptic/agent-cli
$ optic-agent COMMAND
running command...
$ optic-agent (-v|--version|version)
@useoptic/agent-cli/9.0.20 linux-x64 node-v12.22.1
$ optic-agent --help [COMMAND]
USAGE
  $ optic-agent COMMAND
...

Commands

• optic-agent help [COMMAND]
• optic-agent run

optic-agent help [COMMAND]

display help for optic-agent

USAGE
  $ optic-agent help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

optic-agent run

Monitor your API with Optic, given a capture configuration generated by optic-ci

USAGE
  $ optic-agent run

OPTIONS
  --command=command      (required, or --targetUrl) the command to start your API
  --config=config        (required) the output from optic-ci capture:start
  --listen=listen        (required) host:port Optic should listen on (aliases: --baseUrl, --inboundUrl)
  --targetUrl=targetUrl  (required, or --command) the url where your API is available

EXAMPLE
  $ optic-agent run --command="npm start" --config=$CAPTURE_CONFIG --listen=http://localhost:3001

See code: src/commands/run.ts