@stoplight/cli/README.md

# @stoplight/cli

![publish demo](./public/demo.gif)

## Usage

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

# Output a list of commands
stoplight --help
```

## Commands

### publish

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

```bash
stoplight publish --help

Usage: stoplight publish [options]

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

Options:
  -t, --token <token>          Project CI token
  -p, --project <project>      Project SRN (ex. gh/stoplightio/studio)
  -g, --group <group>          Project group name
  -d, --directory <directory>  Directory to analyze
  --url <url>                  Stoplight API (default: "https://stoplight.io/api")
  --verbose                    Enable detailed logging
  --dry-run                    Output analyze result without publishing
  -h, --help                   Output usage information
```

## Development

```bash
# Build the CLI commands
yarn build

# Re-install the CLI globally
npm rm -g && npm i -g
```

## Support

If you have a bug or feature request, please [create an issue](https://github.com/stoplightio/stoplight-cli/issues).

If you need help using the CLI or have a support question, please use the [Stoplight Community forum](https://community.stoplight.io).

If you want to discuss something in private, you can reach out to Stoplight support at [support@stoplight.io](mailto:support@stoplight.io).