@useoptic/ci-cli

• Usage
• Commands

Usage

$ npm install -g @useoptic/ci-cli
$ optic-ci COMMAND
running command...
$ optic-ci (-v|--version|version)
@useoptic/ci-cli/8.3.5 darwin-x64 node-v12.4.0
$ optic-ci --help [COMMAND]
USAGE
  $ optic-ci COMMAND
...

Commands

• optic-ci capture:start
• optic-ci help [COMMAND]

optic-ci capture:start

starts an Optic CI capture session and returns a capture configuration which can be fed to optic-agent

USAGE
  $ optic-ci capture:start

OPTIONS
  --build-id=build-id            (required) a unique identifier representing the version of the code, build process, and
                                 build environment variables

  --config=config                (required) the path to your optic.yml file

  --deployment-id=deployment-id  (required) a unique identifier representing the version of the code, build process,
                                 build environment variables, and runtime environment variables

  --environment=environment      (required) the name of the environment you are deploying into

EXAMPLES
  $ optic-ci capture:start --deployment-id=<version_number> --build-id=<changeset_hash> --environment=<environment_name> 
  --config=optic.yml
  $ CAPTURE_CONFIG=$(optic-ci capture:start --deployment-id=<...> --build-id=<...> --environment=<...> 
  --config=optic.yml)

See code: src/commands/capture/start.ts

optic-ci help [COMMAND]

display help for optic-ci

USAGE
  $ optic-ci help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help