Skip to content

docs: update rpk CLI documentation (v26.2.1) - #1873

Merged
JakeSCahill merged 1 commit into
mainfrom
rpk-docs-v26.2.1
Aug 3, 2026
Merged

docs: update rpk CLI documentation (v26.2.1)#1873
JakeSCahill merged 1 commit into
mainfrom
rpk-docs-v26.2.1

Conversation

@github-actions

@github-actions github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Automated update of rpk CLI documentation.

Version: v26.2.1
Diff against: v26.1.12

📝 Updated the What's new page (modules/get-started/pages/release-notes/redpanda.adoc) with the Redpanda CLI changes.

rpk Documentation Generation Summary

Version: v26.2.1

Generation Statistics

Metric Count
Commands documented 361
Files generated 355
Files skipped (excluded) 6

Changes from Previous Version

Change Type Count
New commands 53
Deprecated commands 1
Removed commands 21
New flags 23
Changed flag defaults 1
Changed flag descriptions 1
Changed command descriptions 35
Flag docs backfilled (not new flags) 50 commands
New Commands
  • rpk ai llm-provider
  • rpk ai llm-provider apply
  • rpk ai llm-provider check
  • rpk ai llm-provider create
  • rpk ai llm-provider delete
  • rpk ai llm-provider diff
  • rpk ai llm-provider get
  • rpk ai llm-provider list
  • rpk ai llm-provider update
  • rpk ai mcp-server
  • rpk ai mcp-server apply
  • rpk ai mcp-server create
  • rpk ai mcp-server delete
  • rpk ai mcp-server diff
  • rpk ai mcp-server get
  • rpk ai mcp-server list
  • rpk ai mcp-server tools
  • rpk ai mcp-server tools call
  • rpk ai mcp-server tools list
  • rpk ai mcp-server types
  • rpk ai mcp-server update
  • rpk ai oauth-client update
  • rpk ai policy
  • rpk ai policy apply
  • rpk ai policy create
  • rpk ai policy delete
  • rpk ai policy diff
  • rpk ai policy get
  • rpk ai policy list
  • rpk ai policy update
  • ... and 23 more (see the diff JSON in docs-data/)
Deprecated Commands
  • rpk redpanda admin — use rpk cluster subcommands; see rpk cluster brokers, rpk cluster info --detailed, rpk cluster config list --node-id, and rpk cluster loggers (hidden from help output)
Removed Commands
  • rpk ai llm
  • rpk ai llm apply
  • rpk ai llm check
  • rpk ai llm create
  • rpk ai llm delete
  • rpk ai llm diff
  • rpk ai llm get
  • rpk ai llm list
  • rpk ai llm update
  • rpk ai mcp
  • rpk ai mcp apply
  • rpk ai mcp create
  • rpk ai mcp delete
  • rpk ai mcp diff
  • rpk ai mcp get
  • rpk ai mcp list
  • rpk ai mcp tools
  • rpk ai mcp tools call
  • rpk ai mcp tools list
  • rpk ai mcp types
  • rpk ai mcp update
New Flags
  • rpk cloud auth list: --format (string)
  • rpk cluster config list: --node-id (int)
  • rpk cluster config status: --format (string)
  • rpk cluster info: --detailed (bool)
  • rpk cluster info: --include-decommissioned (bool)
  • rpk cluster logdirs describe: --format (string)
  • rpk cluster maintenance status: --format (string)
  • rpk cluster partitions balancer-status: --format (string)
  • rpk cluster partitions move-cancel: --format (string)
  • rpk cluster partitions move-status: --format (string)
  • rpk group delete: --format (string)
  • rpk group list: --format (string)
  • rpk group offset-delete: --format (string)
  • rpk group seek: --format (string)
  • rpk plugin list: --format (string)
  • rpk profile list: --format (string)
  • rpk security acl delete: --format (string)
  • rpk security secret list: --format (string)
  • rpk shadow describe: --print-role (bool)
  • rpk shadow status: --print-registry (bool)
  • rpk topic add-partitions: --format (string)
  • rpk topic alter-config: --format (string)
  • rpk topic delete: --format (string)
