mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-06 04:21:09 +00:00
909fb471ca
* feat: Add Vale configuration and rules * docs: Fix top-level files to match Vale rules * docs: Vale updates for the commands docs * docs: apply Vale updates to the decorator docs * docs: Update guides to match Vale rules * docs: update rules and other content to meet Vale standards * docs: add Vale link and information to CONTRIBUTING * feat: Add GitHub action for Vale * docs: minor editing to readme.md * docs: minor editing to the changelog.md file * docs: minor edits to the join.md file in commands folder * docs: minor edits to lint.md file in the commands directory * docs: minor edit to the login.md file in the commands directory * docs: minor edits to the preview.md file in the commands directory * docs: minor edits to push.md file in the comands directory * docs: minor edits to the info-description-override.md file in the decorators directory * docs: minor edits to the configure-rules.md file in the guides directory * docs: minor edits to custom-plugin.md file in the resources directory * docs: minor editing to the no-http-verbs-in-paths.md file in the rules directory --------- Co-authored-by: Heather Cloward <heathercloward@gmail.com>
1.6 KiB
1.6 KiB
Install Redocly CLI
Choose the most appropriate installation method for your needs:
- Install locally, using
npmoryarnto make theredoclycommand available on your system. - Use
npxto get the tool at runtime rather than installing it. - The command is also available via Docker if you'd prefer to use it that way.
Install globally
:::success Tip
Make sure you have the newest version of npm/yarn before you begin.
:::
npm i -g @redocly/cli@latest
yarn global add @redocly/cli
Running redocly --version confirms that the installation was successful, and the currently-installed version of the tool.
Use npx at runtime
npx is npm's package runner. It installs and runs a command without installing it globally. You might use this where you can't install a new command, or in a CI context where the command is only used a handful of times.
npx @redocly/cli <command> [options]
npx @redocly/cli@latest lint petstore.yaml
Run commands inside Docker
To give a Docker container access to your OpenAPI definition files, you need to mount the containing directory as a volume. Assuming the definition is in the current working directory, the command to use is:
docker run --rm -v $PWD:/spec redocly/cli lint petstore.yaml
Next steps
- Set up autocomplete for Redocly CLI.
- Check the full list of Redocly CLI commands available.