You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP
Socket
Book a DemoInstallSign in
Socket

@stoplight/cli

Package Overview
Dependencies
Maintainers
0
Versions
8436
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@stoplight/cli

Stoplight CLI

6.0.2393
latest
npmnpm
Version published
Weekly downloads
12K
135.58%
Maintainers
0
Weekly downloads
 
Created
Source

@stoplight/cli

publish demo

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 support@stoplight.io.

FAQs

Package last updated on 02 Aug 2025

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