@redocly/cli 2.70.0 → 2.71.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (161) hide show
  1. package/THIRD_PARTY_NOTICES +3 -3
  2. package/lib/chunks/25RSTUQA.js +7 -0
  3. package/lib/chunks/{K4NCFIYY.js → 2IUGP2IH.js} +3 -3
  4. package/lib/chunks/{7R4MBJSO.js → 2NYYNBAC.js} +1 -1
  5. package/lib/chunks/{27HOIIUB.js → 3N7LKSDD.js} +1 -1
  6. package/lib/chunks/4DUOPCYP.js +7 -0
  7. package/lib/chunks/{636S3S3W.js → 54EKLNNI.js} +1 -1
  8. package/lib/chunks/5BQNATJZ.js +20 -0
  9. package/lib/chunks/{PF43QQZA.js → 5DW3QRJB.js} +2 -2
  10. package/lib/chunks/{57DEU3FG.js → 5SSWNONM.js} +1 -1
  11. package/lib/chunks/6TCEQRVX.js +10 -0
  12. package/lib/chunks/{U6PNFV4R.js → 6ZNJ7RDX.js} +2 -2
  13. package/lib/chunks/{EHJFDQN5.js → 7HFLPQAB.js} +2 -2
  14. package/lib/chunks/{BXUA6AY4.js → ACAPGKSR.js} +59 -25
  15. package/lib/chunks/ACECCMWJ.js +14 -0
  16. package/lib/chunks/AH6ANNYP.js +9 -0
  17. package/lib/chunks/B5SUTVG4.js +7 -0
  18. package/lib/chunks/{HAOBCQWB.js → BE4Z5FOC.js} +10 -8
  19. package/lib/chunks/{PL7WHX67.js → BOWZV5S6.js} +1 -1
  20. package/lib/chunks/{IULINGO6.js → BPSWCUZE.js} +1 -1
  21. package/lib/chunks/{7CBQD5PF.js → BXXX3ZCV.js} +1 -1
  22. package/lib/chunks/{SV2XHB2S.js → CHX7O5AM.js} +7 -7
  23. package/lib/chunks/{2NVGTELR.js → CJWIDJTB.js} +1 -1
  24. package/lib/chunks/{ACLT4ABL.js → CX76LEFC.js} +1 -1
  25. package/lib/chunks/{WBWCX3LS.js → DORXGE7Z.js} +93 -93
  26. package/lib/chunks/{LD5MEXEL.js → DP3T6VZX.js} +1 -1
  27. package/lib/chunks/{FKKC7G6X.js → DURXFJ7H.js} +1 -1
  28. package/lib/chunks/DVLD4FET.js +20 -0
  29. package/lib/chunks/{YQZIKJQK.js → EAFZ6DNQ.js} +1 -1
  30. package/lib/chunks/{LS3G7CUH.js → EBHQXW6Z.js} +1 -1
  31. package/lib/chunks/{6RKDRRBP.js → EO65RJ4Z.js} +1 -1
  32. package/lib/chunks/{T55LQK2H.js → EQOFXQKD.js} +1 -1
  33. package/lib/chunks/FBEEMKTB.js +7 -0
  34. package/lib/chunks/{BU4AMVHN.js → FGJDZKD2.js} +1 -1
  35. package/lib/chunks/G6SB4ZP5.js +7 -0
  36. package/lib/chunks/{LRMOPAZ4.js → GAKWND4S.js} +1 -1
  37. package/lib/chunks/HAGYQ4BK.js +20 -0
  38. package/lib/chunks/{UW36CSXE.js → HBWCMTP3.js} +1 -1
  39. package/lib/chunks/{2R2CXBRH.js → HWOL3HHR.js} +1 -1
  40. package/lib/chunks/{FXHPWQD4.js → ILYXMZRT.js} +1 -1
  41. package/lib/chunks/{U32PWLWM.js → INGAWMLB.js} +1 -1
  42. package/lib/chunks/{23VRM4VC.js → IYV7EO2J.js} +1 -1
  43. package/lib/chunks/IZMDARCL.js +22 -0
  44. package/lib/chunks/JOWPA3MJ.js +7 -0
  45. package/lib/chunks/KFQC57GK.js +145 -0
  46. package/lib/chunks/KJIUDCYZ.js +7 -0
  47. package/lib/chunks/{EV2R6OHD.js → L2O63VRM.js} +1 -1
  48. package/lib/chunks/{6P2KU7XN.js → MH5X2EVH.js} +1 -1
  49. package/lib/chunks/{RLJVKAOL.js → NLAPR7D4.js} +1 -1
  50. package/lib/chunks/O53IFFP3.js +98 -0
  51. package/lib/chunks/PBQOGZ5C.js +8 -0
  52. package/lib/chunks/{AFZIICGE.js → Q3IJURM3.js} +1 -1
  53. package/lib/chunks/{HHCU6T2V.js → QXBSAWH3.js} +1 -1
  54. package/lib/chunks/QXHFS5G6.js +7 -0
  55. package/lib/chunks/{IPDHEEHQ.js → QZJAXPYF.js} +1 -1
  56. package/lib/chunks/{LT6WLL3O.js → RBJCAITC.js} +1 -1
  57. package/lib/chunks/{LG6FRFOY.js → RBNQC5ZB.js} +1 -1
  58. package/lib/chunks/{2CMKIFTE.js → RNA6JDRC.js} +1 -1
  59. package/lib/chunks/{DHP4BBTH.js → RNL7TC2W.js} +1 -1
  60. package/lib/chunks/{WKDC6LN3.js → RUPTJCF5.js} +1 -1
  61. package/lib/chunks/{MKYAX4HH.js → S6W63XAS.js} +1 -1
  62. package/lib/chunks/{B3GE7EIX.js → TN3JQHMS.js} +1 -1
  63. package/lib/chunks/TNRIBQHV.js +7 -0
  64. package/lib/chunks/TZROZMVE.js +20 -0
  65. package/lib/chunks/{BMAUX474.js → U7KIB7CD.js} +1 -1
  66. package/lib/chunks/{BD5WLGAJ.js → UMN7TKTH.js} +2 -2
  67. package/lib/chunks/{Q43RV27Q.js → V34D5CUU.js} +1 -1
  68. package/lib/chunks/{7PKQV3SS.js → W2CABGMW.js} +1 -1
  69. package/lib/chunks/{ODGGZDFZ.js → WCJ2HAN3.js} +1 -1
  70. package/lib/chunks/{YNBDXA7I.js → WJ3YDHQA.js} +1 -1
  71. package/lib/chunks/{CKDLDSPG.js → WLI2XLEP.js} +1 -1
  72. package/lib/chunks/X7C43UBI.js +7 -0
  73. package/lib/chunks/{EH6VW7JO.js → XGPGFZMH.js} +1 -1
  74. package/lib/chunks/{7GM5RHYD.js → XZIK3H6V.js} +1 -1
  75. package/lib/chunks/{NOS4FCD7.js → Y3LDWYZD.js} +1 -1
  76. package/lib/chunks/{YYPD75S5.js → Y5DDX2MU.js} +1 -1
  77. package/lib/chunks/{MT4W54PL.js → YL3LVBZF.js} +1 -1
  78. package/lib/chunks/{EIXR5LCC.js → ZBB6PS6I.js} +1 -1
  79. package/lib/chunks/{NZE22F7Q.js → ZQTHHPK3.js} +2 -2
  80. package/lib/eject-assets/generators/cli/docs.ts +1 -1
  81. package/lib/eject-assets/generators/cli/engine-source.ts +1 -1
  82. package/lib/eject-assets/generators/cli/index.ts +2 -2
  83. package/lib/eject-assets/generators/cli/render.ts +1 -1
  84. package/lib/eject-assets/generators/go/client.ts +1 -1
  85. package/lib/eject-assets/generators/go/descriptor.ts +1 -1
  86. package/lib/eject-assets/generators/go/index.ts +2 -2
  87. package/lib/eject-assets/generators/go/models.ts +7 -2
  88. package/lib/eject-assets/generators/go/naming.ts +1 -1
  89. package/lib/eject-assets/generators/go/operations.ts +1 -1
  90. package/lib/eject-assets/generators/go/pagination.ts +1 -1
  91. package/lib/eject-assets/generators/go/types.ts +1 -1
  92. package/lib/eject-assets/generators/mock/faker.ts +17 -9
  93. package/lib/eject-assets/generators/mock/index.ts +4 -3
  94. package/lib/eject-assets/generators/mock/render.ts +128 -9
  95. package/lib/eject-assets/generators/mock/sample.ts +87 -4
  96. package/lib/eject-assets/generators/mock/values.ts +1 -1
  97. package/lib/eject-assets/generators/php/client.ts +1 -1
  98. package/lib/eject-assets/generators/php/descriptor.ts +10 -1
  99. package/lib/eject-assets/generators/php/index.ts +2 -2
  100. package/lib/eject-assets/generators/php/models.ts +8 -3
  101. package/lib/eject-assets/generators/php/naming.ts +1 -1
  102. package/lib/eject-assets/generators/php/operations.ts +11 -6
  103. package/lib/eject-assets/generators/php/pagination.ts +3 -2
  104. package/lib/eject-assets/generators/php/types.ts +12 -2
  105. package/lib/eject-assets/generators/python/client.ts +1 -1
  106. package/lib/eject-assets/generators/python/descriptor.ts +1 -1
  107. package/lib/eject-assets/generators/python/index.ts +3 -3
  108. package/lib/eject-assets/generators/python/models.ts +9 -3
  109. package/lib/eject-assets/generators/python/naming.ts +1 -1
  110. package/lib/eject-assets/generators/python/operations.ts +6 -5
  111. package/lib/eject-assets/generators/python/pagination.ts +1 -1
  112. package/lib/eject-assets/generators/python/types.ts +1 -1
  113. package/lib/eject-assets/generators/swr/index.ts +2 -2
  114. package/lib/eject-assets/generators/swr/render.ts +1 -1
  115. package/lib/eject-assets/generators/tanstack-query/index.ts +2 -2
  116. package/lib/eject-assets/generators/tanstack-query/render.ts +6 -5
  117. package/lib/eject-assets/generators/transformers/index.ts +2 -2
  118. package/lib/eject-assets/generators/transformers/render.ts +34 -7
  119. package/lib/eject-assets/generators/typescript/banner.ts +1 -1
  120. package/lib/eject-assets/generators/typescript/client.ts +1 -1
  121. package/lib/eject-assets/generators/typescript/descriptor.ts +1 -1
  122. package/lib/eject-assets/generators/typescript/index.ts +2 -2
  123. package/lib/eject-assets/generators/typescript/inline-runtime.ts +1 -1
  124. package/lib/eject-assets/generators/typescript/operation-signature.ts +1 -1
  125. package/lib/eject-assets/generators/typescript/operation-types.ts +1 -1
  126. package/lib/eject-assets/generators/typescript/operations.ts +1 -1
  127. package/lib/eject-assets/generators/typescript/response-headers.ts +1 -1
  128. package/lib/eject-assets/generators/typescript/type-guards.ts +1 -1
  129. package/lib/eject-assets/generators/typescript/types.ts +1 -1
  130. package/lib/eject-assets/generators/zod/index.ts +2 -2
  131. package/lib/eject-assets/generators/zod/schemas.ts +1 -1
  132. package/lib/eject-assets/skills/go-generator/SKILL.md +3 -0
  133. package/lib/eject-assets/skills/mock-generator/SKILL.md +22 -0
  134. package/lib/eject-assets/skills/php-generator/SKILL.md +9 -2
  135. package/lib/eject-assets/skills/python-generator/SKILL.md +6 -0
  136. package/lib/eject-assets/skills/tanstack-query-generator/SKILL.md +2 -1
  137. package/lib/eject-assets/skills/transformers-generator/SKILL.md +4 -0
  138. package/lib/eject-assets/skills/typescript-generator/SKILL.md +5 -0
  139. package/lib/index.js +37 -37
  140. package/lib/skills/redocly-cli/SKILL.md +20 -1
  141. package/package.json +1 -1
  142. package/lib/chunks/2Y7MGFQS.js +0 -105
  143. package/lib/chunks/AHEGLURA.js +0 -20
  144. package/lib/chunks/DQDJVO3X.js +0 -7
  145. package/lib/chunks/EK7EYCIE.js +0 -7
  146. package/lib/chunks/ERYWHU32.js +0 -19
  147. package/lib/chunks/GBN5W6T3.js +0 -9
  148. package/lib/chunks/GKXY6U4S.js +0 -145
  149. package/lib/chunks/HJWQEB7Y.js +0 -7
  150. package/lib/chunks/JKDUUCNL.js +0 -22
  151. package/lib/chunks/JM7BMZLD.js +0 -13
  152. package/lib/chunks/JUWXQD7B.js +0 -8
  153. package/lib/chunks/KGWCBODF.js +0 -7
  154. package/lib/chunks/LAML5K4D.js +0 -7
  155. package/lib/chunks/MOK3JA6R.js +0 -7
  156. package/lib/chunks/QKUESS2C.js +0 -20
  157. package/lib/chunks/RGVTUA3V.js +0 -7
  158. package/lib/chunks/RWKEGTOO.js +0 -7
  159. package/lib/chunks/S56YFLS5.js +0 -7
  160. package/lib/chunks/S6P42X5N.js +0 -20
  161. package/lib/chunks/UW4UC7ZI.js +0 -9
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: redocly-cli
3
- description: Redocly CLI for OpenAPI, AsyncAPI, Arazzo, and Overlay descriptions, and for Markdown docs. Use when the user wants to lint, bundle, split, or join an API description, apply decorators or overlays, build or preview API docs, lint Markdown or prose with recheck, test a live API with respect or Arazzo, capture traffic or check drift, get stats or a score, generate a TypeScript client, document an MCP server in an OpenAPI description, push to the Redocly platform, or find the node type a rule or plugin should target.
3
+ description: Redocly CLI for OpenAPI, AsyncAPI, Arazzo, and Overlay descriptions, and for Markdown docs. Use when the user wants to lint, bundle, split, or join an API description, apply decorators or overlays, build or preview API docs, lint Markdown or prose with recheck, test a live API with respect or Arazzo, capture traffic or check drift, get stats or a score, generate a TypeScript client, document an MCP server in an OpenAPI description, push to the Redocly platform, clone a Redocly-hosted project and open its pull requests, or find the node type a rule or plugin should target.
4
4
  ---
