@scalar/cli 1.8.1 → 1.8.3
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.
- package/README.md +28 -13
- package/docs.html +98 -66
- package/index.js +229 -195
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -167,21 +167,22 @@ Usage: scalar document [options] [command]
|
|
|
167
167
|
Manage local openapi file
|
|
168
168
|
|
|
169
169
|
Options:
|
|
170
|
-
-h, --help
|
|
170
|
+
-h, --help display help for command
|
|
171
171
|
|
|
172
172
|
Commands:
|
|
173
|
-
bundle [options] [file|url]
|
|
174
|
-
split [options] [file|url]
|
|
175
|
-
join [options] <files...>
|
|
176
|
-
format [options] [file|url]
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
173
|
+
bundle [options] [file|url] Bundle an OpenAPI specification by resolving all references and external dependencies
|
|
174
|
+
split [options] [file|url] Split your OpenAPI documents on small chunks
|
|
175
|
+
join [options] <files...> Merge multiple OpenAPI documents into a single unified document
|
|
176
|
+
format [options] [file|url] Format an OpenAPI file
|
|
177
|
+
markdown [options] [file|url] Generate Markdown from an OpenAPI file
|
|
178
|
+
mock [options] [file|url] Mock an API from an OpenAPI file
|
|
179
|
+
serve [options] [file|url] Serve an API Reference from an OpenAPI file
|
|
180
|
+
share [options] [file] Share an OpenAPI file
|
|
181
|
+
validate [file|url] Validate an OpenAPI file
|
|
182
|
+
void [options] Boot a server to mirror HTTP requests
|
|
183
|
+
lint [options] [file|url] Lint your OpenAPI file using spectral rules
|
|
184
|
+
upgrade [options] [file|url] Upgrade OpenAPI document to version 3.1
|
|
185
|
+
help [command] display help for command
|
|
185
186
|
```
|
|
186
187
|
|
|
187
188
|
#### bundle
|
|
@@ -244,6 +245,20 @@ Options:
|
|
|
244
245
|
-h, --help display help for command
|
|
245
246
|
```
|
|
246
247
|
|
|
248
|
+
#### markdown
|
|
249
|
+
```
|
|
250
|
+
Usage: scalar document markdown [options] [file|url]
|
|
251
|
+
|
|
252
|
+
Generate Markdown from an OpenAPI file
|
|
253
|
+
|
|
254
|
+
Arguments:
|
|
255
|
+
file|url OpenAPI file path or URL to convert
|
|
256
|
+
|
|
257
|
+
Options:
|
|
258
|
+
-o, --output <file> Output file (defaults to stdout)
|
|
259
|
+
-h, --help display help for command
|
|
260
|
+
```
|
|
261
|
+
|
|
247
262
|
#### mock
|
|
248
263
|
```
|
|
249
264
|
Usage: scalar document mock [options] [file|url]
|