@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/3.2.1 darwin-x64 node-v10.15.3
$ optic --help [COMMAND]
USAGE
  $ optic COMMAND
...

Commands

• optic api:add API-ID
• optic api:document
• optic api:install
• optic api:publish
• optic api:publishLocal
• optic api:update
• optic auth:login
• optic auth:logout
• optic config:check
• optic help [COMMAND]
• optic setup:init
• optic setup:paths [TESTCMD]
• optic setup:tests [TESTCMD]

optic api:add API-ID

Add API dependencies to your project

USAGE
  $ optic api:add API-ID

ARGUMENTS
  API-ID  "org/api" or "api"

OPTIONS
  -g, --generate=generate  artifacts to generate
  -v, --version=version    [default: latest] API version to consume, defaults to "latest"

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

optic api:document

document your API contract

USAGE
  $ optic api:document

OPTIONS
  --generate=generate

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

optic api:install

Generates artifacts defined in your optic.yml file

USAGE
  $ optic api:install

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 api:publishLocal

publish your API contract locally

USAGE
  $ optic api:publishLocal

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

optic api:update

Checks if any API dependencies need updates

USAGE
  $ optic api:update

See code: src/commands/api/update.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 auth:logout

logout from the CLI

USAGE
  $ optic auth:logout

OPTIONS
  --host=host

See code: src/commands/auth/logout.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:init

setup an optic project

USAGE
  $ optic setup:init

OPTIONS
  --id=id
  --verify-tests

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

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