@stoplight/cli

@stoplight/cli

Usage

# Install the Stoplight CLI
npm install -g @stoplight/cli

# Output a list of commands
stoplight --help

Commands

push

stoplight push --help

Usage: stoplight push [options]

Analyzes a directory of files and pushes the APIs, models, and docs to Stoplight

Options:
  --ci-token        <ciToken>     project ci token
  -b, --branch      <branch>      project branch name
  -d, --directory   <directory>   directory to analyze and push to stoplight
  --url             <url>         stoplight installation (default: "https://stoplight.io")
  --verbose                       enable detailed logging
  --dry-run                       output analyzes result without pushing to stoplight
  -h, --help                      output usage information

It is possible to let the CLI go through a proxy by setting the HTTP_PROXY env variable.

Development

# Build the CLI commands
yarn build

# To
yarn cli push --directory ../../path/to/repo --url http://stoplight-local.com:8080 --ci-token 123 --branch main

Note: ts-node cannot be used because of fancy webworker stuff.

Versioning

When releasing a new version of stoplight cli, use standard semver 2.0.0 versioning

MAJOR version when you make incompatible API changes
MINOR version when you add functionality in a backwards compatible manner
PATCH version when you make backwards compatible bug fixes

All changes to stoplight cli should result in a version bump.

Support

If you need help using the CLI or have a support question, please use the Stoplight Community forum.

If you have a bug or feature request, please reach out to Stoplight support at [e-mail].