From 12246d64507ea0d78b4e9ad31c8d700dc6077d16 Mon Sep 17 00:00:00 2001 From: Joyce Fee Date: Thu, 25 Jun 2026 15:15:32 -0400 Subject: [PATCH] docs(rpk-ai): add 34 beta rpk-ai command pages and wire into nav The rpk-ai reference covered 40 commands; the current rpai plugin exposes 34 more (agent a2a/apply/create/credential/delete/diff/get/start/stop/transcript/ update, llm check, oauth-client dcr + dcr iat, oauth-client revoke-tokens, run claude/codex). Per the ADP writer these are beta and should be documented under the beta badge. - Add the 34 pages, generated from the current rpk-docs generator (rpk dev + ai plugin via `--print-tree`), each carrying `:page-beta: true` so they render with the beta badge like the existing rpk-ai pages. - Rebuild the rpk-ai nav block in modules/ROOT/nav.adoc from the authoritative command tree (74 entries, correct nesting incl. hyphenated commands like `oauth-client` and deep paths like `oauth-client dcr iat mint`). Verified: every nav entry maps to a page and every page has a nav entry; no orphans/missing; pipe-bearing flag enums are escaped (`{vbar}`). Co-Authored-By: Claude Opus 4.8 (1M context) --- modules/ROOT/nav.adoc | 34 +++++ .../rpk/rpk-ai/rpk-ai-agent-a2a-card.adoc | 40 ++++++ .../rpk/rpk-ai/rpk-ai-agent-a2a-send.adoc | 121 +++++++++++++++++ .../rpk-ai/rpk-ai-agent-a2a-task-cancel.adoc | 45 ++++++ .../rpk/rpk-ai/rpk-ai-agent-a2a-task-get.adoc | 49 +++++++ .../rpk-ai/rpk-ai-agent-a2a-task-watch.adoc | 54 ++++++++ .../rpk/rpk-ai/rpk-ai-agent-a2a-task.adoc | 56 ++++++++ .../pages/rpk/rpk-ai/rpk-ai-agent-a2a.adoc | 128 ++++++++++++++++++ .../pages/rpk/rpk-ai/rpk-ai-agent-apply.adoc | 46 +++++++ .../pages/rpk/rpk-ai/rpk-ai-agent-create.adoc | 37 +++++ .../rpk-ai-agent-credential-create.adoc | 37 +++++ .../rpk-ai-agent-credential-delete.adoc | 37 +++++ .../rpk-ai/rpk-ai-agent-credential-list.adoc | 37 +++++ .../rpk/rpk-ai/rpk-ai-agent-credential.adoc | 54 ++++++++ .../pages/rpk/rpk-ai/rpk-ai-agent-delete.adoc | 37 +++++ .../pages/rpk/rpk-ai/rpk-ai-agent-diff.adoc | 39 ++++++ .../pages/rpk/rpk-ai/rpk-ai-agent-get.adoc | 37 +++++ .../pages/rpk/rpk-ai/rpk-ai-agent-start.adoc | 37 +++++ .../pages/rpk/rpk-ai/rpk-ai-agent-stop.adoc | 37 +++++ .../rpk-ai/rpk-ai-agent-transcript-get.adoc | 37 +++++ .../rpk-ai/rpk-ai-agent-transcript-list.adoc | 37 +++++ .../rpk/rpk-ai/rpk-ai-agent-transcript.adoc | 51 +++++++ .../pages/rpk/rpk-ai/rpk-ai-agent-update.adoc | 37 +++++ .../pages/rpk/rpk-ai/rpk-ai-llm-check.adoc | 37 +++++ .../rpk-ai/rpk-ai-oauth-client-dcr-get.adoc | 37 +++++ .../rpk-ai-oauth-client-dcr-iat-list.adoc | 37 +++++ .../rpk-ai-oauth-client-dcr-iat-mint.adoc | 37 +++++ .../rpk-ai-oauth-client-dcr-iat-revoke.adoc | 39 ++++++ .../rpk-ai/rpk-ai-oauth-client-dcr-iat.adoc | 57 ++++++++ .../rpk-ai-oauth-client-dcr-update.adoc | 51 +++++++ .../rpk/rpk-ai/rpk-ai-oauth-client-dcr.adoc | 70 ++++++++++ .../rpk-ai-oauth-client-revoke-tokens.adoc | 42 ++++++ .../pages/rpk/rpk-ai/rpk-ai-run-claude.adoc | 73 ++++++++++ .../pages/rpk/rpk-ai/rpk-ai-run-codex.adoc | 53 ++++++++ .../pages/rpk/rpk-ai/rpk-ai-run.adoc | 53 ++++++++ 35 files changed, 1710 insertions(+) create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-card.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-send.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task-cancel.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task-get.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task-watch.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-apply.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-create.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential-create.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential-delete.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential-list.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-delete.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-diff.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-get.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-start.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-stop.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-transcript-get.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-transcript-list.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-transcript.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-update.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-check.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-get.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-list.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-mint.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-revoke.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-update.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-revoke-tokens.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-run-claude.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-run-codex.adoc create mode 100644 modules/reference/pages/rpk/rpk-ai/rpk-ai-run.adoc diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 31bb54e..e103c33 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -78,12 +78,35 @@ ** xref:reference:rpk/index.adoc[rpk Command Reference] *** xref:reference:rpk/rpk-ai/rpk-ai.adoc[rpk ai] **** xref:reference:rpk/rpk-ai/rpk-ai-agent.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a.adoc[] +****** xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-card.adoc[] +****** xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-send.adoc[] +****** xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-task.adoc[] +******* xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-task-cancel.adoc[] +******* xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-task-get.adoc[] +******* xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-task-watch.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-agent-apply.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-agent-create.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-agent-credential.adoc[] +****** xref:reference:rpk/rpk-ai/rpk-ai-agent-credential-create.adoc[] +****** xref:reference:rpk/rpk-ai/rpk-ai-agent-credential-delete.adoc[] +****** xref:reference:rpk/rpk-ai/rpk-ai-agent-credential-list.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-agent-delete.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-agent-diff.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-agent-get.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-agent-list.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-agent-start.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-agent-stop.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-agent-transcript.adoc[] +****** xref:reference:rpk/rpk-ai/rpk-ai-agent-transcript-get.adoc[] +****** xref:reference:rpk/rpk-ai/rpk-ai-agent-transcript-list.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-agent-update.adoc[] **** xref:reference:rpk/rpk-ai/rpk-ai-connection.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-connection-list.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-connection-revoke.adoc[] **** xref:reference:rpk/rpk-ai/rpk-ai-install.adoc[] **** xref:reference:rpk/rpk-ai/rpk-ai-llm.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-llm-check.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-llm-create.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-llm-delete.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-llm-get.adoc[] @@ -110,9 +133,20 @@ ***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-update.adoc[] **** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-create.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr.adoc[] +****** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-get.adoc[] +****** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat.adoc[] +******* xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-list.adoc[] +******* xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-mint.adoc[] +******* xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-revoke.adoc[] +****** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-update.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-delete.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-get.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-list.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-revoke-tokens.adoc[] +**** xref:reference:rpk/rpk-ai/rpk-ai-run.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-run-claude.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-run-codex.adoc[] **** xref:reference:rpk/rpk-ai/rpk-ai-uninstall.adoc[] **** xref:reference:rpk/rpk-ai/rpk-ai-upgrade.adoc[] **** xref:reference:rpk/rpk-ai/rpk-ai-version.adoc[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-card.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-card.adoc new file mode 100644 index 0000000..a3ad0e0 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-card.adoc @@ -0,0 +1,40 @@ += rpk ai agent a2a card +:description: pass:q[Fetch the A2A agent card — the JSON discovery document describing the agent's identity, skills, supported transports and capabilities. Use `-o` json to feed the raw card to other tools.] +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Fetch the A2A agent card — the JSON discovery document describing the +agent's identity, skills, supported transports and capabilities. + +Use `-o` json to feed the raw card to other tools. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent a2a card [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-send.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-send.adoc new file mode 100644 index 0000000..9fd1aff --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-send.adoc @@ -0,0 +1,121 @@ += rpk ai agent a2a send +:description: Send a text message to an agent over A2A and print the reply. The message comes from the positional argument, or from stdin when the argument is omitted or "-" (so you can pipe a prompt in). +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Send a text message to an agent over A2A and print the reply. + +The message comes from the positional argument, or from stdin when the +argument is omitted or "-" (so you can pipe a prompt in). + +By default the call blocks until the agent replies. Replies that spawn a +long-running task print the task id so you can follow up with +`rpai agent a2a task get|watch|cancel`. For work that may outlive +`--timeout` (default 5m), prefer `--stream` or `--no-block` so the task id is +in hand from the start. + +Conversation state: every reply prints a context-id (stderr in the +default format, part of the JSON in `-o` json). Pass it back via +`--context-id` to continue the same conversation. When a task ends in +state input-required, answer it by sending again with both `--task-id` +and `--context-id` from the reply. + +Output: the agent's reply text goes to stdout; ids and state go to +stderr as `key: value` lines so pipes stay clean. Use `-o` json for the +full A2A response (message or task object). With `--stream`, json and +yaml both emit one JSON event per line (JSONL). + +Exit codes: 0 success or input-required, 4 task failed/canceled/ +rejected, 1 anything else. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent a2a send [flags] +---- + + + + +== Examples + +This section provides examples of how to use `rpk ai agent a2a send`. + +# Ask and wait for the answer + +[,bash] +---- +rpai agent a2a send financial-advisor "What moved the S&P 500 today?" +---- + + +[,bash] +---- +# Continue the conversation from a previous reply's context-id +---- +[,bash] +---- +rpai agent a2a send financial-advisor --context-id CTX "Why?" +---- + + +[,bash] +---- +# Answer a task that ended in input-required +---- +[,bash] +---- +rpai agent a2a send financial-advisor --task-id TASK --context-id CTX "Account A-17" +---- + + +[,bash] +---- +# Pipe the prompt from a file, get the full JSON reply +---- +[,bash] +---- +cat prompt.txt | rpai agent a2a send financial-advisor -o json +---- + + +[,bash] +---- +# Stream events as they happen +---- +[,bash] +---- +rpai agent a2a send financial-advisor --stream "Give me a market summary" +---- + + +[,bash] +---- +# Fire-and-forget: submit, then poll with `task get` +---- +[,bash] +---- +rpai agent a2a send financial-advisor --no-block "Deep analysis please" +---- + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task-cancel.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task-cancel.adoc new file mode 100644 index 0000000..f87a852 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task-cancel.adoc @@ -0,0 +1,45 @@ += rpk ai agent a2a task cancel +:description: Ask the agent to cancel a running task and print the task's resulting state. Cancellation is cooperative — the agent may already have finished, in which case the terminal state is returned unchanged. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Ask the agent to cancel a running task and print the task's resulting +state. Cancellation is cooperative — the agent may already have +finished, in which case the terminal state is returned unchanged. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent a2a task cancel [flags] +---- + + + + +== Examples + +This section provides examples of how to use `rpk ai agent a2a task cancel`. + +rpai agent a2a task cancel financial-advisor TASK_ID + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task-get.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task-get.adoc new file mode 100644 index 0000000..e3b9806 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task-get.adoc @@ -0,0 +1,49 @@ += rpk ai agent a2a task get +:description: pass:q[Fetch a task's current state, status message, artifacts and (optionally truncated) message history. Use `-o` json for the full task object.] +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Fetch a task's current state, status message, artifacts and (optionally +truncated) message history. Use `-o` json for the full task object. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent a2a task get [flags] +---- + + + + +== Examples + +This section provides examples of how to use `rpk ai agent a2a task get`. + +rpai agent a2a task get financial-advisor TASK_ID + +[,bash] +---- +rpai agent a2a task get financial-advisor TASK_ID --history 10 -o json +---- + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task-watch.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task-watch.adoc new file mode 100644 index 0000000..ea23ce4 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task-watch.adoc @@ -0,0 +1,54 @@ += rpk ai agent a2a task watch +:description: pass:q[Reattach to a running task's event stream (A2A tasks/resubscribe) and print events until the task reaches a terminal state. Use after a disconnected `--stream` send or a `--no-block` send.] +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Reattach to a running task's event stream (A2A tasks/resubscribe) and +print events until the task reaches a terminal state. Use after a +disconnected `--stream` send or a `--no-block` send. + +Watch waits as long as the task runs (no timeout by default; bound it +with `--timeout`). Exit codes match send: 0 success or input-required, +4 task failed/canceled/rejected, 1 anything else. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent a2a task watch [flags] +---- + + + + +== Examples + +This section provides examples of how to use `rpk ai agent a2a task watch`. + +rpai agent a2a task watch financial-advisor TASK_ID + +[,bash] +---- +rpai agent a2a task watch financial-advisor TASK_ID -o json # one JSON event per line +---- + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task.adoc new file mode 100644 index 0000000..1917ed2 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-task.adoc @@ -0,0 +1,56 @@ += rpk ai agent a2a task +:description: pass:q[Inspect and control long-running A2A tasks. Task ids come from `rpai agent a2a send` replies (printed as task-id).] +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Inspect and control long-running A2A tasks. + +Task ids come from `rpai agent a2a send` replies (printed as task-id). + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent a2a task [flags] +---- + + + + +== Subcommands + +[cols="1,2a"] +|=== +|Command |Description + +|xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-task-cancel.adoc[`rpk ai agent a2a task cancel`] +|Ask the agent to cancel a running task and print the task's resulting state. Cancellation is cooperative — the agent may already have finished, in which case the terminal state is returned unchanged. + +|xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-task-get.adoc[`rpk ai agent a2a task get`] +|Fetch a task's current state, status message, artifacts and (optionally truncated) message history. Use `-o` json for the full task object. + +|xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-task-watch.adoc[`rpk ai agent a2a task watch`] +|Reattach to a running task's event stream (A2A tasks/resubscribe) and print events until the task reaches a terminal state. Use after a disconnected `--stream` send or a `--no-block` send. + +|=== + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a.adoc new file mode 100644 index 0000000..f413151 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a.adoc @@ -0,0 +1,128 @@ += rpk ai agent a2a +:description: Interact with an agent over the A2A (Agent-to-Agent) protocol. The AGENT argument is either a registry agent name (resolved to the agent's A2A endpoint via its runtime status) or a full A2A endpoint URL (anything starting with http:// or https://). +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Interact with an agent over the A2A (Agent-to-Agent) protocol. + +The AGENT argument is either a registry agent name (resolved to the +agent's A2A endpoint via its runtime status) or a full A2A endpoint URL +(anything starting with http:// or https://). + +Authentication: your profile's bearer token is attached when the target +is a registry agent or an explicit URL on the profile's dataplane host. +Explicit URLs on other hosts are called without credentials so your +token never leaves the platform (a note on stderr says so when this +happens). + +Output formats: table (default, human-readable) and `-o` json / `-o` yaml. +Streams (`--stream`, task watch) emit one JSON event per line under both +json and yaml. + +Exit codes: 0 success (including tasks waiting for more input), 4 task +ended failed/canceled/rejected, 1 anything else. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent a2a [flags] +---- + + + + +== Examples + +This section provides examples of how to use `rpk ai agent a2a`. + +# Discover what an agent can do + +[,bash] +---- +rpai agent a2a card financial-advisor +---- + + +[,bash] +---- +# Ask a question (waits for the reply) +---- +[,bash] +---- +rpai agent a2a send financial-advisor "How did tech stocks do today?" +---- + + +[,bash] +---- +# Continue the same conversation +---- +[,bash] +---- +rpai agent a2a send financial-advisor --context-id CTX "And yesterday?" +---- + + +[,bash] +---- +# Stream the reply as it is produced +---- +[,bash] +---- +rpai agent a2a send financial-advisor --stream "Summarize the market" +---- + + +[,bash] +---- +# Inspect, watch, or cancel a long-running task +---- + rpai agent a2a task get financial-advisor TASK_ID + +[,bash] +---- +rpai agent a2a task watch financial-advisor TASK_ID +---- +[,bash] +---- +rpai agent a2a task cancel financial-advisor TASK_ID +---- + +== Subcommands + +[cols="1,2a"] +|=== +|Command |Description + +|xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-card.adoc[`rpk ai agent a2a card`] +|Fetch the A2A agent card — the JSON discovery document describing the agent's identity, skills, supported transports and capabilities. Use `-o` json to feed the raw card to other tools. + +|xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-send.adoc[`rpk ai agent a2a send`] +|Send a text message to an agent over A2A and print the reply. The message comes from the positional argument, or from stdin when the argument is omitted or "-" (so you can pipe a prompt in). + +|xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-task.adoc[`rpk ai agent a2a task`] +|Inspect and control long-running A2A tasks. Task ids come from `rpai agent a2a send` replies (printed as task-id). + +|=== + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-apply.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-apply.adoc new file mode 100644 index 0000000..9ae79fa --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-apply.adoc @@ -0,0 +1,46 @@ += rpk ai agent apply +:description: Reconcile agents from one or more YAML manifests. For each manifest: create the agent if absent, otherwise update only the fields that are present in the manifest AND differ from the live agent. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Reconcile agents from one or more YAML manifests. + +For each manifest: create the agent if absent, otherwise update only the +fields that are present in the manifest AND differ from the live agent. +Fields you omit are left untouched; to clear a field, write it explicitly +(for example, `system_prompt: ""`). Lists and maps (mcp_servers, tags) replace +wholesale. The managed/self-managed variant is immutable. + +Manifests round-trip with `rpai agent get -o yaml`. Pass `-f` - to read +stdin. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent apply [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-create.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-create.adoc new file mode 100644 index 0000000..0a25acb --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-create.adoc @@ -0,0 +1,37 @@ += rpk ai agent create +:description: Create an agent. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Create an agent. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent create [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential-create.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential-create.adoc new file mode 100644 index 0000000..c10d8b7 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential-create.adoc @@ -0,0 +1,37 @@ += rpk ai agent credential create +:description: Creates a client-id/secret pair for the agent. The client_secret is shown exactly once — save it now; it cannot be retrieved again. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Creates a client-id/secret pair for the agent. The client_secret is shown exactly once — save it now; it cannot be retrieved again. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent credential create [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential-delete.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential-delete.adoc new file mode 100644 index 0000000..32619a1 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential-delete.adoc @@ -0,0 +1,37 @@ += rpk ai agent credential delete +:description: pass:q[Deletes a credential. is the full resource name as shown by `list`/`create`, for example, agents/my-agent/credentials/abc123.] +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Deletes a credential. is the full resource name as shown by `list`/`create`, for example, agents/my-agent/credentials/abc123. Idempotent. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent credential delete [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential-list.adoc new file mode 100644 index 0000000..1c97628 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential-list.adoc @@ -0,0 +1,37 @@ += rpk ai agent credential list +:description: List an agent's credentials. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +List an agent's credentials. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent credential list [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential.adoc new file mode 100644 index 0000000..2becaf4 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential.adoc @@ -0,0 +1,54 @@ += rpk ai agent credential +:description: Manage an agent's credentials (create, list, delete). +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Manage an agent's credentials (create, list, delete). + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent credential [flags] +---- + + + + +== Subcommands + +[cols="1,2a"] +|=== +|Command |Description + +|xref:reference:rpk/rpk-ai/rpk-ai-agent-credential-create.adoc[`rpk ai agent credential create`] +|Creates a client-id/secret pair for the agent. The client_secret is shown exactly once — save it now; it cannot be retrieved again. + +|xref:reference:rpk/rpk-ai/rpk-ai-agent-credential-delete.adoc[`rpk ai agent credential delete`] +|Deletes a credential. is the full resource name as shown by `list`/`create`, for example, agents/my-agent/credentials/abc123. + +|xref:reference:rpk/rpk-ai/rpk-ai-agent-credential-list.adoc[`rpk ai agent credential list`] +|List an agent's credentials. + +|=== + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-delete.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-delete.adoc new file mode 100644 index 0000000..6abf73a --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-delete.adoc @@ -0,0 +1,37 @@ += rpk ai agent delete +:description: Delete an agent. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Delete an agent. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent delete [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-diff.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-diff.adoc new file mode 100644 index 0000000..fb16eb2 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-diff.adoc @@ -0,0 +1,39 @@ += rpk ai agent diff +:description: pass:q[Dry-run of `agent apply`. Prints, per manifest, whether apply would create, update (and which fields), or leave the agent unchanged.] +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Dry-run of `agent apply`. Prints, per manifest, whether apply would +create, update (and which fields), or leave the agent unchanged. Exits +non-zero when any change is pending, so CI can gate on "no drift". + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent diff [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-get.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-get.adoc new file mode 100644 index 0000000..6474d2f --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-get.adoc @@ -0,0 +1,37 @@ += rpk ai agent get +:description: Get an agent. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Get an agent. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent get [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-start.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-start.adoc new file mode 100644 index 0000000..4c55582 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-start.adoc @@ -0,0 +1,37 @@ += rpk ai agent start +:description: Start a managed agent (desired_state=RUNNING). +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Start a managed agent (desired_state=RUNNING). + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent start [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-stop.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-stop.adoc new file mode 100644 index 0000000..f3eb48c --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-stop.adoc @@ -0,0 +1,37 @@ += rpk ai agent stop +:description: Stop a managed agent (desired_state=STOPPED). +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Stop a managed agent (desired_state=STOPPED). + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent stop [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-transcript-get.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-transcript-get.adoc new file mode 100644 index 0000000..2882906 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-transcript-get.adoc @@ -0,0 +1,37 @@ += rpk ai agent transcript get +:description: Get a single conversation transcript with its turns. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Get a single conversation transcript with its turns. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent transcript get [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-transcript-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-transcript-list.adoc new file mode 100644 index 0000000..c2a8746 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-transcript-list.adoc @@ -0,0 +1,37 @@ += rpk ai agent transcript list +:description: List an agent's conversation transcripts. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +List an agent's conversation transcripts. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent transcript list [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-transcript.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-transcript.adoc new file mode 100644 index 0000000..0bc59a5 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-transcript.adoc @@ -0,0 +1,51 @@ += rpk ai agent transcript +:description: Inspect an agent's conversation transcripts (list, get). +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Inspect an agent's conversation transcripts (list, get). + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent transcript [flags] +---- + + + + +== Subcommands + +[cols="1,2a"] +|=== +|Command |Description + +|xref:reference:rpk/rpk-ai/rpk-ai-agent-transcript-get.adoc[`rpk ai agent transcript get`] +|Get a single conversation transcript with its turns. + +|xref:reference:rpk/rpk-ai/rpk-ai-agent-transcript-list.adoc[`rpk ai agent transcript list`] +|List an agent's conversation transcripts. + +|=== + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-update.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-update.adoc new file mode 100644 index 0000000..d96739d --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-update.adoc @@ -0,0 +1,37 @@ += rpk ai agent update +:description: Update an agent. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Update an agent. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai agent update [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-check.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-check.adoc new file mode 100644 index 0000000..a224049 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-check.adoc @@ -0,0 +1,37 @@ += rpk ai llm check +:description: Runs a lightweight probe against the upstream to verify credentials and reachability. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Runs a lightweight probe against the upstream to verify credentials and reachability. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai llm check [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-get.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-get.adoc new file mode 100644 index 0000000..5d4aeb0 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-get.adoc @@ -0,0 +1,37 @@ += rpk ai oauth-client dcr get +:description: Show the tenant's DCR settings. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Show the tenant's DCR settings. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai oauth-client dcr get [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-list.adoc new file mode 100644 index 0000000..7367b9c --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-list.adoc @@ -0,0 +1,37 @@ += rpk ai oauth-client dcr iat list +:description: List Initial Access Tokens (plaintext is never shown). +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +List Initial Access Tokens (plaintext is never shown). + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai oauth-client dcr iat list [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-mint.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-mint.adoc new file mode 100644 index 0000000..aa86b0d --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-mint.adoc @@ -0,0 +1,37 @@ += rpk ai oauth-client dcr iat mint +:description: Mint a one-shot Initial Access Token. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Mint a one-shot Initial Access Token. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai oauth-client dcr iat mint [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-revoke.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-revoke.adoc new file mode 100644 index 0000000..4821b23 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-revoke.adoc @@ -0,0 +1,39 @@ += rpk ai oauth-client dcr iat revoke +:description: Revoke an unconsumed Initial Access Token so it can no longer be exchanged at the registration endpoint. Idempotent — revoking an already-revoked or consumed token returns 0. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Revoke an unconsumed Initial Access Token so it can no longer be +exchanged at the registration endpoint. Idempotent — revoking an +already-revoked or consumed token returns 0. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai oauth-client dcr iat revoke [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat.adoc new file mode 100644 index 0000000..cfec6c5 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat.adoc @@ -0,0 +1,57 @@ += rpk ai oauth-client dcr iat +:description: Manage Initial Access Tokens (IATs) — one-shot bearer credentials a caller presents to the public registration endpoint when the tenant's admission mode is initial-access-token. The plaintext is printed exactly once on mint; only a hash is stored. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Manage Initial Access Tokens (IATs) — one-shot bearer credentials a +caller presents to the public registration endpoint when the tenant's +admission mode is initial-access-token. The plaintext is printed +exactly once on mint; only a hash is stored. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai oauth-client dcr iat [flags] +---- + + + + +== Subcommands + +[cols="1,2a"] +|=== +|Command |Description + +|xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-list.adoc[`rpk ai oauth-client dcr iat list`] +|List Initial Access Tokens (plaintext is never shown). + +|xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-mint.adoc[`rpk ai oauth-client dcr iat mint`] +|Mint a one-shot Initial Access Token. + +|xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-revoke.adoc[`rpk ai oauth-client dcr iat revoke`] +|Revoke an unconsumed Initial Access Token so it can no longer be exchanged at the registration endpoint. Idempotent — revoking an already-revoked or consumed token returns 0. + +|=== + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-update.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-update.adoc new file mode 100644 index 0000000..b485a89 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr-update.adoc @@ -0,0 +1,51 @@ += rpk ai oauth-client dcr update +:description: Update the tenant's DCR settings. Only the flags you pass change; everything else keeps its current value (the CLI reads the current settings and writes back the merged result). +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Update the tenant's DCR settings. Only the flags you pass change; +everything else keeps its current value (the CLI reads the current +settings and writes back the merged result). + +Enable open self-registration: + +rpai oauth-client dcr update `--enabled` `--admission-mode` open. + +Require admin-minted Initial Access Tokens instead: + +rpai oauth-client dcr update `--admission-mode` initial-access-token. + +Turn the endpoint off again: + +rpai oauth-client dcr update `--enabled=false`. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai oauth-client dcr update [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr.adoc new file mode 100644 index 0000000..21d3258 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-dcr.adoc @@ -0,0 +1,70 @@ += rpk ai oauth-client dcr +:description: Manage the tenant's Dynamic Client Registration policy. When DCR is enabled, spec-conformant MCP clients (Claude, Cursor, …) self-register at the public /oauth/idp/register endpoint — no admin pre-provisioning. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Manage the tenant's Dynamic Client Registration policy. + +When DCR is enabled, spec-conformant MCP clients (Claude, Cursor, …) +self-register at the public /oauth/idp/register endpoint — no admin +pre-provisioning. Admission is governed by the mode: + +[cols="1m,1a"] +|=== +|Value |Description + +|open |anyone may register (rate limit + client cap still apply) +|initial-access-token |callers must present an admin-minted one-shot bearer +|software-statement |reserved; not yet supported +|=== + +DCR is disabled per tenant by default; the gateway operator must also +ship the binary with the global ingress.idp.dcr.global_enabled flag. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai oauth-client dcr [flags] +---- + + + + +== Subcommands + +[cols="1,2a"] +|=== +|Command |Description + +|xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-get.adoc[`rpk ai oauth-client dcr get`] +|Show the tenant's DCR settings. + +|xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat.adoc[`rpk ai oauth-client dcr iat`] +|Manage Initial Access Tokens (IATs) — one-shot bearer credentials a caller presents to the public registration endpoint when the tenant's admission mode is initial-access-token. The plaintext is printed exactly once on mint; only a hash is stored. + +|xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-update.adoc[`rpk ai oauth-client dcr update`] +|Update the tenant's DCR settings. Only the flags you pass change; everything else keeps its current value (the CLI reads the current settings and writes back the merged result). + +|=== + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-revoke-tokens.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-revoke-tokens.adoc new file mode 100644 index 0000000..9800b67 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-revoke-tokens.adoc @@ -0,0 +1,42 @@ += rpk ai oauth-client revoke-tokens +:description: Revoke every refresh token aigw has issued under . Forces all users that have connected this client to sign in again. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Revoke every refresh token aigw has issued under . Forces +all users that have connected this client to sign in again. Already- +issued short-lived access tokens may continue working until natural +expiry (typically minutes). + +Idempotent: running again returns 0. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai oauth-client revoke-tokens [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-run-claude.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-run-claude.adoc new file mode 100644 index 0000000..e3dd938 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-run-claude.adoc @@ -0,0 +1,73 @@ += rpk ai run claude +:description: Launch Anthropic's Claude Code CLI with its model traffic routed through the Redpanda AI gateway for the active rpai profile. rpai points ANTHROPIC_BASE_URL at the gateway's Anthropic Messages endpoint for the chosen provider and wires the gateway auth for the life of the session. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Launch Anthropic's Claude Code CLI with its model traffic +routed through the Redpanda AI gateway for the active rpai profile. + +rpai points ANTHROPIC_BASE_URL at the gateway's Anthropic Messages endpoint for +the chosen provider and wires the gateway auth for the life of the session. No +token is ever written to disk. + +Two auth modes are auto-selected from the provider's config, and they run in +different config homes: + +* managed (api key): runs in a throwaway CLAUDE_CONFIG_DIR holding a generated + settings.json whose apiKeyHelper re-runs `rpai auth token` so the gateway + bearer refreshes itself; aigw injects the upstream Anthropic key. Your own + `~/.claude` is never read or modified. + +* passthrough (enterprise/Max subscription): runs against your REAL Claude Code + config home so your existing subscription login is used — Claude Code stores + that OAuth under its config dir, so a throwaway home would hide it. rpai only + sets the gateway base URL and the X-Redpanda-Cloud-Token header (minted fresh + at launch) in the environment and writes nothing; your subscription OAuth + flows through aigw to Anthropic untouched. + +In passthrough mode the X-Redpanda-Cloud-Token gateway JWT is set in the +launched process environment, so Claude Code's tool subprocesses (Bash, hooks, +MCP) inherit it — the same Redpanda Cloud token any process running as you can +already mint with `rpai auth token`, and Claude Code has no documented mechanism +to scrub it from those subprocesses. + +Because passthrough uses your real config home, any auth configured in your +`~/.claude/settings.json` (an apiKeyHelper, or env.ANTHROPIC_AUTH_TOKEN) still +applies and outranks the subscription OAuth aigw needs to relay — rpai scrubs +only the inherited shell env, not your on-disk settings. + +Only anthropic providers are supported (Claude Code speaks the Anthropic Messages +API). Pass Claude Code's own flags after a literal --: + +rpai run claude `-L` anthropic `-m` claude-sonnet-4-6 -- `--permission-mode` plan. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai run claude [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-run-codex.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-run-codex.adoc new file mode 100644 index 0000000..3701f27 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-run-codex.adoc @@ -0,0 +1,53 @@ += rpk ai run codex +:description: pass:q[Launch the OpenAI Codex CLI with its model traffic routed through the Redpanda AI gateway for the active rpai profile. rpai generates a throwaway Codex config in a temporary CODEX_HOME, points it at the gateway's OpenAI-compatible Responses endpoint for the chosen provider, and wires Codex's bearer to `rpai auth token` so it refreshes itself for the life of the session.] +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Launch the OpenAI Codex CLI with its model traffic routed +through the Redpanda AI gateway for the active rpai profile. + +rpai generates a throwaway Codex config in a temporary CODEX_HOME, points it at +the gateway's OpenAI-compatible Responses endpoint for the chosen provider, and +wires Codex's bearer to `rpai auth token` so it refreshes itself for the +life of the session. Your own `~/.codex` config is never read or modified, and no +token is written to disk. + +The launch directory is auto-trusted under a workspace-write sandbox +(approval_policy=on-request) so the fresh CODEX_HOME doesn't prompt for trust on +every run; pass `--no-auto-trust` to keep Codex's normal first-run trust prompt. + +Only openai / openai_compatible providers are supported (Codex speaks the OpenAI +Responses API). Pass Codex's own flags after a literal --: + +rpai run codex `-L` openai `-m` gpt-5.3-codex `-e` high -- `--ask-for-approval` never. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai run codex [flags] +---- + + + + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-run.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-run.adoc new file mode 100644 index 0000000..6859b6e --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-run.adoc @@ -0,0 +1,53 @@ += rpk ai run +:description: Launch a third-party coding agent configured to send its model traffic through the Redpanda AI gateway for the active profile, reusing rpai's login and auto-refreshing token. +:page-beta: true +:page-platforms: linux + +// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc + +// tag::single-source[] +Launch a third-party coding agent configured to send its model traffic +through the Redpanda AI gateway for the active profile, reusing rpai's +login and auto-refreshing token. + +NOTE: This command is only available on Linux. + +== Usage + +[,bash] +---- +rpk ai run [flags] +---- + + + + +== Subcommands + +[cols="1,2a"] +|=== +|Command |Description + +|xref:reference:rpk/rpk-ai/rpk-ai-run-claude.adoc[`rpk ai run claude`] +|Launch Anthropic's Claude Code CLI with its model traffic routed through the Redpanda AI gateway for the active rpai profile. rpai points ANTHROPIC_BASE_URL at the gateway's Anthropic Messages endpoint for the chosen provider and wires the gateway auth for the life of the session. + +|xref:reference:rpk/rpk-ai/rpk-ai-run-codex.adoc[`rpk ai run codex`] +|Launch the OpenAI Codex CLI with its model traffic routed through the Redpanda AI gateway for the active rpai profile. rpai generates a throwaway Codex config in a temporary CODEX_HOME, points it at the gateway's OpenAI-compatible Responses endpoint for the chosen provider, and wires Codex's bearer to `rpai auth token` so it refreshes itself for the life of the session. + +|=== + + +== Global flags + +[cols="1m,1a,2a"] +|=== +|Value |Type |Description + +|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`. +|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail. +|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. +|--profile |string |`rpk` profile to use. +|-v, --verbose |bool |Enable verbose logging. +|=== + +// end::single-source[]