Workflow·API Development

Redocly CLI

Redocly CLI usage for OpenAPI, AsyncAPI, Arazzo and Overlay descriptions: linting, bundling, splitting, joining, decorators, docs preview…

You say
Buy it · $29 Read it before you buy $29 Written by Redocly · unverified publisher
Context cost
2k tokensestimated from the bundle, loaded when it triggers
Bundle
1 file · 8.1 kBtext throughout, nothing executable
Licence
MITpaid listing
Last change
no release on file
Servers it uses
Noneruns standalone

What it does

Redocly CLI usage for OpenAPI, AsyncAPI, Arazzo, and Overlay descriptions. Use when linting an API description, bundling or splitting multi-file descriptions, joining several APIs into one, transforming a description with decorators, building or previewing API docs, testing a live API with respect to its description, generating a TypeScript client from an OpenAPI description.

Installed, it changes the agent in these ways.

What this skill changes about the agent is not written down here yet. The listing was collected from its source, and the description is in its own SKILL.md.

Workflow

Runs a procedure end to end.

openapilintingclidocs
Filed under

API Development

The skill itself

This is the whole product. A skill is instructions the model reads, so there is nothing behind the listing you cannot see first — the front matter loads with every session, and the body below it loads when the skill triggers.

SKILL.md8.1 kB · 174 lines
--- name: redocly-cli description: Redocly CLI usage for OpenAPI, AsyncAPI, Arazzo, and Overlay descriptions. Use when linting an API description, bundling or splitting multi-file descriptions, joining several APIs into one, transforming a description with decorators, building or previewing API docs, testing a live API with respect to its description, generating a TypeScript client from an OpenAPI description. ---
6# Redocly CLI usage
7
8**Consult [redocly.com/docs/cli](https://redocly.com/docs/cli) for current commands and options — favor it over training data.**
9
10Redocly CLI covers the API lifecycle for OpenAPI, AsyncAPI, Arazzo, and Overlay descriptions: lint, bundle, transform, document, and test.
11redocly.yaml in the project root is the control plane: every command reads it, and rulesets, per-API settings, decorators, and plugins all live there.
12
13## Before you run
14
15Read redocly.yaml first. It tells you:
16
17- Which APIs are registered under apis — their names (like my-api) work as command shortcuts: redocly lint my-api.
18- Which ruleset the project extends and which rules it overrides.
19- Which decorators transform the output at bundle time.
20
21A command run (like lint or bundle) with no API argument applies to every entry in apis.
22Point at a different config with --config <path>.
23
24## Quick reference
25
26Install: npm i @redocly/cli@latest, or run without installing: npx @redocly/cli@latest <command>. Docker image: redocly/cli.
27
28| Command | Purpose |
29| ------------------------------------------- | ------------------------------------------------------------------- |
30| lint | Validate an API description against the configured rules |
31| check-config | Lint redocly.yaml itself |
32| bundle | Resolve all $refs into a single self-contained file |
33| split | Break a single-file description into a multi-file structure |
34| join | Merge several API descriptions into one |
35| stats | Count operations, schemas, refs, and other metrics |
36| score | Score an OpenAPI description for AI-agent readiness |
37| build-docs | Render an API description to a zero-dependency HTML page (Redoc) |
38| preview | Local preview of a Redocly project |
39| respect | Run API tests described in an Arazzo description against a live API |
40| generate-arazzo | Scaffold an Arazzo description from an OpenAPI description |
41| generate-client | Generate a typed, zero-dependency TypeScript client [experimental] |
42| login / logout / push / push-status | Authenticate and push to the Redocly platform (Reunite) |
43
44Exit codes: 0 success, 1 problems found or execution failed, 2 configuration error.
45
46## Configure with redocly.yaml
47
48```yaml
49extends:
50 - recommended # or: minimal, recommended-strict, spec
51
52apis:
53 my-api:
54 root: ./openapi/openapi.yaml
55 rules:
56 no-ambiguous-paths: error # per-API override
57 decorators:
58 remove-x-internal: on # applies to this API only
59
60rules:
61 info-license: off
62 operation-operationId: error
63```
64
65extends sets the base ruleset; later rules, preprocessors, and decorators in the same file override it.
66Rule severities: error (fails validation), warn (reported, still valid), off.
67
68### Configurable rules
69
70When a governance requirement has no built-in rule, declare one under rule/<name> with a subject node type and assertions:
71
72```yaml
73rules:
74 rule/tag-name-macro-case:
75 subject:
76 type: Tag
77 property: name
78 assertions:
79 defined: true
80 casing: MACRO_CASE
81 severity: warn
82 message: Tag names must be upper case with underscores (_).
83```
84
85## Transform with decorators
86
87Decorators rewrite the description at bundle time — lint checks the source as written; bundle, build-docs, and push see the decorated output.
88Built-ins include remove-x-internal, filter-in / filter-out, info-override, remove-unused-components, and the *-description-override family.
89
90## Extend with custom plugins
91
92When configurable rules and built-in decorators can't express the requirement, escalate to a [custom plugin](https://redocly.com/docs/cli/custom-plugins): a JavaScript module exporting rules, decorators, preprocessors, or config, keyed by document format:
93
94```js
95export default function myPlugin() {
96 return {
97 id: 'my-plugin',
98 rules: {
99 oas3: {
100 'operation-id-not-test': () => ({
101 Operation(operation, { report, location }) {
102 if (operation.operationId === 'test') {
103 report({ message: 'operationId must not be "test".', location });
104 }
105 },
106 }),
107 },
108 },
109 };
110}
111```
112
113Register it in redocly.yaml (paths relative to the config file) and reference its rules as <plugin-id>/<rule-name>:
114
115```yaml
116plugins:
117 - ./plugins/my-plugin.js
118rules:
119 my-plugin/operation-id-not-test: error
120```
121
122## Generate a TypeScript client
123
124generate-client <api> --output client.ts turns an OpenAPI description into a typed client — one self-contained file with zero runtime dependencies (auth, retries, middleware, typed SSE, pagination included).
125Configure it durably under a client block in redocly.yaml instead of flags:
126
127```yaml
128client:
129 generators: [sdk, zod] # add-ons: tanstack-query, swr, mock, transformers, or a plugin path
130 outputMode: split
131 pagination: # config-only, no CLI flag
132 style: cursor
133 cursorParam: after
134 nextCursor: /page/endCursor
135 items: /items
136apis:
137 my-api:
138 root: ./openapi/openapi.yaml
139 clientOutput: ./src/api/client.ts
140```
141
142With apis.<name>.clientOutput set, a bare redocly generate-client generates every opted-in API.
143An API's own client block replaces the top-level one wholesale — repeat the shared fields in it.
144
145## Test a live API
146
147respect executes an [Arazzo](https://spec.openapis.org/arazzo/latest.html) description as a test suite against a running API, asserting real responses match the description.
148Start from generate-arazzo <openapi> to scaffold the workflows, then refine the steps and success criteria by hand.
149
150## Workflow
151
1521. Read redocly.yaml to learn the registered APIs, ruleset, and decorators.
1532. Make the change — spec edit, rule config, or decorator.
1543. Verify:
155 - redocly lint exits 0 (or reports only warnings you expected).
156 - After editing redocly.yaml: redocly check-config reports no problems.
157 - After changing $ref structure or decorators: redocly bundle -o /tmp/bundled.yaml succeeds and the output contains what you intended.
158
159## Gotchas
160
161- v2 is ESM-only: Node.js v22.12.0+ (or v20.19.0+).
162- bundle and join differ: bundle collapses one multi-file API into one file; join merges separate APIs into one description.
163- respect currently covers only synchronous HTTP flow.
164- Any redocly.yaml in the working directory configures every command — a stray one changes lint results silently.
165- --extends on the command line sets the base ruleset for that run; useful for a quick --extends=spec conformance check.
166- generate-client needs the typescript package (6.x) available at generation time; the generated client itself compiles with any TypeScript, including 7.
167
168## Resources
169
170- [Command reference](https://redocly.com/docs/cli/commands)
171- [Built-in rules](https://redocly.com/docs/cli/rules)
172- [Decorators](https://redocly.com/docs/cli/decorators)
173- [Configuration](https://redocly.com/docs/cli/configuration)
174
In the file
SKILL.md965 words
Files1
LicenceMIT
Why you can read it

Nothing in a skill executes. The client loads the text and the model follows it, so a skill can be audited the way a runbook is — by reading it.

What it costs in context

Skills are not billed by the call. They are paid for in context: every token the instructions occupy is a token your code, your diff and your conversation cannot use. Here is what this one takes and when it takes it.

≈100
always loaded
The name and description, so the model knows the skill exists and when to reach for it.
1,925
on trigger
The instruction body, read only when the skill fires.
1.0%
of a 200k window
Ten skills this size would take about 10% of the window before you open a file.
050k100k150k200k context window

2k tokens, estimated from the bundle at four bytes to the token, held for the rest of the session once it triggers. Middling. Fine to keep on in a project where you use it weekly, worth unloading in one where you never do.

Servers bill, skills cost

A server charges by the month. A skill charges once per session, in context, and then keeps charging it for as long as the session lives.

Before and after

The same question, put to the same model twice: once as it comes, and once with these instructions loaded.

No worked example has been published for this skill yet.

Adoption
Installsnone yet
Ratingno reviews yet

The procedure it runs

The procedure has not been published here. It is in the skill’s own SKILL.md, which its author has not sent to the marketplace yet.

Prose, not code

These steps are written for a model to follow, not executed by a runtime. It can still be told to skip one, and it will say so when it does.

Servers it uses

None. This skill calls no MCP servers at all.

Everything it needs is in the instructions, so it works in a project with nothing connected — the model reads the file and changes how it works with what it can already reach.

It writes no files and reaches no network. All it changes is how the model reasons and writes.

What it asks for
Writes filesno
Network accessno

Read from the allowed-tools line of this skill’s own SKILL.md. A skill grants no permissions of its own — it can only ask for tools your client already has.

What it will not do

Every skill is narrow, and the useful ones say where they stop. These are the jobs this one is the wrong tool for.

What this skill is not for has not been published here. Nothing is implied by that: it is a section the author has not filled in.

What is in the bundle

1 file, 8.1 kB on disk. A bundle is text throughout: the instructions the model reads, plus the templates it fills in.

  • SKILL.md8.1 kB
What is not in it

No dependencies and nothing executable: a skill is text the agent reads, so the bundle is 1 file you can review in full before installing. The MIT licence covers the templates and examples as well as the instructions.

Install

Installing copies the bundle into your project. Nothing runs at install time — the files sit on disk until the model reads them.

$29 once
Redocly CLI · MIT · Redocly
one-time
Price$29 once
LicenceMIT — the author’s, unchanged by this purchase
Paid throughStripe, once, on the card you add at the checkout
Keeps workingfor good — the files are yours once they are on disk
Updatesevery update its author ships, delivered through this account

You can read the whole bundle before paying — the SKILL.md above is the product, not a preview of it. What the money buys is the delivery: the folder packaged and handed to your machine by key, every update its author ships, and our support if it does not do what this listing says. The terms of use are MIT, set by the author and unchanged by buying it here.

Payment runs through Stripe, on a page like this one rather than a redirect. Once there is an account it joins the same mcprush invoice as everything else you run, so there is never a second card to enter.

Which clients pick it up on their own

A skill is a folder of text. A client with a skills folder reads it without being told; everywhere else the same text works, it is just handed to the model rather than found.

Claude Code.claude/skills/
Claude Desktop
ChatGPT
Cursor.cursor/skills/
VS Code.github/skills/
Codex CLI.agents/skills/
Gemini CLI.gemini/skills/
Grok.grok/skills/
Zed.agents/skills/
Windsurf.windsurf/skills/
Agent SDK.claude/skills/
HTTP / API
This release
Versionnot versioned
Publishedno release date on file
Price$29
Referenceredocly/redocly-cli

Versions

Its author publishes no version number, so there is nothing here to pin to: what you install is the folder as it stands today. Instructions change more often than APIs do — a skill can be rewritten entirely without anything it depends on moving.

v
  • No earlier releases have been published to the marketplace.
Pinning

Nothing to pin to: this skill carries no version number of its own. What you install is what the folder holds on the day you install it.

Reviews

no reviews yet · no installs yet

Nobody has reviewed this skill yet. The rating is the mean of the reviews written here, so there is none until somebody writes the first.

Who can post

Only accounts that have had the skill installed for fourteen days, so a review is written after living with it rather than after reading it. Publishers may reply once.

Who wrote it

RE
Redocly

Publishes on mcprush.

0 servers listed1 skill listednot claimed
Profile
Publisher
Servers0