@useoptic/cli v10.3.0
local-cli
CLI to document your API and generate artifacts
Usage
$ npm install -g @useoptic/cli
$ api COMMAND
running command...
$ api (-v|--version|version)
@useoptic/cli/8.4.1-beta darwin-x64 node-v12.4.0
$ api --help [COMMAND]
USAGE
$ api COMMAND
...Commands
api check [TASKNAME]api generate:oasapi help [COMMAND]api initapi loginapi logoutapi run [TASKNAME]api scripts [SCRIPTNAME]api specapi start
api check [TASKNAME]
Validate the correctness of a task in your optic.yml
USAGE
$ api check [TASKNAME]See code: src/commands/check.ts
api generate:oas
export an OpenAPI 3.0.1 spec
USAGE
$ api generate:oas
OPTIONS
--json
--yamlSee code: src/commands/generate/oas.ts
api help [COMMAND]
display help for api
USAGE
$ api help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLISee code: @oclif/plugin-help
api init
Add Optic to your API
USAGE
$ api init
OPTIONS
--command=command
--inboundUrl=inboundUrl
--targetUrl=targetUrlSee code: src/commands/init.ts
api login
Login to Optic from the CLI
USAGE
$ api loginSee code: src/commands/login.ts
api logout
Logout from Optic
USAGE
$ api logoutSee code: src/commands/logout.ts
api run [TASKNAME]
Run a task from your optic.yml
USAGE
$ api run [TASKNAME]
OPTIONS
-c, --collect-coverageSee code: src/commands/run.ts
api scripts [SCRIPTNAME]
Run one of the scripts in your optic.yml file
USAGE
$ api scripts [SCRIPTNAME]
OPTIONS
-i, --installSee code: src/commands/scripts.ts
api spec
Open your Optic API specification
USAGE
$ api specSee code: src/commands/spec.ts
api start
starts your API process behind an Optic proxy
USAGE
$ api start
OPTIONS
-c, --collect-coverageSee code: src/commands/start.ts
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago