| 1 | # @stoplight/cli
|
| 2 |
|
| 3 | 
|
| 4 |
|
| 5 | ## Usage
|
| 6 |
|
| 7 | ```bash
|
| 8 | # Install the Stoplight CLI
|
| 9 | npm install -g @stoplight/cli
|
| 10 |
|
| 11 | # Output a list of commands
|
| 12 | stoplight --help
|
| 13 | ```
|
| 14 |
|
| 15 | ## Commands
|
| 16 |
|
| 17 | ### push
|
| 18 |
|
| 19 | ```bash
|
| 20 | stoplight push --help
|
| 21 |
|
| 22 | Usage: stoplight push [options]
|
| 23 |
|
| 24 | Analyzes a directory of files and pushes the APIs, models, and docs to Stoplight
|
| 25 |
|
| 26 | Options:
|
| 27 | --ci-token <ciToken> project ci token
|
| 28 | -b, --branch <branch> project branch name
|
| 29 | -d, --directory <directory> directory to analyze and push to stoplight
|
| 30 | --url <url> stoplight installation (default: "https://stoplight.io")
|
| 31 | --verbose enable detailed logging
|
| 32 | --dry-run output analyzes result without pushing to stoplight
|
| 33 | -h, --help output usage information
|
| 34 | ```
|
| 35 |
|
| 36 | ## Development
|
| 37 |
|
| 38 | ```bash
|
| 39 | # Build the CLI commands
|
| 40 | yarn build
|
| 41 |
|
| 42 | # To
|
| 43 | yarn cli push --directory ../../path/to/repo --url stoplight-local.com:8080 --ci-token 123 --branch master
|
| 44 | ```
|
| 45 |
|
| 46 | ## Support
|
| 47 |
|
| 48 | If you have a bug or feature request, please [create an issue](https://github.com/stoplightio/stoplight-cli/issues).
|
| 49 |
|
| 50 | If you need help using the CLI or have a support question, please use the [Stoplight Community forum](https://community.stoplight.io).
|
| 51 |
|
| 52 | If you want to discuss something in private, you can reach out to Stoplight support at [support@stoplight.io](mailto:support@stoplight.io).
|