Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@useoptic/cli

Package Overview
Dependencies
Maintainers
4
Versions
217
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@useoptic/cli

The Optic CLI

  • 8.6.0-beta.14
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
17
increased by750%
Maintainers
4
Weekly downloads
 
Created
Source

local-cli

CLI to document your API and generate artifacts

oclif Version Downloads/week License

Usage

$ npm install -g @useoptic/cli
$ api COMMAND
running command...
$ api (-v|--version|version)
@useoptic/cli/8.6.0-beta.14 linux-x64 node-v12.19.0
$ api --help [COMMAND]
USAGE
  $ api COMMAND
...

Commands

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
  --yaml

See 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 CLI

See code: @oclif/plugin-help

api init

Add Optic to your API

USAGE
  $ api init

OPTIONS
  --command=command
  --inboundUrl=inboundUrl
  --targetUrl=targetUrl

See code: src/commands/init.ts

api login

Login to Optic from the CLI

USAGE
  $ api login

See code: src/commands/login.ts

api logout

Logout from Optic

USAGE
  $ api logout

See code: src/commands/logout.ts

api run [TASKNAME]

Run a task from your optic.yml

USAGE
  $ api run [TASKNAME]

OPTIONS
  -c, --collect-coverage

See code: src/commands/run.ts

api scripts [SCRIPTNAME]

Run one of the scripts in your optic.yml file

USAGE
  $ api scripts [SCRIPTNAME]

OPTIONS
  -i, --install

See code: src/commands/scripts.ts

api spec

Open your Optic API specification

USAGE
  $ api spec

See code: src/commands/spec.ts

api start

starts your API process behind an Optic proxy

USAGE
  $ api start

OPTIONS
  -c, --collect-coverage

See code: src/commands/start.ts

Keywords

FAQs

Package last updated on 11 Nov 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc