@scalar/cli 0.1.0 → 0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Scalar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,7 +1,28 @@
 # Scalar CLI
 
-> [!CAUTION]
-> WIP, not published yet
+[![Version](https://img.shields.io/npm/v/%40scalar/cli)](https://www.npmjs.com/package/@scalar/cli)
+[![Downloads](https://img.shields.io/npm/dm/%40scalar/cli)](https://www.npmjs.com/package/@scalar/cli)
+[![Hits on jsdelivr](https://img.shields.io/jsdelivr/npm/hm/%40scalar%2Fapi-reference)](https://www.jsdelivr.com/package/npm/@scalar/cli)
+[![License](https://img.shields.io/npm/l/%40scalar%2Fapi-reference)](https://www.npmjs.com/package/@scalar/cli)
+[![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/8HeZcRGPFS)
+
+Command-line interface to work with OpenAPI files
+
+![Demo Video](https://github.com/scalar/cli/assets/6374090/ebd02178-503d-4a70-b292-a52a74b35008)
+
+## Features
+
+- 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
+
+## Quickstart
+
+```bash
+npx @scalar/cli help
+```
 
 ## Installation
 
@@ -20,7 +41,7 @@ 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
@@ -28,7 +49,7 @@ scalar format openapi.json
 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
@@ -36,7 +57,7 @@ scalar validate openapi.json
 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.
@@ -46,7 +67,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.
@@ -63,6 +84,16 @@ You can also change the port like this:
 scalar mock openapi.json --watch --port 8080
 ```
 
+### bundle
+
+Some OpenAPI files reference other files from the file system or an URL. You can bundle those files and make them a single file:
+
+```bash
+scalar bundle openapi.json --output bundle.json
+```
+
+If you don’t provide an `output` file name, the input file will be overwritten.
+
 ### init
 
 If you’re tired of passing the file name again and again, just configure it once:
@@ -71,7 +102,7 @@ If you’re tired of passing the file name again and again, just configure it on
 scalar init
 ```
 
-This will create a `scalar.toml` file for you. All commands will use the configured OpenAPI file by default.
+This will create a `scalar.config.json` file for you. All commands will use the configured OpenAPI file by default.
 
 ## Options
 
@@ -89,6 +120,38 @@ scalar --version
 scalar --help
 ```
 
+## GitHub Actions
+
+To validate your OpenAPI file in GitHub Actions, add this workflow:
+
+```yml
+# .github/workflows/validate-openapi-file.yml
+name: Validate OpenAPI File
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          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
+```
+
 ## Development
 
 Set up the development environment: