This repository was archived by the owner on May 22, 2025. It is now read-only.
- Notifications
You must be signed in to change notification settings - Fork0
Command-line interface to work with OpenAPI files
License
NotificationsYou must be signed in to change notification settings
scalar/cli
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
This repository was moved:https://www.npmjs.com/package/@scalar/cli
Command-line interface to work with OpenAPI files
- Format & validate OpenAPI files
- Upload your OpenAPI files to Scalar
- Get a fully mocked API for testing purposes
- Preview your API reference
- Bundle multiple OpenAPI files
npx @scalar/clihelpnpm install -g @scalar/cliscalar --version
scalar initscalar format openapi.jsonscalar validate openapi.jsonscalar bundle openapi.json --output bundle.jsonscalar reference openapi.json --watchscalar mock openapi.json --watchscalar share openapi.json
To validate your OpenAPI file in GitHub Actions, add this workflow:
# .github/workflows/validate-openapi-file.ymlname:Validate OpenAPI Fileon:push:branches: -mainpull_request:branches: -mainjobs:validate:runs-on:ubuntu-lateststeps: -uses:actions/checkout@v4 -name:Use Node.jsuses:actions/setup-node@v4with:node-version:20 -name:Validate OpenAPI File# Replace `./my-openapi-file.json` with the correct path and filename for your project.# Or: run `npx @scalar/cli init` and add the config file to your repository.run:npx @scalar/cli validate ./my-openapi-file.json
We are API nerds. You too? Let’s chat on Discord:https://discord.gg/8HeZcRGPFS
hanspagel | hwkr |
Contributions are welcome! ReadCONTRIBUTING.
The source code in this repository is licensed underMIT.
About
Command-line interface to work with OpenAPI files
Topics
Resources
License
Contributing
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.
Contributors4
Uh oh!
There was an error while loading.Please reload this page.
