Skip to content
Back to search

orval

MarketplaceWorks with Claude CodeGitHub

Orval's official plugin for Claude Code

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/orval-labs/orval with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/orval-labs/orval'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/orval-labs--orval/badge.svg)](/listings/orval-labs--orval)

HTML

<a href="/listings/orval-labs--orval"><img src="/api/listings/orval-labs--orval/badge.svg" alt="findsafeskills safety rating" /></a>

Install

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json · Manifest · 11 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. {
  2. "name": "orval",
  3. "description": "Orval's official plugin for Claude Code",
  4. "plugins": {
  5. "orval": {
  6. "name": "orval",
  7. "source": "./skills/orval",
  8. "description": "Generate type-safe API clients, TanStack Query/SWR hooks, Zod schemas, MSW mocks, Hono server handlers, and MCP servers from OpenAPI specs"
  9. }
  10. }
  11. }
README.md · README · 195 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. [![npm version](https://badge.fury.io/js/orval.svg)](https://badge.fury.io/js/orval)
  2. ![NPM Downloads](https://img.shields.io/npm/dm/orval?color=purple)
  3. [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
  4. [![Gurubase](https://img.shields.io/badge/Gurubase-Ask%20Orval%20Guru-006BFF)](https://gurubase.io/g/orval)
  5. [![pkg.pr.new](https://pkg.pr.new/badge/orval-labs/orval)](https://pkg.pr.new/~/orval-labs/orval)
  6. <p align="center">
  7. <img src="./logo/orval-logo-horizontal.svg?raw=true" width="500" height="160" alt="orval - Restfull Client Generator" />
  8. </p>
  9. <h1 align="center">
  10. Generate Typescript clients from OpenAPI specification!
  11. </h1>
  12. ### Code Generation
  13. `orval` generates type-safe JS clients (TypeScript) from any valid OpenAPI v3 or Swagger v2 specification, either in `yaml` or `json` formats.
  14. > [!IMPORTANT]
  15. > Version [8.0.0+](https://orval.dev/docs/versions/v8) comes with a lot of improvements and changes please see the [Migration Guide](https://orval.dev/docs/versions/v8)
  16. ### Supported clients
  17. `generate` models, requests, hooks, [mocks](https://mswjs.io/) and more, for these supported clients:
  18. - [React](https://react.dev/)
  19. - [React Query](https://tanstack.com/query/latest/docs/framework/react/overview)
  20. - [React with swr](https://swr.vercel.app/)
  21. - [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview)
  22. - [Pinia Colada](https://pinia-colada.esm.dev/)
  23. - [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview)
  24. - [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview)
  25. - [SolidStart](https://start.solidjs.com/)
  26. - [Angular](https://angular.dev/)
  27. - [Angular Query](https://tanstack.com/query/latest/docs/framework/angular/overview)
  28. - [Hono](https://hono.dev/)
  29. - [zod](https://zod.dev/)
  30. - [Effect](https://effect.website/)
  31. - [Valibot](https://valibot.dev/)
  32. - [native fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
  33. - [mcp](https://modelcontextprotocol.io/introduction)
  34. ### Samples
  35. You can find some samples below:
  36. - [react app](https://github.com/orval-labs/orval/tree/master/samples/react-app)
  37. - [react query](https://github.com/orval-labs/orval/tree/master/samples/react-query)
  38. - [svelte query](https://github.com/orval-labs/orval/tree/master/samples/svelte-query)
  39. - [vue query](https://github.com/orval-labs/orval/tree/master/samples/vue-query)
  40. - [pinia colada](https://github.com/orval-labs/orval/tree/master/samples/pinia-colada)
  41. - [solid query](https://github.com/orval-labs/orval/tree/master/samples/solid-query)
  42. - [solid start](https://github.com/orval-labs/orval/tree/master/samples/solid-start)
  43. - [react app with swr](https://github.com/orval-labs/orval/tree/master/samples/react-app-with-swr)
  44. - [angular app](https://github.com/orval-labs/orval/tree/master/samples/angular-app)
  45. - [angular query](https://github.com/orval-labs/orval/tree/master/samples/angular-query)
  46. - [hono](https://github.com/orval-labs/orval/tree/master/samples/hono)
  47. - [swr with effect](https://github.com/orval-labs/orval/tree/master/samples/swr-with-effect)
  48. - [next app with fetch](https://github.com/orval-labs/orval/tree/master/samples/fetch-app/next-app-with-fetch)
  49. - [mcp server](https://github.com/orval-labs/orval/tree/master/samples/mcp)
  50. ### Playground
  51. Try Orval out for yourself using our [Playground](https://orval.dev/playground) application!
  52. ### Docker
  53. Orval 8+ requires Node.js 22.18 or newer. Projects on an older Node LTS can run code generation with the official Docker image.
  54. **Basic usage**
  55. ```bash
  56. # macOS / Linux
  57. docker run --rm -v "$(pwd):/app" -w /app ghcr.io/orval-labs/orval
  58. # Windows Git Bash
  59. MSYS_NO_PATHCONV=1 docker run --rm -v "$(pwd):/app" -w /app ghcr.io/orval-labs/orval
  60. # Windows CMD
  61. cd /d "C:\path\to\your-project"
  62. docker run --rm -v "%cd%:/app" -w /app ghcr.io/orval-labs/orval
  63. # Windows PowerShell
  64. cd "C:\path\to\your-project"
  65. docker run --rm -v "${PWD}:/app" -w /app ghcr.io/orval-labs/orval
  66. ```
  67. **Local API (`localhost` → `host.docker.internal`)**
  68. ```bash
  69. # macOS / Linux
  70. docker run --rm -v "$(pwd):/app" -w /app -e ORVAL_SWAGGER_URL="https://host.docker.internal:7142/swagger/v1/swagger.json" -e NODE_TLS_REJECT_UNAUTHORIZED=0 ghcr.io/orval-labs/orval --config ./orval.config.ts
  71. # Linux (native Docker)
  72. docker run --rm --add-host=host.docker.internal:host-gateway -v "$(pwd):/app" -w /app -e ORVAL_SWAGGER_URL="https://host.docker.internal:7142/swagger/v1/swagger.json" -e NODE_TLS_REJECT_UNAUTHORIZED=0 ghcr.io/orval-labs/orval --config ./orval.config.ts
  73. # Windows Git Bash
  74. MSYS_NO_PATHCONV=1 docker run --rm -v "$(pwd):/app" -w /app -e ORVAL_SWAGGER_URL="https://host.docker.internal:7142/swagger/v1/swagger.json" -e NODE_TLS_REJECT_UNAUTHORIZED=0 ghcr.io/orval-labs/orval --config ./orval.config.ts
  75. # Windows CMD
  76. cd /d "C:\path\to\your-project"
  77. docker run --rm -v "%cd%:/app" -w /app -e "ORVAL_SWAGGER_URL=https://host.docker.internal:7142/swagger/v1/swagger.json" -e "NODE_TLS_REJECT_UNAUTHORIZED=0" ghcr.io/orval-labs/orval --config ./orval.config.ts
  78. # Windows PowerShell
  79. cd "C:\path\to\your-project"
  80. docker run --rm -v "${PWD}:/app" -w /app -e ORVAL_SWAGGER_URL="https://host.docker.internal:7142/swagger/v1/swagger.json" -e NODE_TLS_REJECT_UNAUTHORIZED=0 ghcr.io/orval-labs/orval --config ./orval.config.ts
  81. ```
  82. Replace `ghcr.io/orval-labs/orval` with `orval:local` when testing locally before the official image is published. See the [installation docs](https://orval.dev/docs/installation#docker) for details.
  83. ## A note about AI
  84. First of all, we do not reject the use of AI agents outright. That said, please do not submit AI-generated output in a PR without reviewing it yourself. Every change must have a clear intent and purpose — do not submit changes you cannot explain in your own words. Making the effort to understand orval's codebase, TypeScript, and API clients beforehand, and reviewing what AI produces, is the contributor's responsibility, not the reviewer's. Finally, we will continue to welcome new contributors and actively support you through review and iteration.
  85. See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
  86. ## Developers
  87. This project uses [Bun](https://bun.sh/) for package management and building. Bun [install guide](https://bun.sh/docs/installation).
  88. ### Build Scripts
  89. - **`vp run nuke:all`** - Completely clean your workspace by removing all build artifacts, node_modules, and cached files. Use this when you want to start fresh.
  90. - **`vp run build`** - Build the project and make changes available to the workspace. Run this after making code changes to compile TypeScript and prepare the project for use.
  91. - **`vp run typecheck`** - Run TypeScript type checking across all packages.
  92. ### Test Scripts
  93. - **`vp run test`** - Run unit tests in all packages.
  94. - **`vp run update-samples`** - Generate sample outputs using the newly built version of Orval. This regenerates the sample code based on the current build.
  95. - **`vp run test:samples`** - Run tests in the samples directory using the newly generated output from `update-samples`.
  96. - **`vp run test:snapshots`** - Run snapshot tests to verify generated sample outputs match the committed snapshots. Fails if any generated file differs from its snapshot.
  97. - **`vp run test:snapshots:update`** - Regenerate snapshot files to match the current generated output. Run this after `vp run update-samples` when the generated output has intentionally changed.
  98. - **`vp run test:cli`** - Test that the generated output (not samples) is valid TypeScript. This validates the TypeScript compilation of the generated code.
  99. ### Development Workflow
  100. A typical development workflow would be:
  101. 1. Make your code changes
  102. 2. Run `vp run build` to compile your changes
  103. 3. Run `vp run typecheck` to verify package typings
  104. 4. Run `vp run lint` to catch lint issues early
  105. 5. Run `vp run test` to run unit tests in packages
  106. 6. Run `vp run test:snapshots` to verify generated output matches snapshots
  107. If step 6 fails because the generated output has intentionally changed, run `vp run test:snapshots:update` to update the snapshots.
  108. If you encounter issues or want to start completely fresh:
  109. 1. Run `vp run nuke:all` to clean everything
  110. 2. Reinstall dependencies and rebuild from scratch
  111. ## Sponsors
  112. Thank you to all our sponsors! 🍻
  113. Support orval development by [Open Collective](https://opencollective.com/orval) and your logo will be displayed here with a link to your website.
  114. <a href="https://opencollective.com/orval">
  115. <img src="https://orval.dev/images/orval-logo-horizontal.svg?raw=true" width="300" alt="Become a sponsor" />
  116. </a>
  117. ## Backers
  118. Thank you to all our backers! 🙏
  119. Support us with a one-time donation and help us continue our activities on [Open Collective](https://opencollective.com/orval).
  120. <a href="https://opencollective.com/orval">
  121. <img src="https://orval.dev/images/emblem.svg" width="50" height="50" alt="Backer" />
  122. </a>
  123. <a href="https://opencollective.com/orval">
  124. <img src="https://orval.dev/images/emblem.svg" width="50" height="50" alt="Backer" />
  125. </a>
  126. <a href="https://opencollective.com/orval">
  127. <img src="https://orval.dev/images/emblem.svg" width="50" height="50" alt="Backer" />
  128. </a>
  129. <a href="https://github.com/tatsuya-asami">
  130. <img src="https://github.com/tatsuya-asami.png" width="50" height="50" alt="tatsuya-asami" />
  131. </a>
  132. **Note:** After becoming a sponsor or backer, please contact us on [Discord](https://discord.gg/6fC2sjDU7w) to upload your logo.
  133. ### All Thanks To Our Contributors:
  134. <a href="https://github.com/orval-labs/orval/graphs/contributors">
  135. <img src="https://contrib.rocks/image?repo=anymaniax/orval" />
  136. </a>

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.