Skip to content

docs: clean up stale rpk command overrides #1865

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
JakeSCahill merged 1 commit into from
Aug 3, 2026
Merged

docs: clean up stale rpk command overrides #1865

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
35 changes: 14 additions & 21 deletions docs-data/rpk-overrides.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1086,18 +1086,20 @@
},
"resources": {
"description": "Additional resource configuration files containing caches, rate limits, or other shared components."
},
"chilled": {
"description": "Continue to execute a config containing linter errors."
},
"watcher": {
"description": "EXPERIMENTAL: Watch config files for changes and automatically apply them."
},
"env-file": {
"description": "Import environment variables from a dotenv file."
},
"templates": {
"description": "EXPERIMENTAL: Import Redpanda Connect templates. This supports glob patterns (requires quotes)."
}
},
"content": [
{
"type": "section",
"id": "connect-flags",
"title": "Flags",
"position": "after_description",
"headingLevel": 2,
"content": "[cols=\"1m,1a,2a\"]\n|===\n|Value |Type |Description\n\n|--log.level |string |Override the configured log level. Acceptable values: `off`, `error`, `warn`, `info`, `debug`, `trace`.\n|--set |stringArray |Set a field (identified by a dot path) in the main configuration file. For example: `metrics.type=prometheus`.\n|--resources, -r |stringArray |Pull in extra resources from a file, which can be referenced the same as resources defined in the main config. This supports glob patterns (requires quotes).\n|--chilled |bool |Continue to execute a config containing linter errors (default: false).\n|--watcher, -w |bool |EXPERIMENTAL: Watch config files for changes and automatically apply them (default: false).\n|--env-file, -e |string |Import environment variables from a dotenv file.\n|--templates, -t |stringArray |EXPERIMENTAL: Import Redpanda Connect templates. This supports glob patterns (requires quotes).\n|==="
}
]
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
},
"rpk connect lint": {
"description": "Check a Redpanda Connect configuration file for syntax errors and potential issues without running it.",
Expand Down Expand Up @@ -3050,9 +3052,6 @@
"exclude": true,
"_note": "Command mentions \"coming soon\" and needs proper review before inclusion in docs"
},
"rpk ai llm": {
"appendToDescription": "\n\nSupported provider types: `openai`, `anthropic`, `google`, `bedrock`."
},
"rpk ai model": {
"appendToDescription": "\n\nThe catalog is read-only. The catalog is populated from each LLM provider's metadata plus any extras the operator has pinned to a tenant."
},
Expand All @@ -3076,9 +3075,6 @@
"rpk cluster config lint": {
"description": "Identify any Redpanda configuration properties that are not recognized. These may be properties that were valid in earlier versions of Redpanda but are now managed via the central configuration store."
},
"rpk cluster storage restore-start": {
"description": "Start a topic recovery operation from Tiered Storage. If the `--wait` (`-w`) flag is set, the command polls the status of the recovery process until it finishes."
},
"rpk cluster logdirs describe": {
"flags": {
"aggregate-into": {
Expand Down Expand Up @@ -3161,9 +3157,6 @@
"rpk connect install": {
"description": "Install Redpanda Connect. This command installs the latest version by default. Use the `--connect-version` flag to specify a version."
},
"rpk connect studio sync-schema": {
"description": "Synchronize the schema of a Redpanda Connect instance with a Redpanda Connect Studio session. This command ensures that your pipeline components are configured and linted correctly within Redpanda Connect Studio."
},
"rpk transform logs": {
"description": "View logs for a data transform. Streams STDOUT and STDERR output captured during runtime to your terminal."
},
Expand All @@ -3185,7 +3178,7 @@
"rpk ai agent stop": {
"description": "Stop a managed agent, setting its desired state to stopped."
},
"rpk ai llm check": {
"rpk ai llm-provider check": {
"description": "Run a lightweight probe against the configured LLM provider to verify credentials and reachability."
},
"rpk ai agent credential create": {
Expand Down
Loading