5
5
 
6
6
  # Redocly CLI usage
@@ -49,6 +49,9 @@ Install: `npm i @redocly/cli@latest`, or run without installing: `npx @redocly/c
49
49
  | `inspect-node-types` | Show the node type at a pointer, or list every node with its type [experimental] | Redocly configuration |
50
50
  | `push` | Push an API description to the Redocly platform | Platform |
51
51
  | `push-status` | Track an in-progress push to the platform | Platform |
52
+ | `project clone` | Clone a Redocly-hosted project as a Git repository [early access] | Platform |
53
+ | `project pr create` | Open a pull request for the current branch of a cloned project [early access] | Platform |
54
+ | `project pr status` | Show the state, review, checks, and preview URL of that pull request [early access] | Platform |
52
55
  | `skills` | Install the Redocly CLI agent skills into `.agents/skills/` and detected agent folders | Agent setup |
53
56
  | `completion` | Generate shell autocomplete commands | Shell setup |
54
57
 
@@ -181,6 +184,22 @@ With `apis.<name>.clientOutput` set, a bare `redocly generate-client` generates
181
184
  An API's own `client` block replaces the top-level one wholesale — repeat the shared fields in it.
182
185
  With `client.codeSamples: true`, it also writes `<output>.code-samples.yaml`, an overlay that adds `x-codeSamples`; add it to the API's `overlays` (or pass `--overlay`) so `bundle` puts the samples in the description.
183
186
 
187
+ ## Work on a Redocly-hosted project
188
+
189
+ After `redocly login`, `project clone <organization>/<project>` clones a project that the Redocly platform hosts.
190
+ The clone uses Redocly CLI as its Git credential helper, so `git pull` and `git push` work without a token.
191
+ The platform rejects pushes to the default branch: push another branch, then open a pull request for it:
192
+
193
+ ```bash
194
+ git push -u origin fix-typo
195
+ redocly project pr create --title "Fix a typo" --body-file - <<'BODY'
196
+ Fixes the install command in the quickstart.
197
+ BODY
198
+ ```
199
+
200
+ The command prints the pull request URL.
201
+ The platform builds a preview in a few minutes; `redocly project pr status` then shows the state, the review decision, the checks, and the preview URL after the preview is deployed.
202
+
184
203
  ## Test a live API
185
204
 
186
205
  `respect` 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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@redocly/cli",
3
- "version": "2.70.0",
3
+ "version": "2.71.1",
4
4
  "description": "",
5
5
  "license": "MIT",
6
6
  "type": "module",