@redocly/cli 0.0.0-snapshot.1782825774 → 0.0.0-snapshot.1783058823

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 Redocly Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,9 +1,9 @@
 # Redocly CLI
 
-[@Redocly](https://redocly.com) CLI is your all-in-one OpenAPI utility.
-It builds, manages, improves, and quality-checks your OpenAPI descriptions, all of which comes in handy for various phases of the API Lifecycle.
+[@Redocly](https://redocly.com) CLI is your all-in-one API documentation utility.
+It builds, manages, improves, and quality-checks your API descriptions, all of which comes in handy for various phases of the API Lifecycle.
 Create your own rulesets to make API governance easy, publish beautiful API reference documentation, and more.
-Supports OpenAPI 3.1, 3.0 and OpenAPI 2.0 (legacy Swagger), AsyncAPI 3.0 and 2.6, Arazzo 1.0.
+Supports OpenAPI 3.2, 3.1, 3.0 and OpenAPI 2.0 (legacy Swagger), AsyncAPI 3.0 and 2.6, Arazzo 1.0.
 
 ![build and test](https://github.com/redocly/redocly-cli/actions/workflows/tests.yaml/badge.svg)
 ![npm (scoped)](https://img.shields.io/npm/v/@redocly/cli)
@@ -11,18 +11,23 @@ Supports OpenAPI 3.1, 3.0 and OpenAPI 2.0 (legacy Swagger), AsyncAPI 3.0 and 2.6
 
 ![OpenAPI CLI toolset](./media/redocly-cli.gif)
 
+## Migration
+
+Migrating from Redocly CLI v1 to v2?
+Here's the [guide](https://redocly.com/docs/cli/guides/migrate-to-v2) to make the transition smoother.
+
 ## Usage
 
 ### Node
 
 ```sh
-npx @redocly/cli@v1-archive lint path-to-root-file.yaml
+npx @redocly/cli@latest lint path-to-root-file.yaml
 ```
 
 Alternatively, install it globally with `npm`:
 
 ```sh
-npm install @redocly/cli@v1-archive -g
+npm install @redocly/cli -g
 ```
 
 Then you can use it as `redocly [command] [options]`, for example:
@@ -31,7 +36,7 @@ Then you can use it as `redocly [command] [options]`, for example:
 redocly lint path-to-root-file.yaml
 ```
 
-The minimum required versions of Node.js and NPM are 18.17.0 and 10.8.2 respectively.
+The minimum required versions of Node.js and NPM are 22.12.0 and 10.9.2 respectively.
 
 ### Docker
 
@@ -91,8 +96,8 @@ redocly lint openapi.yaml
 ```
 
 **Configure the rules** as you wish.
-Other API Linters use complicated identifiers like JSONPath, but Redocly makes life easy with simple expressions that understand the OpenAPI structure.
-You can either use the [built-in rules](https://redocly.com/docs/cli/rules) to mix-and-match your ideal API guidelines, or break out the tools to build your own.
+Other API Linters use complicated identifiers like JSONPath, but Redocly makes life easy with simple expressions that understand the API specification structure.
+You can either use the [built-in rules](https://redocly.com/docs/cli/rules) to mix-and-match your ideal API guidelines, or break out the tools to [build your own](https://redocly.com/docs/cli/rules#rule-ideas).
 
 **Format the output** in whatever way you need.
 The `stylish` output is as good as it sounds, but if you need JSON, Markdown, Checkstyle and other outputs to integrate with other tools, the `lint` command can output those too.
@@ -101,6 +106,39 @@ The `stylish` output is as good as it sounds, but if you need JSON, Markdown, Ch
 
 [Learn more about API standards and configuring Redocly rules](https://redocly.com/docs/cli/api-standards).
 
+Looking for more examples? Check out our [Cookbook](https://github.com/Redocly/redocly-cli-cookbook).
+
+### API contract testing with Respect
+
+Ensure your APIs match their OpenAPI descriptions with **Respect**, Redocly's API contract testing system. Respect sends real HTTP requests to your API server and validates that responses match the expectations defined in your OpenAPI description and Arazzo workflows.
+
+- Verify API responses match your OpenAPI schema
+- Test complex API sequences using OpenAPI Arazzo format
+- Catch API drift early in development and CI/CD
+- Ensure external APIs you depend on behave as expected
+- Track response times and detect anomalies
+
+#### Quick start
+
+```sh
+# Generate test workflows from your OpenAPI spec
+redocly generate-arazzo openapi.yaml
+
+# Run contract tests against your API
+redocly respect auto-generated.arazzo.yaml --verbose
+```
+
+#### Respect vs. Respect Monitoring
+
+Respect is Redocly's community-edition product. Looking for something more? We also offer continuous API monitoring with additional features including:
+
+- Real-time insights
+- Automated alerts via email or Slack
+- Automated API checks
+- Proactive API quality assurance
+
+Learn more about [Respect](https://redocly.com/respect) and [get started with API contract testing](https://redocly.com/docs/respect/get-started).
+
 ### Transform an OpenAPI description
 
 If your OpenAPI description isn't everything you hoped it would be, enhance it with the Redocly [decorators](https://redocly.com/docs/cli/decorators) feature.