LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-09 20:57:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

sync: Synced local 'docs/' with remote 'docs/cli/'

Browse Source
This commit is contained in:
redocly-bot
2022-05-04 19:32:45 +00:00
parent d7ed5092e8
commit f4db5622b3
8 changed files with 290 additions and 306 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/commands/lint.md
View File

@@ -95,7 +95,7 @@ If you try to execute the `lint` command without entrypoints when your project d
### Custom configuration file
By default, the CLI tool looks for the [Redocly configuration file](/docs/cli/configuration/configuration-file.mdx) in the current working directory. Use the optional `--config` argument to provide an alternative path to a configuration file.
By default, the CLI tool looks for the [Redocly configuration file](/docs/cli/configuration/index.mdx) in the current working directory. Use the optional `--config` argument to provide an alternative path to a configuration file.
```bash
openapi lint --config=./another/directory/config.yaml

2
docs/commands/login.md
View File

@@ -32,7 +32,7 @@ Option | Type | Description
--help | boolean | Show help.
--verbose | boolean | Include additional output.
--version | boolean | Show version number.
--region, -r | string | Specify which region to use when logging in. Supported values: `us`, `eu`. Read more about [configuring the region](../configuration/configuration-file.mdx#region).
--region, -r | string | Specify which region to use when logging in. Supported values: `us`, `eu`. Read more about [configuring the region](../configuration/index.mdx#region).
## Examples

2
docs/commands/preview-docs.md
View File

@@ -66,7 +66,7 @@ In this case, after resolving the path behind the `core@v1` name (see the `Confi
### Custom configuration file
By default, the CLI tool looks for the [Redocly configuration file](/docs/cli/configuration/configuration-file.mdx) in the current working directory. Use the optional `--config` argument to provide an alternative path to a configuration file.
By default, the CLI tool looks for the [Redocly configuration file](/docs/cli/configuration/index.mdx) in the current working directory. Use the optional `--config` argument to provide an alternative path to a configuration file.
```bash
openapi preview-docs --config=./another/directory/config.yaml

6
docs/commands/push.md
View File

@@ -13,7 +13,7 @@ This allows you to:
Apart from uploading your API definition file, the `push` command can automatically upload other files if they are detected or referenced in the API definition:
- the [Redocly configuration file](/docs/cli/configuration/configuration-file.mdx).
- the [Redocly configuration file](/docs/cli/configuration/index.mdx).
- the `package.json` file (if it exists) from the folder where you're executing the `push` command. Redocly Workflows will use the `@redocly/openapi-cli` version specified in `package.json`.
- the HTML template and the full contents of the folder specified as the `features.openapi > htmlTemplate` parameter in the Redocly configuration file.
@@ -77,7 +77,7 @@ openapi push [-u] [--run-id id] <path/to/definition.yaml> <@organization-id/api-
## Options
Option | Type | Description |
-----------------|:---------:|:------------:|
-----------------|:---------:|------------|
entrypoint | string | The API definition that you want to push to the Redocly API registry. Provide it as a path to the root API definition file (or as an alias). See [Set options explicitly](#set-options-explicitly) for more information. |
destination | string | Conditional. The location in the API registry where you want to push or upsert your API definition. Provide it in the following format: `@organization-id/api-name@api-version` or `api-name@api-version`if organization ID is already defined in the configuration file. See [the Destination section](#destination) for more information. |
--branch, -b | string | The branch where your API definition will be pushed or upserted. Default value is `main`. |
@@ -86,7 +86,7 @@ destination | string | Conditional. The location in the API registry whe
--skip-decorator | [string] | Ignore one or more decorators. See the [Skip decorator section](#skip-decorator) for usage examples.
--upsert, -u | boolean | Upsert an API to the API registry. See [the Upsert an API with push section](#upsert-an-api-with-push) for more information. |
--version | boolean | Show version number. |
--region,-r | string | Specify which region to use when logging in. Supported values: `us`, `eu`. Default value is `us`. Read more about [configuring the region](../configuration/configuration-file.mdx#region).
--region,-r | string | Specify which region to use when logging in. Supported values: `us`, `eu`. The `eu` region is limited to enterprise customers. Default value is `us`. Read more about [configuring the region](../configuration/index.mdx#region).
## Examples

16
docs/commands/stats.md
View File

@@ -23,13 +23,13 @@ openapi stats --version
## Options
Option | Type | Required | Default | Description
--------------------------|:---------:|:------------:|:-----------:|------------
`entrypoint` | `string` | yes | - | Path to the API definition filename that you want to calculate statistics for. Instead of full paths, you can use names listed in the `apis` section of your Redocly configuration file as entrypoints. Refer to [the entrypoint section below](#entrypoint) for more options.
`--config` | `string` | no | - | Specify path to the [configuration file](#custom-configuration-file)
`--format` | `string` | no | `stylish` | Format for the output.<br />**Possible values:** `stylish`, `json`
`--help` | `boolean` | no | - | Show help
`--version` | `boolean` | no | - | Show version number
Option | Type | Description
-- | -- | --
entrypoint | string | **REQUIRED.** Path to the API definition file that you want to split into a multi-file structure.
--config | string | Specify path to the [configuration file](#custom-configuration-file).
--format | string | Format for the output.<br />**Possible values:** `stylish`, `json`.
--help | boolean | Show help.
--version | boolean | Show version number.
## Examples
@@ -64,7 +64,7 @@ In this case, after resolving the path behind the `core@v1` name (see the `Confi
### Custom configuration file
By default, the CLI tool looks for the [Redocly configuration file](/docs/cli/configuration/configuration-file.mdx) in the current working directory. Use the optional `--config` argument to provide an alternative path to a configuration file.
By default, the CLI tool looks for the [Redocly configuration file](/docs/cli/configuration/index.mdx) in the current working directory. Use the optional `--config` argument to provide an alternative path to a configuration file.
```bash
openapi stats --config=./another/directory/config.yaml