Changed Flag Defaults
  • rpk container start: --console-image default redpandadata/console:v3.7.1redpandadata/console:v3.8.0
Changed Command Descriptions
  • rpk ai agent a2a
  • rpk ai agent a2a card
  • rpk ai agent a2a task cancel
  • rpk ai agent apply
  • rpk ai agent credential create
  • rpk ai auth login
  • rpk ai auth logout
  • rpk ai auth status
  • rpk ai connection
  • rpk ai connection list
  • rpk ai connection revoke
  • rpk ai env delete
  • rpk ai env list
  • rpk ai env rename
  • rpk ai env use
  • rpk ai model
  • rpk ai oauth-client
  • rpk ai oauth-client apply
  • rpk ai oauth-client create
  • rpk ai oauth-client dcr
  • rpk ai oauth-client dcr iat
  • rpk ai oauth-client dcr iat revoke
  • rpk ai oauth-provider
  • rpk ai oauth-provider apply
  • rpk ai oauth-provider create
  • rpk ai run
  • rpk ai run claude
  • rpk ai run codex
  • rpk cluster config list
  • rpk cluster info
  • ... and 5 more (see the diff JSON in docs-data/)

Override Validation

⚠ 4 override entries did not apply (unknown command paths — stale entries in the overrides file):

  • Unknown command path: "rpk ai llm"
    Did you mean one of: rpk, rpk ai, rpk ai agent?
  • Unknown command path: "rpk cluster storage restore-start"
    Did you mean one of: rpk, rpk ai, rpk ai agent?
  • Unknown command path: "rpk connect studio sync-schema"
    Did you mean one of: rpk, rpk ai, rpk ai agent?
  • Unknown command path: "rpk ai llm check"
    Did you mean one of: rpk, rpk ai, rpk ai agent?

Curated descriptions replacing source help

These overrides replace substantially longer help text from the rpk source. Confirm the curated version still carries every operational detail (or intentionally omits it):

Command Override Source help
rpk topic consume 159 chars 9372 chars
rpk topic produce 137 chars 6181 chars
rpk security acl 126 chars 5912 chars
rpk debug bundle 244 chars 3442 chars
rpk group 91 chars 2321 chars
rpk transform logs 106 chars 2123 chars
rpk cluster self-test start 71 chars 2071 chars
rpk cluster partitions list 177 chars 1650 chars
rpk generate app 105 chars 1446 chars
rpk topic describe-storage 132 chars 1418 chars
rpk profile prompt 598 chars 1665 chars
rpk cluster maintenance status 251 chars 1264 chars
rpk topic trim-prefix 258 chars 1213 chars
rpk cluster config 94 chars 991 chars
rpk cluster maintenance 97 chars 983 chars
... and 12 more

Validation Report

✅ All files passed validation.

Generated by rpk-docs automation

Automation

Generated by rpk-docs automation.

Review the changes and merge when ready.

@github-actions
github-actions Bot requested a review from a team as a code owner August 3, 2026 06:41
@github-actions github-actions Bot added automated documentation Improvements or additions to documentation labels Aug 3, 2026

@JakeSCahill JakeSCahill left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified against the train's gates before merging:

  • Michele's gate: the new rpk-v26.2.1.json snapshot carries 15 extracted rpk connect run flags (connect 4.103.1), plus plugin_versions for all three plugins — so post-merge, from-json rerenders (#1863) keep the Flags table when #1865 drops the curated one.
  • #226 in production: iotune carries platforms: [linux] in the tree itself — static detection worked on the runner, no longer rescued by overrides.
  • #238 in production: the What's-new block has zero rpk ai mentions, 47 Self-Managed bullets.
  • rpk connect run renders exactly one Flags section. Checks green.

One known transitional artifact: the ai partials' example blocks render rpai instead of rpk ai because main doesn't carry the applyToCode transformation rule yet — that ships in #1860, and the post-#1862 auto-rerender corrects the blocks. Supersedes #1845 (closed).

@netlify

netlify Bot commented Aug 3, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit ffe578f
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a703829928d840008cc26aa
😎 Deploy Preview https://deploy-preview-1873--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automated documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant