Nightly Perpetrated Mischief
    Wondering what’s next for npm?Check out our public roadmap! »

    @stoplight/cli

    5.0.105 • Public • Published

    @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 stoplight-local.com:8080 --ci-token 123 --branch master

    Support

    If you have a bug or feature request, please create an issue.

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

    If you want to discuss something in private, you can reach out to Stoplight support at support@stoplight.io.

    Keywords

    none

    Install

    npm i @stoplight/cli

    DownloadsWeekly Downloads

    9,093

    Version

    5.0.105

    License

    Apache-2.0

    Unpacked Size

    2.59 MB

    Total Files

    7

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar