Skip to content
This repository has been archived by the owner on Mar 19, 2024. It is now read-only.

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hanspagel committed Jan 29, 2024
1 parent cddfac5 commit 02c5188
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,23 @@ Otherwise just prefix all commands with `npx @scalar/cli` instead of `scalar`. T
The given JSON file will be formatted with Prettier.

```bash
scalar format openapi.json
scalar format
```

### validate

To check whether your OpenAPI file adheres to the Swagger 2.0, OpenAPI 3.0 or OpenAPI 3.1 specification, run the following command:

```bash
scalar validate openapi.json
scalar validate
```

### share

To quickly share an OpenAPI file or reference with someone, you can use the share command:

```bash
scalar share openapi.json
scalar share
```

This will upload your OpenAPI file to the [Scalar Sandbox](https://sandbox.scalar.com/) to give you a public reference URL and a public URL to your OpenAPI JSON file.
Expand All @@ -45,7 +45,7 @@ This will upload your OpenAPI file to the [Scalar Sandbox](https://sandbox.scala
We can even mock your API, and it’s just one command:

```bash
scalar mock openapi.json
scalar mock
```

This will boot up a server on port 3000 which gives you an API returning the dummy data according to your schema.
Expand Down

0 comments on commit 02c5188

Please sign in to comment.