Skip to content

feat(cli): add environment variable support for CLI commands #2158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DmitryAnansky merged 1 commit into from
Jul 4, 2025
Merged

feat(cli): add environment variable support for CLI commands #2158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/clean-grapes-sleep.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@redocly/cli": minor
---

Added environment variable support for CLI arguments using Yargs `.env()` method to parse environment variables with matching prefixes.
154 changes: 83 additions & 71 deletions packages/cli/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,19 +43,22 @@ yargs(hideBin(process.argv))
'stats [api]',
'Show statistics for an API description.',
(yargs) =>
yargs.positional('api', { type: 'string' }).option({
config: { description: 'Path to the config file.', type: 'string' },
'lint-config': {
description: 'Severity level for config file linting.',
choices: ['warn', 'error', 'off'] as ReadonlyArray<RuleSeverity>,
default: 'warn' as RuleSeverity,
},
format: {
description: 'Use a specific output format.',
choices: ['stylish', 'json', 'markdown'] as ReadonlyArray<OutputFormat>,
default: 'stylish' as OutputFormat,
},
}),
yargs
.env('REDOCLY_CLI_STATS')
.positional('api', { type: 'string' })
.option({
config: { description: 'Path to the config file.', type: 'string' },
'lint-config': {
description: 'Severity level for config file linting.',
choices: ['warn', 'error', 'off'] as ReadonlyArray<RuleSeverity>,
default: 'warn' as RuleSeverity,
},
format: {
description: 'Use a specific output format.',
choices: ['stylish', 'json', 'markdown'] as ReadonlyArray<OutputFormat>,
default: 'stylish' as OutputFormat,
},
}),
(argv) => {
process.env.REDOCLY_CLI_COMMAND = 'stats';
commandWrapper(handleStats)(argv);
Expand All @@ -66,6 +69,7 @@ yargs(hideBin(process.argv))
'Split an API description into a multi-file structure.',
(yargs) =>
yargs
.env('REDOCLY_CLI_SPLIT')
.positional('api', {
description: 'API description file that you want to split',
type: 'string',
Expand Down Expand Up @@ -104,6 +108,7 @@ yargs(hideBin(process.argv))
'Join multiple API descriptions into one [experimental].',
(yargs) =>
yargs
.env('REDOCLY_CLI_JOIN')
.positional('apis', {
array: true,
type: 'string',
Expand Down Expand Up @@ -154,6 +159,7 @@ yargs(hideBin(process.argv))
false,
(yargs) =>
yargs
.env('REDOCLY_CLI_PUSH_STATUS')
.positional('pushId', {
description: 'Push id.',
type: 'string',
Expand Down Expand Up @@ -205,6 +211,7 @@ yargs(hideBin(process.argv))
'Push documents to Reunite.',
(yargs) =>
yargs
.env('REDOCLY_CLI_PUSH')
.positional('files', {
type: 'string',
array: true,
Expand Down Expand Up @@ -313,59 +320,61 @@ yargs(hideBin(process.argv))
'lint [apis...]',
'Lint an API or Arazzo description.',
(yargs) =>
yargs.positional('apis', { array: true, type: 'string', demandOption: true }).option({
format: {
description: 'Use a specific output format.',
choices: [
'stylish',
'codeframe',
'json',
'checkstyle',
'codeclimate',
'summary',
'markdown',
'github-actions',
] as ReadonlyArray<OutputFormat>,
default: 'codeframe' as OutputFormat,
},
'max-problems': {
requiresArg: true,
description: 'Reduce output to a maximum of N problems.',
type: 'number',
default: 100,
coerce: validatePositiveNumber('max-problems', true),
},
'generate-ignore-file': {
description: 'Generate an ignore file.',
type: 'boolean',
},
'skip-rule': {
description: 'Ignore certain rules.',
array: true,
type: 'string',
},
'skip-preprocessor': {
description: 'Ignore certain preprocessors.',
array: true,
type: 'string',
},
'lint-config': {
description: 'Severity level for config file linting.',
choices: ['warn', 'error', 'off'] as ReadonlyArray<RuleSeverity>,
default: 'warn' as RuleSeverity,
},
config: {
description: 'Path to the config file.',
requiresArg: true,
type: 'string',
},
extends: {
description: 'Override extends configurations (defaults or config file settings).',
requiresArg: true,
array: true,
type: 'string',
},
}),
yargs
.env('REDOCLY_CLI_LINT')
.positional('apis', { array: true, type: 'string', demandOption: true })
.option({
format: {
description: 'Use a specific output format.',
choices: [
'stylish',
'codeframe',
'json',
'checkstyle',
'codeclimate',
'summary',
'markdown',
'github-actions',
] as ReadonlyArray<OutputFormat>,
default: 'codeframe' as OutputFormat,
},
'max-problems': {
requiresArg: true,
description: 'Reduce output to a maximum of N problems.',
type: 'number',
default: 100,
},
'generate-ignore-file': {
description: 'Generate an ignore file.',
type: 'boolean',
},
'skip-rule': {
description: 'Ignore certain rules.',
array: true,
type: 'string',
},
'skip-preprocessor': {
description: 'Ignore certain preprocessors.',
array: true,
type: 'string',
},
'lint-config': {
description: 'Severity level for config file linting.',
choices: ['warn', 'error', 'off'] as ReadonlyArray<RuleSeverity>,
default: 'warn' as RuleSeverity,
},
config: {
description: 'Path to the config file.',
requiresArg: true,
type: 'string',
},
extends: {
description: 'Override extends configurations (defaults or config file settings).',
requiresArg: true,
array: true,
type: 'string',
},
}),
(argv) => {
process.env.REDOCLY_CLI_COMMAND = 'lint';
commandWrapper(handleLint)(argv);
Expand All @@ -376,6 +385,7 @@ yargs(hideBin(process.argv))
'Bundle a multi-file API description to a single file.',
(yargs) =>
yargs
.env('REDOCLY_CLI_BUNDLE')
.positional('apis', { array: true, type: 'string', demandOption: true })
.options({
output: {
Expand Down Expand Up @@ -453,7 +463,7 @@ yargs(hideBin(process.argv))
'check-config',
'Lint the Redocly configuration file.',
async (yargs) =>
yargs.option({
yargs.env('REDOCLY_CLI_CHECK_CONFIG').option({
config: {
description: 'Path to the config file.',
type: 'string',
Expand All @@ -473,7 +483,7 @@ yargs(hideBin(process.argv))
'login',
'Log in to Redocly.',
async (yargs) =>
yargs.options({
yargs.env('REDOCLY_CLI_LOGIN').options({
residency: {
description: 'Residency of the application. Defaults to `us`.',
alias: ['r'],
Expand Down Expand Up @@ -503,7 +513,7 @@ yargs(hideBin(process.argv))
'preview',
'Preview Redocly project using one of the product NPM packages.',
(yargs) =>
yargs.options({
yargs.env('REDOCLY_CLI_PREVIEW').options({
product: {
type: 'string',
choices: ['redoc', 'revel', 'reef', 'realm', 'redoc-revel', 'redoc-reef', 'revel-reef'],
Expand Down Expand Up @@ -605,6 +615,7 @@ yargs(hideBin(process.argv))
'Creates or updates translations.yaml files and fills them with missing built-in translations and translations from the redocly.yaml and sidebars.yaml files.',
(yargs) =>
yargs
.env('REDOCLY_CLI_TRANSLATE')
.positional('locale', {
description:
'Locale code to generate translations for, or `all` for all current project locales.',
Expand Down Expand Up @@ -635,6 +646,7 @@ yargs(hideBin(process.argv))
'Helper function to eject project elements for customization.',
(yargs) =>
yargs
.env('REDOCLY_CLI_EJECT')
.positional('type', {
description:
'Specifies what type of project element to eject. Currently this value must be `component`.',
Expand Down Expand Up @@ -675,13 +687,13 @@ yargs(hideBin(process.argv))
'Run Arazzo tests.',
(yargs) => {
return yargs
.env('REDOCLY_CLI_RESPECT')
.positional('files', {
describe: 'Test files or glob pattern.',
type: 'string',
array: true,
default: [],
})
.env('REDOCLY_CLI_RESPECT')
.options({
input: {
alias: 'i',
Expand Down Expand Up @@ -769,11 +781,11 @@ yargs(hideBin(process.argv))
'Auto-generate arazzo description file from an API description.',
(yargs) => {
return yargs
.env('REDOCLY_CLI_GENERATE_ARAZZO')
.positional('descriptionPath', {
describe: 'Description file path.',
type: 'string',
})
.env('REDOCLY_CLI_RESPECT')
.options({
'output-file': {
alias: 'o',
Expand Down
Loading