@useoptic/cli
API automation for the modern team
Last updated 8 days ago by useopticdev .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @useoptic/cli 
SYNC missed versions from official npm registry.

@useoptic/cli

API automation for the modern team

oclif Version Downloads/week License

Usage

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

Commands

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

Current Tags

  • 3.2.5                                ...           latest (8 days ago)

30 Versions

  • 3.2.5                                ...           8 days ago
  • 3.2.4                                ...           9 days ago
  • 3.2.3                                ...           9 days ago
  • 3.2.2                                ...           9 days ago
  • 3.2.1                                ...           9 days ago
  • 3.2.0                                ...           9 days ago
  • 2.5.4                                ...           20 days ago
  • 2.5.3                                ...           22 days ago
  • 2.5.2                                ...           22 days ago
  • 2.5.1                                ...           22 days ago
  • 2.5.0                                ...           23 days ago
  • 2.2.1                                ...           2 months ago
  • 2.2.0                                ...           2 months ago
  • 2.1.8                                ...           2 months ago
  • 2.1.7                                ...           2 months ago
  • 2.1.6                                ...           2 months ago
  • 2.1.5                                ...           2 months ago
  • 2.1.4                                ...           2 months ago
  • 2.1.3                                ...           2 months ago
  • 2.1.2                                ...           2 months ago
  • 2.1.0                                ...           2 months ago
  • 2.0.4                                ...           2 months ago
  • 2.0.3                                ...           2 months ago
  • 2.0.2                                ...           2 months ago
  • 2.0.1                                ...           2 months ago
  • 2.0.0                                ...           2 months ago
  • 0.1.4-alpha.1                                ...           2 months ago
  • 0.1.2-alpha                                ...           2 months ago
  • 0.1.1-alpha                                ...           2 months ago
  • 0.1.0-alpha                                ...           2 months ago
Downloads
Today 0
This Week 0
This Month 184
Last Day 0
Last Week 87
Last Month 215
Dependencies (21)
Dev Dependencies (21)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |