@useoptic/cli

@useoptic/cli

API automation for the modern team

• Usage
• Commands

Usage

$ npm install -g @useoptic/cli
$ optic COMMAND
running command...
$ optic (-v|--version|version)
@useoptic/cli/2.5.3 darwin-x64 node-v8.12.0
$ optic --help [COMMAND]
USAGE
  $ optic COMMAND
...

Commands

• optic api:add APIID APIVERSION
• optic api:document
• optic api:install
• optic api:publish
• optic auth:add-token
• optic auth:login
• optic config:check
• optic help [COMMAND]
• optic setup:paths [TESTCMD]
• optic setup:tests [TESTCMD]

optic api:add APIID APIVERSION

Install an Optic API and generate artifacts (Swagger/OAS, SDKs, etc.)

USAGE
  $ optic api:add APIID APIVERSION

ARGUMENTS
  APIID       "team/api" or "api"
  APIVERSION  the version of "apiId" you want to consume

OPTIONS
  -o, --outputDirectory=outputDirectory  directory to output generated artifacts (Swagger/OAS, SDKs, etc.)

See code: src/commands/api/add.ts

optic api:document

document your API contract

USAGE
  $ optic api:document

See code: src/commands/api/document.ts

optic api:install

Generates artifacts (Swagger/OAS, SDKs, etc.) for the APIs that have been added via api:add

USAGE
  $ optic api:install

OPTIONS
  -o, --outputDirectory=outputDirectory  (required) directory to output generated artifacts (Swagger/OAS, SDKs, etc.)

See code: src/commands/api/install.ts

optic api:publish

publish your API contract to Optic

USAGE
  $ optic api:publish

OPTIONS
  -d, --draft

See code: src/commands/api/publish.ts

optic auth:add-token

authenticate the CLI

USAGE
  $ optic auth:add-token

See code: src/commands/auth/add-token.ts

optic auth:login

login to your account from the CLI

USAGE
  $ optic auth:login

OPTIONS
  --host=host

See code: src/commands/auth/login.ts

optic config:check

validate your optic.yml

USAGE
  $ optic config:check

See code: src/commands/config/check.ts

optic help [COMMAND]

display help for optic

USAGE
  $ optic help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

optic setup:paths [TESTCMD]

detect API paths by running tests

USAGE
  $ optic setup:paths [TESTCMD]

ARGUMENTS
  TESTCMD  the command that runs your tests

See code: src/commands/setup/paths.ts

optic setup:tests [TESTCMD]

validate that your tests log data to Optic

USAGE
  $ optic setup:tests [TESTCMD]

ARGUMENTS
  TESTCMD  the command that runs your tests

See code: src/commands/setup/tests.ts