diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 31ee97ff..b254fd5b 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -114,9 +114,6 @@ ***** xref:reference:rpk/rpk-ai/rpk-ai-auth-logout.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-auth-status.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-auth-token.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-env.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-env-add.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-env-delete.adoc[] @@ -125,27 +122,27 @@ ***** xref:reference:rpk/rpk-ai/rpk-ai-env-show.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-env-use.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-apply.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-diff.adoc[] -***** xref:reference:rpk/rpk-ai/rpk-ai-llm-get.adoc[] -***** xref:reference:rpk/rpk-ai/rpk-ai-llm-list.adoc[] -***** xref:reference:rpk/rpk-ai/rpk-ai-llm-update.adoc[] -**** xref:reference:rpk/rpk-ai/rpk-ai-mcp.adoc[] -***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-apply.adoc[] -***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-create.adoc[] -***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-delete.adoc[] -***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-diff.adoc[] -***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-get.adoc[] -***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-list.adoc[] -***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-tools.adoc[] -****** xref:reference:rpk/rpk-ai/rpk-ai-mcp-tools-call.adoc[] -****** xref:reference:rpk/rpk-ai/rpk-ai-mcp-tools-list.adoc[] -***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-types.adoc[] -***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-update.adoc[] +**** xref:reference:rpk/rpk-ai/rpk-ai-llm-provider.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-llm-provider-apply.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-llm-provider-check.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-llm-provider-create.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-llm-provider-delete.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-llm-provider-diff.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-llm-provider-get.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-llm-provider-list.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-llm-provider-update.adoc[] +**** xref:reference:rpk/rpk-ai/rpk-ai-mcp-server.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-server-apply.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-server-create.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-server-delete.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-server-diff.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-server-get.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-server-list.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-server-tools.adoc[] +****** xref:reference:rpk/rpk-ai/rpk-ai-mcp-server-tools-call.adoc[] +****** xref:reference:rpk/rpk-ai/rpk-ai-mcp-server-tools-list.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-server-types.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-mcp-server-update.adoc[] **** xref:reference:rpk/rpk-ai/rpk-ai-model.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-model-get.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-model-list.adoc[] @@ -164,6 +161,7 @@ ***** 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-oauth-client-update.adoc[] **** xref:reference:rpk/rpk-ai/rpk-ai-oauth-provider.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-provider-apply.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-provider-create.adoc[] @@ -172,6 +170,14 @@ ***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-provider-get.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-provider-list.adoc[] ***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-provider-update.adoc[] +**** xref:reference:rpk/rpk-ai/rpk-ai-policy.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-policy-apply.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-policy-create.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-policy-delete.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-policy-diff.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-policy-get.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-policy-list.adoc[] +***** xref:reference:rpk/rpk-ai/rpk-ai-policy-update.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[] diff --git a/modules/cli/pages/index.adoc b/modules/cli/pages/index.adoc index b4893415..5ce311ee 100644 --- a/modules/cli/pages/index.adoc +++ b/modules/cli/pages/index.adoc @@ -90,7 +90,7 @@ Each Agentic Data Plane resource has its own command group, and each group suppo |rpk ai mcp-server |MCP servers and their tools -|xref:reference:rpk/rpk-ai/rpk-ai-mcp.adoc[`rpk ai mcp-server`] +|xref:reference:rpk/rpk-ai/rpk-ai-mcp-server.adoc[`rpk ai mcp-server`] |rpk ai oauth-provider |OAuth providers for user-delegated MCP connections diff --git a/modules/reference/pages/rpk/index.adoc b/modules/reference/pages/rpk/index.adoc index a86f298e..4a49b300 100644 --- a/modules/reference/pages/rpk/index.adoc +++ b/modules/reference/pages/rpk/index.adoc @@ -6,4 +6,4 @@ This section documents the `rpk` commands you use to manage the Redpanda Agentic Use `rpk ai` to manage AI Gateway resources (LLM providers, MCP servers, OAuth providers) and call MCP tools directly from your terminal. `rpk ai` is self-contained: it has its own login (`rpk ai auth login`) and its own Agentic Data Plane environment selection (`rpk ai env`), independent of any `rpk cloud` session. The active AI Gateway URL comes from the selected environment unless you override it with `--rpai-endpoint`. -For subcommands available after install (`rpk ai llm`, `rpk ai mcp`, `rpk ai oauth`, and more), run `rpk ai --help` from your terminal. +For subcommands available after install (`rpk ai llm-provider`, `rpk ai mcp-server`, `rpk ai oauth-provider`, and more), run `rpk ai --help` from your terminal. 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 index 0c6c9cfc..b310fcf8 100644 --- 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 @@ -1,40 +1,4 @@ = rpk ai agent a2a card -:description: rpk ai agent a2a card :page-preview: true -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. - -== Usage - -[,bash] ----- -rpk ai agent a2a card [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for card. - -|--timeout |duration |abort the call after this long (0 to wait forever) (default 5m0s). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-a2a-card.adoc[tag=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 index de789ab9..b9a447e3 100644 --- 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 @@ -1,91 +1,4 @@ = rpk ai agent a2a send -:description: rpk ai agent a2a send :page-preview: true -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 -`rpk ai 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. - -== Usage - -[,bash] ----- -rpk ai agent a2a send [message] [flags] ----- - -== Examples - -[,bash] ----- -# Ask and wait for the answer -rpk ai agent a2a send financial-advisor "What moved the S&P 500 today?" - -# Continue the conversation from a previous reply's context-id -rpk ai agent a2a send financial-advisor --context-id CTX "Why?" - -# Answer a task that ended in input-required -rpk ai agent a2a send financial-advisor --task-id TASK --context-id CTX "Account A-17" - -# Pipe the prompt from a file, get the full JSON reply -cat prompt.txt | rpk ai agent a2a send financial-advisor -o json - -# Stream events as they happen -rpk ai agent a2a send financial-advisor --stream "Give me a market summary" - -# Fire-and-forget: submit, then poll with `task get` -rpk ai agent a2a send financial-advisor --no-block "Deep analysis please" ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--context-id |string |continue an existing conversation (printed by a previous send). - -|-h, --help |- |help for send. - -|--no-block |- |return immediately with the submitted task instead of waiting for completion. - -|--stream |- |stream the reply as A2A events (message/stream) instead of waiting for the final result. - -|--task-id |string |continue an existing task (e.g. answer an input-required task). - -|--timeout |duration |abort the call after this long (0 to wait forever) (default 5m0s). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-a2a-send.adoc[tag=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 index 537f8cb7..60ce8b27 100644 --- 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 @@ -1,46 +1,4 @@ = rpk ai agent a2a task cancel -:description: rpk ai agent a2a task cancel :page-preview: true -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. - -== Usage - -[,bash] ----- -rpk ai agent a2a task cancel [flags] ----- - -== Examples - -[,bash] ----- -rpk ai agent a2a task cancel financial-advisor TASK_ID ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for cancel. - -|--timeout |duration |abort the call after this long (0 to wait forever) (default 5m0s). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-a2a-task-cancel.adoc[tag=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 index 4e3a846d..240a4853 100644 --- 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 @@ -1,48 +1,4 @@ = rpk ai agent a2a task get -:description: rpk ai agent a2a task get :page-preview: true -Fetch a task's current state, status message, artifacts and (optionally -truncated) message history. Use -o json for the full task object. - -== Usage - -[,bash] ----- -rpk ai agent a2a task get [flags] ----- - -== Examples - -[,bash] ----- -rpk ai agent a2a task get financial-advisor TASK_ID -rpk ai agent a2a task get financial-advisor TASK_ID --history 10 -o json ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for get. - -|--history |int |number of most recent history messages to include. - -|--timeout |duration |abort the call after this long (0 to wait forever) (default 5m0s). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-a2a-task-get.adoc[tag=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 index a500479a..e7ac6dc9 100644 --- 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 @@ -1,58 +1,4 @@ = rpk ai agent a2a task watch -:description: rpk ai agent a2a task watch :page-preview: true -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. - -== Usage - -[,bash] ----- -rpk ai agent a2a task watch [flags] ----- - -== Aliases - -[,bash] ----- -watch, resubscribe ----- - -== Examples - -[,bash] ----- -rpk ai agent a2a task watch financial-advisor TASK_ID -rpk ai agent a2a task watch financial-advisor TASK_ID -o json # one JSON event per line ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for watch. - -|--timeout |duration |abort after this long (default: wait forever). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-a2a-task-watch.adoc[tag=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 index 38d7178a..d81132b8 100644 --- 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 @@ -1,37 +1,4 @@ = rpk ai agent a2a task -:description: rpk ai agent a2a task :page-preview: true -Inspect and control long-running A2A tasks. - -Task ids come from `rpk ai agent a2a send` replies (printed as task-id). - -== Usage - -[,bash] ----- -rpk ai agent a2a task [command] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for task. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai agent a2a task [command] --help" for more information about a command. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-a2a-task.adoc[tag=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 index 08abef29..4f520f40 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a.adoc @@ -1,74 +1,4 @@ = rpk ai agent a2a -:description: rpk ai agent a2a :page-preview: true -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. - -== Usage - -[,bash] ----- -rpk ai agent a2a [command] ----- - -== Examples - -[,bash] ----- -# Discover what an agent can do -rpk ai agent a2a card financial-advisor - -# Ask a question (waits for the reply) -rpk ai agent a2a send financial-advisor "How did tech stocks do today?" - -# Continue the same conversation -rpk ai agent a2a send financial-advisor --context-id CTX "And yesterday?" - -# Stream the reply as it is produced -rpk ai agent a2a send financial-advisor --stream "Summarize the market" - -# Inspect, watch, or cancel a long-running task -rpk ai agent a2a task get financial-advisor TASK_ID -rpk ai agent a2a task watch financial-advisor TASK_ID -rpk ai agent a2a task cancel financial-advisor TASK_ID ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for a2a. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai agent a2a [command] --help" for more information about a command. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-a2a.adoc[tag=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 index a3676bc2..be48cabc 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-apply.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-apply.adoc @@ -1,49 +1,4 @@ = rpk ai agent apply -:description: rpk ai agent apply :page-preview: true -Reconcile agents from one or more YAML manifests. - -For each manifest: create the resource if absent, otherwise update only the -fields that are present in the manifest AND differ from the live resource. -Fields you omit are left untouched; to clear a field, write it explicitly. -Lists, maps and oneof variants replace wholesale. Fields that can only be set -at creation time are immutable; changing one is an error. - -Manifests round-trip with `get -o yaml` for this resource. Pass -f - to -read stdin. - -This does not delete resources absent from the manifests (no prune), and drift -is detected only for the fields a manifest names — see `diff --help`. - -== Usage - -[,bash] ----- -rpk ai agent apply -f [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-f, --filename |strings |manifest file, directory, or - for stdin (repeatable). - -|-h, --help |- |help for apply. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-apply.adoc[tag=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 index 1da12712..28e01e0c 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-create.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-create.adoc @@ -1,55 +1,4 @@ = rpk ai agent create -:description: rpk ai agent create :page-preview: true -Create an agent - -== Usage - -[,bash] ----- -rpk ai agent create [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--description |string |longer description of the agent's purpose. - -|--display-name |string |display name. - -|-h, --help |- |help for create. - -|--llm-provider |string |name of the LLM provider resource the agent uses. - -|--max-iterations |int32 |maximum agent loop iterations per invocation. - -|--mcp-server |strings |MCP server resource name the agent may call (repeatable). - -|--model |string |model the agent runs (e.g. claude-sonnet-4-6). - -|--self-managed |- |register a metadata-only self-managed agent (the platform won't run it). - -|--spec-file |string |path to a JSON/YAML ManagedAgentSpec; enables subagents/agent_card that scalar flags can't express (mutually exclusive with --self-managed and the spec flags). - -|--system-prompt |string |system prompt for the agent. - -|--tag |stringToString |metadata tag key=value (repeatable) (default []). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-create.adoc[tag=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 index 5404ea1c..0dd487a5 100644 --- 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 @@ -1,39 +1,4 @@ = rpk ai agent credential create -:description: rpk ai agent credential create :page-preview: true -Creates a client-id/secret pair for the agent. The client_secret is shown exactly once — save it now; it cannot be retrieved again. - -== Usage - -[,bash] ----- -rpk ai agent credential create [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--description |string |human-readable description of the credential. - -|-h, --help |- |help for create. - -|--ttl |duration |lifetime before the credential expires (e.g. 720h); 0 means no expiry. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-credential-create.adoc[tag=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 index 21ea87f6..fdb546b8 100644 --- 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 @@ -1,35 +1,4 @@ = rpk ai agent credential delete -:description: rpk ai agent credential delete :page-preview: true -Deletes a credential. is the full resource name as shown by `list`/`create`, e.g. agents/my-agent/credentials/abc123. Idempotent. - -== Usage - -[,bash] ----- -rpk ai agent credential delete [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for delete. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-credential-delete.adoc[tag=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 index 1c5b3147..0913ef46 100644 --- 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 @@ -1,35 +1,4 @@ = rpk ai agent credential list -:description: rpk ai agent credential list :page-preview: true -List an agent's credentials - -== Usage - -[,bash] ----- -rpk ai agent credential list [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for list. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-credential-list.adoc[tag=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 index e7e31dbe..18e8c1bb 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-credential.adoc @@ -1,42 +1,4 @@ = rpk ai agent credential -:description: rpk ai agent credential :page-preview: true -Manage an agent's credentials (create, list, delete) - -== Usage - -[,bash] ----- -rpk ai agent credential [command] ----- - -== Aliases - -[,bash] ----- -credential, credentials, cred ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for credential. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai agent credential [command] --help" for more information about a command. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-credential.adoc[tag=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 index 9dac3855..04733132 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-delete.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-delete.adoc @@ -1,35 +1,4 @@ = rpk ai agent delete -:description: rpk ai agent delete :page-preview: true -Delete an agent - -== Usage - -[,bash] ----- -rpk ai agent delete [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for delete. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-delete.adoc[tag=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 index 55d84934..ef5f2719 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-diff.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-diff.adoc @@ -1,43 +1,4 @@ = rpk ai agent diff -:description: rpk ai agent diff :page-preview: true -Dry-run of apply for agents. Prints, per manifest, whether apply would -create, update (and which fields), or leave the resource unchanged. Exits -non-zero when any change is pending, so CI can gate on "no drift". - -Note: diff proves only that the fields a manifest names match live. It does not -detect resources that exist live but are absent from the manifests (no prune), -nor drift in fields a manifest omits. - -== Usage - -[,bash] ----- -rpk ai agent diff -f [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-f, --filename |strings |manifest file, directory, or - for stdin (repeatable). - -|-h, --help |- |help for diff. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-diff.adoc[tag=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 index 4a73c8fd..d2f1b920 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-get.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-get.adoc @@ -1,35 +1,4 @@ = rpk ai agent get -:description: rpk ai agent get :page-preview: true -Get an agent - -== Usage - -[,bash] ----- -rpk ai agent get [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for get. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-get.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-list.adoc index e62d623f..a5c89cc1 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-list.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-list.adoc @@ -1,37 +1,4 @@ = rpk ai agent list -:description: rpk ai agent list :page-preview: true -List agents - -== Usage - -[,bash] ----- -rpk ai agent list [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--filter |string |AIP-160 filter expression, e.g. name:"web" or display_name="prod". - -|-h, --help |- |help for list. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-list.adoc[tag=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 index 778ee409..b97970f2 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-start.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-start.adoc @@ -1,35 +1,4 @@ = rpk ai agent start -:description: rpk ai agent start :page-preview: true -Start a managed agent (desired_state=RUNNING) - -== Usage - -[,bash] ----- -rpk ai agent start [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for start. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-start.adoc[tag=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 index 54340288..e1a7417a 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-stop.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-stop.adoc @@ -1,35 +1,4 @@ = rpk ai agent stop -:description: rpk ai agent stop :page-preview: true -Stop a managed agent (desired_state=STOPPED) - -== Usage - -[,bash] ----- -rpk ai agent stop [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for stop. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-stop.adoc[tag=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 index cc47183e..ed049ba2 100644 --- 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 @@ -1,35 +1,4 @@ = rpk ai agent transcript get -:description: rpk ai agent transcript get :page-preview: true -Get a single conversation transcript with its turns - -== Usage - -[,bash] ----- -rpk ai agent transcript get [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for get. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-transcript-get.adoc[tag=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 index 86ca765b..a1be2e79 100644 --- 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 @@ -1,45 +1,4 @@ = rpk ai agent transcript list -:description: rpk ai agent transcript list :page-preview: true -List an agent's conversation transcripts - -== Usage - -[,bash] ----- -rpk ai agent transcript list [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--errors-only |- |only conversations that contain errors. - -|-h, --help |- |help for list. - -|--query |string |free-text search across conversation titles and content. - -|--since |string |only conversations started at/after this time (RFC3339, or a duration ago like 24h). - -|--status |string |filter by status: running, completed, error. - -|--until |string |only conversations started before this time (RFC3339, or a duration ago like 1h). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-transcript-list.adoc[tag=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 index 1c6fe8a4..422eb06d 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-transcript.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-transcript.adoc @@ -1,42 +1,4 @@ = rpk ai agent transcript -:description: rpk ai agent transcript :page-preview: true -Inspect an agent's conversation transcripts (list, get) - -== Usage - -[,bash] ----- -rpk ai agent transcript [command] ----- - -== Aliases - -[,bash] ----- -transcript, transcripts, tr ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for transcript. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai agent transcript [command] --help" for more information about a command. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-transcript.adoc[tag=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 index 7d195135..5f355542 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-update.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-update.adoc @@ -1,51 +1,4 @@ = rpk ai agent update -:description: rpk ai agent update :page-preview: true -Update an agent - -== Usage - -[,bash] ----- -rpk ai agent update [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--description |string |new description. - -|--display-name |string |new display name. - -|-h, --help |- |help for update. - -|--llm-provider |string |name of the LLM provider resource the agent uses. - -|--max-iterations |int32 |maximum agent loop iterations per invocation. - -|--mcp-server |strings |MCP server resource name the agent may call (repeatable). - -|--model |string |model the agent runs (e.g. claude-sonnet-4-6). - -|--system-prompt |string |system prompt for the agent. - -|--tag |stringToString |replacement metadata tags key=value (repeatable) (default []). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent-update.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent.adoc index 6d32f665..590e10fb 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-agent.adoc @@ -1,52 +1,4 @@ = rpk ai agent -:description: rpk ai agent :page-preview: true -Manage agents registered with the Redpanda AI platform. - -Agents are either managed (adp runs them; configured via a model, LLM -provider, system prompt and MCP servers) or self-managed (a metadata-only -record tracking a user-hosted agent). `create` makes a managed agent by -default; pass --self-managed for the metadata-only variant. - -The `credential` subcommand provisions client-id/secret pairs an agent -uses to authenticate against the gateway. The `a2a` subcommand talks to -a running agent over the A2A protocol (fetch its card, send messages, -manage tasks). - -== Usage - -[,bash] ----- -rpk ai agent [command] ----- - -== Aliases - -[,bash] ----- -agent, agents ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for agent. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai agent [command] --help" for more information about a command. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-agent.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-login.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-login.adoc index e97e3a47..0ebbf36f 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-login.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-login.adoc @@ -1,44 +1,4 @@ = rpk ai auth login -:description: rpk ai auth login :page-preview: true -Run the OAuth 2.0 device authorization grant against Redpanda Cloud's -cloud-api, persist the resulting credentials to the rpai credentials file -(0600), and — for new profiles — prompt to pick an ADP environment whose AI -Gateway URL becomes the profile's dataplane_url. - -If the active profile's stored credentials are still valid, login is a -no-op and prints "Already logged in ...". Log out first (or delete the -credential entry) to force a re-auth. - -== Usage - -[,bash] ----- -rpk ai auth login [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for login. - -|--no-browser |- |do not attempt to open the browser; print the URL only. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-auth-login.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-logout.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-logout.adoc index 2baf106e..6746e0ee 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-logout.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-logout.adoc @@ -1,37 +1,4 @@ = rpk ai auth logout -:description: rpk ai auth logout :page-preview: true -Delete stored credentials for the current profile (or all) - -== Usage - -[,bash] ----- -rpk ai auth logout [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--all |- |delete credentials for every profile (removes the credentials file). - -|-h, --help |- |help for logout. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-auth-logout.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-status.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-status.adoc index bc20225a..2c09e0b2 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-status.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-status.adoc @@ -1,35 +1,4 @@ = rpk ai auth status -:description: rpk ai auth status :page-preview: true -Show the authentication state for the current profile - -== Usage - -[,bash] ----- -rpk ai auth status [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-o, --format |string |output format: table{vbar}json{vbar}yaml{vbar}markdown (overrides root --format). - -|-h, --help |- |help for status. - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-auth-status.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-token.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-token.adoc index 4a7e5603..4080fc2b 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-token.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth-token.adoc @@ -1,37 +1,4 @@ = rpk ai auth token -:description: rpk ai auth token :page-preview: true -Print the current bearer access token to stdout (refreshes if expired) - -== Usage - -[,bash] ----- -rpk ai auth token [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for token. - -|--refresh-within |duration |proactively refresh if the token expires within this window (for polling callers like a Codex/Claude auth helper); 0 uses the default 60s leeway. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-auth-token.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth.adoc index 10858104..cb0397ba 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-auth.adoc @@ -1,35 +1,4 @@ = rpk ai auth -:description: rpk ai auth :page-preview: true -Manage rpai authentication (login, logout, token, status) - -== Usage - -[,bash] ----- -rpk ai auth [command] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for auth. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai auth [command] --help" for more information about a command. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-auth.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-connection-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-connection-list.adoc deleted file mode 100644 index 4463dc1b..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-connection-list.adoc +++ /dev/null @@ -1,35 +0,0 @@ -= rpk ai connection list -:description: rpk ai connection list -:page-preview: true - -List OAuth connections — coming soon - -== Usage - -[,bash] ----- -rpk ai connection list [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for list. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-connection-revoke.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-connection-revoke.adoc deleted file mode 100644 index a2a5e6c5..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-connection-revoke.adoc +++ /dev/null @@ -1,35 +0,0 @@ -= rpk ai connection revoke -:description: rpk ai connection revoke -:page-preview: true - -Revoke an OAuth connection — coming soon - -== Usage - -[,bash] ----- -rpk ai connection revoke [name] [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for revoke. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-connection.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-connection.adoc deleted file mode 100644 index 597edd08..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-connection.adoc +++ /dev/null @@ -1,43 +0,0 @@ -= rpk ai connection -:description: rpk ai connection -:page-preview: true - -Manage OAuth connections — coming soon - -== Usage - -[,bash] ----- -rpk ai connection [flags] -rpk ai connection [command] ----- - -== Aliases - -[,bash] ----- -connection, connections, conn ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for connection. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai connection [command] --help" for more information about a command. -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-add.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-add.adoc index 109d466b..ce18ce1e 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-add.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-add.adoc @@ -1,50 +1,4 @@ = rpk ai env add -:description: rpk ai env add :page-preview: true -Add a manual rpai environment with explicit URLs - -== Usage - -[,bash] ----- -rpk ai env add NAME [flags] ----- - -== Aliases - -[,bash] ----- -add, create ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--adp-api-url |string |adp-api base URL (optional; derived from the AI Gateway URL when omitted). - -|--ai-gateway-url |string |AI Gateway base URL (required). - -|--auth-mode |string |auth mode: device{vbar}rpk{vbar}token{vbar}none (default device). - -|--from |string |copy an existing environment as the base. - -|-h, --help |- |help for add. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-env-add.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-delete.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-delete.adoc index 3e8612c2..8c03a264 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-delete.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-delete.adoc @@ -1,37 +1,4 @@ = rpk ai env delete -:description: rpk ai env delete :page-preview: true -Delete an environment from config and credentials files - -== Usage - -[,bash] ----- -rpk ai env delete NAME [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--force |- |delete even if NAME is the current environment. - -|-h, --help |- |help for delete. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-env-delete.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-list.adoc index 5b36d882..f31f6e31 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-list.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-list.adoc @@ -1,37 +1,4 @@ = rpk ai env list -:description: rpk ai env list :page-preview: true -List environments (local + live ADP environments, merged) - -== Usage - -[,bash] ----- -rpk ai env list [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for list. - -|--local |- |skip the live ADP environments lookup; show only locally-configured environments. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-env-list.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-rename.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-rename.adoc index 5722ce87..0127bc00 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-rename.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-rename.adoc @@ -1,35 +1,4 @@ = rpk ai env rename -:description: rpk ai env rename :page-preview: true -Rename an environment in both config and credentials files - -== Usage - -[,bash] ----- -rpk ai env rename OLD NEW [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for rename. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-env-rename.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-show.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-show.adoc index 61098b91..8b0a70c4 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-show.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-show.adoc @@ -1,35 +1,4 @@ = rpk ai env show -:description: rpk ai env show :page-preview: true -Show the effective resolved environment as YAML (tokens redacted) - -== Usage - -[,bash] ----- -rpk ai env show [NAME] [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for show. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-env-show.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-use.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-use.adoc index 4cd26a07..8c944bb1 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-use.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-env-use.adoc @@ -1,35 +1,4 @@ = rpk ai env use -:description: rpk ai env use :page-preview: true -Switch to a local environment, or select an ADP environment by name or id - -== Usage - -[,bash] ----- -rpk ai env use NAME [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for use. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-env-use.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-env.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-env.adoc index f88b3215..d51ed087 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-env.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-env.adoc @@ -1,42 +1,4 @@ = rpk ai env -:description: rpk ai env :page-preview: true -Manage rpai environments (list, use, add, show, rename, delete) - -== Usage - -[,bash] ----- -rpk ai env [command] ----- - -== Aliases - -[,bash] ----- -env, environment ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for env. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai env [command] --help" for more information about a command. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-env.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-install.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-install.adoc index 492d41cc..3fbec197 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-install.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-install.adoc @@ -1,41 +1,4 @@ = rpk ai install -:description: rpk ai install :page-preview: true -Install the Redpanda AI CLI. - -This command installs the latest version by default. - -Alternatively, you may specify an rpk ai version using the --ai-version flag. - -You may force the installation using the --force flag. - -== Usage - -[,bash] ----- -rpk ai install [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--ai-version |string |Redpanda AI CLI version to install (e.g. 0.1.2) (default "latest"). - -|--force |- |Force install of the Redpanda AI CLI. - -|-h, --help |- |Help for install. - -|--config |string |Redpanda or rpk config file; default search paths are "/var/lib/redpanda/.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 |- |Ignore rpk.yaml and redpanda.yaml; use default settings. - -|--profile |string |rpk profile to use. - -|-v, --verbose |- |Enable verbose logging. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-install.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-apply.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-apply.adoc deleted file mode 100644 index 5b0df0d3..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-apply.adoc +++ /dev/null @@ -1,49 +0,0 @@ -= rpk ai llm apply -:description: rpk ai llm apply -:page-preview: true - -Reconcile LLM providers from one or more YAML manifests. - -For each manifest: create the resource if absent, otherwise update only the -fields that are present in the manifest AND differ from the live resource. -Fields you omit are left untouched; to clear a field, write it explicitly. -Lists, maps and oneof variants replace wholesale. Fields that can only be set -at creation time are immutable; changing one is an error. - -Manifests round-trip with `get -o yaml` for this resource. Pass -f - to -read stdin. - -This does not delete resources absent from the manifests (no prune), and drift -is detected only for the fields a manifest names — see `diff --help`. - -== Usage - -[,bash] ----- -rpk ai llm apply -f [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-f, --filename |strings |manifest file, directory, or - for stdin (repeatable). - -|-h, --help |- |help for apply. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file 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 deleted file mode 100644 index dea96696..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-check.adoc +++ /dev/null @@ -1,35 +0,0 @@ -= rpk ai llm check -:description: rpk ai llm check -:page-preview: true - -Runs a lightweight probe against the upstream to verify credentials and reachability. - -== Usage - -[,bash] ----- -rpk ai llm check [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for check. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-create.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-create.adoc deleted file mode 100644 index 8a11caf2..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-create.adoc +++ /dev/null @@ -1,55 +0,0 @@ -= rpk ai llm create -:description: rpk ai llm create -:page-preview: true - -Create an LLM provider - -== Usage - -[,bash] ----- -rpk ai llm create [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--api-key-ref |string |API key or AWS Secret Access Key secret reference (bedrock). - -|--authorization-passthrough |- |forward client's Authorization header to upstream (Anthropic enterprise/Max OAuth). - -|--base-url |string |base URL. - -|--bedrock-access-key-id-ref |string |AWS Access Key ID or secret reference for Bedrock. - -|--bedrock-region |string |AWS region for Bedrock (e.g. us-east-1). - -|--display-name |string |display name. - -|--enabled |- |whether provider is enabled (default true). - -|-h, --help |- |help for create. - -|--models |strings |supported models. - -|--name |string |provider name (required). - -|--type |string |provider type: openai, anthropic, google, bedrock. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-delete.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-delete.adoc deleted file mode 100644 index d817837e..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-delete.adoc +++ /dev/null @@ -1,35 +0,0 @@ -= rpk ai llm delete -:description: rpk ai llm delete -:page-preview: true - -Delete an LLM provider - -== Usage - -[,bash] ----- -rpk ai llm delete [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for delete. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-diff.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-diff.adoc deleted file mode 100644 index 2388166c..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-diff.adoc +++ /dev/null @@ -1,43 +0,0 @@ -= rpk ai llm diff -:description: rpk ai llm diff -:page-preview: true - -Dry-run of apply for LLM providers. Prints, per manifest, whether apply would -create, update (and which fields), or leave the resource unchanged. Exits -non-zero when any change is pending, so CI can gate on "no drift". - -Note: diff proves only that the fields a manifest names match live. It does not -detect resources that exist live but are absent from the manifests (no prune), -nor drift in fields a manifest omits. - -== Usage - -[,bash] ----- -rpk ai llm diff -f [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-f, --filename |strings |manifest file, directory, or - for stdin (repeatable). - -|-h, --help |- |help for diff. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-get.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-get.adoc deleted file mode 100644 index 60c9aa1a..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-get.adoc +++ /dev/null @@ -1,35 +0,0 @@ -= rpk ai llm get -:description: rpk ai llm get -:page-preview: true - -Get an LLM provider - -== Usage - -[,bash] ----- -rpk ai llm get [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for get. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-list.adoc deleted file mode 100644 index 9930feb4..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-list.adoc +++ /dev/null @@ -1,37 +0,0 @@ -= rpk ai llm list -:description: rpk ai llm list -:page-preview: true - -List LLM providers - -== Usage - -[,bash] ----- -rpk ai llm list [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--filter-name |string |filter by name (contains). - -|-h, --help |- |help for list. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-apply.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-apply.adoc new file mode 100644 index 00000000..c40ddba0 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-apply.adoc @@ -0,0 +1,5 @@ += rpk ai llm-provider apply +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-llm-apply.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-llm-provider-apply.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-check.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-check.adoc new file mode 100644 index 00000000..9aba5202 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-check.adoc @@ -0,0 +1,5 @@ += rpk ai llm-provider check +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-llm-check.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-llm-provider-check.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-create.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-create.adoc new file mode 100644 index 00000000..21aaab67 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-create.adoc @@ -0,0 +1,5 @@ += rpk ai llm-provider create +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-llm-create.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-llm-provider-create.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-delete.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-delete.adoc new file mode 100644 index 00000000..7df1d618 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-delete.adoc @@ -0,0 +1,5 @@ += rpk ai llm-provider delete +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-llm-delete.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-llm-provider-delete.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-diff.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-diff.adoc new file mode 100644 index 00000000..30b80336 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-diff.adoc @@ -0,0 +1,5 @@ += rpk ai llm-provider diff +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-llm-diff.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-llm-provider-diff.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-get.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-get.adoc new file mode 100644 index 00000000..1c64b68f --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-get.adoc @@ -0,0 +1,5 @@ += rpk ai llm-provider get +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-llm-get.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-llm-provider-get.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-list.adoc new file mode 100644 index 00000000..ad01d7bd --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-list.adoc @@ -0,0 +1,5 @@ += rpk ai llm-provider list +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-llm-list.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-llm-provider-list.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-update.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-update.adoc new file mode 100644 index 00000000..cb9613cc --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider-update.adoc @@ -0,0 +1,5 @@ += rpk ai llm-provider update +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-llm-update.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-llm-provider-update.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider.adoc new file mode 100644 index 00000000..dc53eb99 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-provider.adoc @@ -0,0 +1,5 @@ += rpk ai llm-provider +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-llm.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-llm-provider.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-update.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-update.adoc deleted file mode 100644 index d34b7573..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm-update.adoc +++ /dev/null @@ -1,45 +0,0 @@ -= rpk ai llm update -:description: rpk ai llm update -:page-preview: true - -Update an LLM provider - -== Usage - -[,bash] ----- -rpk ai llm update [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--api-key-ref |string |new API key reference — must be UPPER_SNAKE_CASE (provider-specific). - -|--base-url |string |new base URL (provider-specific). - -|--display-name |string |new display name. - -|--enabled |- |whether provider is enabled (default true). - -|-h, --help |- |help for update. - -|--models |strings |new models list. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm.adoc deleted file mode 100644 index 9d84b145..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-llm.adoc +++ /dev/null @@ -1,46 +0,0 @@ -= rpk ai llm -:description: rpk ai llm -:page-preview: true - -Manage LLM providers registered with the Redpanda AI gateway. - -Supported provider types: openai, anthropic, google, bedrock. - -Aliases: `llm-provider` (compat with aigwctl), `provider`, `lp`. - -== Usage - -[,bash] ----- -rpk ai llm [command] ----- - -== Aliases - -[,bash] ----- -llm, llm-provider, provider, lp ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for llm. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai llm [command] --help" for more information about a command. -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-apply.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-apply.adoc deleted file mode 100644 index 78ed93af..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-apply.adoc +++ /dev/null @@ -1,49 +0,0 @@ -= rpk ai mcp apply -:description: rpk ai mcp apply -:page-preview: true - -Reconcile MCP servers from one or more YAML manifests. - -For each manifest: create the resource if absent, otherwise update only the -fields that are present in the manifest AND differ from the live resource. -Fields you omit are left untouched; to clear a field, write it explicitly. -Lists, maps and oneof variants replace wholesale. Fields that can only be set -at creation time are immutable; changing one is an error. - -Manifests round-trip with `get -o yaml` for this resource. Pass -f - to -read stdin. - -This does not delete resources absent from the manifests (no prune), and drift -is detected only for the fields a manifest names — see `diff --help`. - -== Usage - -[,bash] ----- -rpk ai mcp apply -f [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-f, --filename |strings |manifest file, directory, or - for stdin (repeatable). - -|-h, --help |- |help for apply. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-create.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-create.adoc deleted file mode 100644 index c14daf6c..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-create.adoc +++ /dev/null @@ -1,51 +0,0 @@ -= rpk ai mcp create -:description: rpk ai mcp create -:page-preview: true - -Create an MCP server - -== Usage - -[,bash] ----- -rpk ai mcp create [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--description |string |human-readable description of the server. - -|--enabled |- |whether server is enabled (default true). - -|-h, --help |- |help for create. - -|--managed-config |- |rpk ai mcp types managed MCP config JSON. The @type may be the short name from rpk ai mcp types (e.g. '{"@type":"SQLMCP","driver":"sqlite3","dsn":":memory:"}') or the full proto URL. The per-MCP oneof `auth` carries any credentials (static_key / user_oauth) — specify it inside the JSON. - -|--name |string |server name (required). - -|--transport |string |transport: sse, streamable-http (default "sse"). - -|--url |string |server URL (for remote backend). - -|--user-oauth-provider |string |for --url (remote) servers: name of the OAuthProvider whose per-user tokens should authenticate upstream requests. Ignored for managed servers — set auth.user_oauth inside --managed-config instead. - -|--user-oauth-scopes |strings |minimum OAuth scopes a user's connection must have (user_oauth.required_scopes). Applies only when --user-oauth-provider is set. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-delete.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-delete.adoc deleted file mode 100644 index 85f34c14..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-delete.adoc +++ /dev/null @@ -1,35 +0,0 @@ -= rpk ai mcp delete -:description: rpk ai mcp delete -:page-preview: true - -Delete an MCP server - -== Usage - -[,bash] ----- -rpk ai mcp delete [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for delete. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-diff.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-diff.adoc deleted file mode 100644 index 28d36923..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-diff.adoc +++ /dev/null @@ -1,43 +0,0 @@ -= rpk ai mcp diff -:description: rpk ai mcp diff -:page-preview: true - -Dry-run of apply for MCP servers. Prints, per manifest, whether apply would -create, update (and which fields), or leave the resource unchanged. Exits -non-zero when any change is pending, so CI can gate on "no drift". - -Note: diff proves only that the fields a manifest names match live. It does not -detect resources that exist live but are absent from the manifests (no prune), -nor drift in fields a manifest omits. - -== Usage - -[,bash] ----- -rpk ai mcp diff -f [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-f, --filename |strings |manifest file, directory, or - for stdin (repeatable). - -|-h, --help |- |help for diff. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-get.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-get.adoc deleted file mode 100644 index 73ecac44..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-get.adoc +++ /dev/null @@ -1,37 +0,0 @@ -= rpk ai mcp get -:description: rpk ai mcp get -:page-preview: true - -Get an MCP server - -== Usage - -[,bash] ----- -rpk ai mcp get [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for get. - -|--no-tools |- |skip live tool discovery (avoids a second RPC + upstream call). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-list.adoc deleted file mode 100644 index 3f839644..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-list.adoc +++ /dev/null @@ -1,37 +0,0 @@ -= rpk ai mcp list -:description: rpk ai mcp list -:page-preview: true - -List MCP servers - -== Usage - -[,bash] ----- -rpk ai mcp list [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--filter-name |string |filter by name (contains). - -|-h, --help |- |help for list. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-apply.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-apply.adoc new file mode 100644 index 00000000..79d7e8ae --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-apply.adoc @@ -0,0 +1,5 @@ += rpk ai mcp-server apply +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-mcp-apply.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-mcp-server-apply.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-create.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-create.adoc new file mode 100644 index 00000000..4c5712b6 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-create.adoc @@ -0,0 +1,5 @@ += rpk ai mcp-server create +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-mcp-create.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-mcp-server-create.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-delete.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-delete.adoc new file mode 100644 index 00000000..038fb531 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-delete.adoc @@ -0,0 +1,5 @@ += rpk ai mcp-server delete +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-mcp-delete.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-mcp-server-delete.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-diff.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-diff.adoc new file mode 100644 index 00000000..855349f7 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-diff.adoc @@ -0,0 +1,5 @@ += rpk ai mcp-server diff +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-mcp-diff.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-mcp-server-diff.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-get.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-get.adoc new file mode 100644 index 00000000..c569ace2 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-get.adoc @@ -0,0 +1,5 @@ += rpk ai mcp-server get +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-mcp-get.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-mcp-server-get.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-list.adoc new file mode 100644 index 00000000..9e173ea0 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-list.adoc @@ -0,0 +1,5 @@ += rpk ai mcp-server list +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-mcp-list.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-mcp-server-list.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-tools-call.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-tools-call.adoc new file mode 100644 index 00000000..8a687eac --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-tools-call.adoc @@ -0,0 +1,5 @@ += rpk ai mcp-server tools call +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-mcp-tools-call.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-mcp-server-tools-call.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-tools-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-tools-list.adoc new file mode 100644 index 00000000..08a9edbf --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-tools-list.adoc @@ -0,0 +1,5 @@ += rpk ai mcp-server tools list +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-mcp-tools-list.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-mcp-server-tools-list.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-tools.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-tools.adoc new file mode 100644 index 00000000..2cf24881 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-tools.adoc @@ -0,0 +1,5 @@ += rpk ai mcp-server tools +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-mcp-tools.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-mcp-server-tools.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-types.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-types.adoc new file mode 100644 index 00000000..eb98e4ef --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-types.adoc @@ -0,0 +1,5 @@ += rpk ai mcp-server types +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-mcp-types.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-mcp-server-types.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-update.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-update.adoc new file mode 100644 index 00000000..12c480fe --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server-update.adoc @@ -0,0 +1,5 @@ += rpk ai mcp-server update +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-mcp-update.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-mcp-server-update.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server.adoc new file mode 100644 index 00000000..581843d7 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-server.adoc @@ -0,0 +1,5 @@ += rpk ai mcp-server +:page-preview: true +:page-aliases: reference:rpk/rpk-ai/rpk-ai-mcp.adoc + +include::streaming:reference:partial$rpk-ai/rpk-ai-mcp-server.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-tools-call.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-tools-call.adoc deleted file mode 100644 index 6dd2c908..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-tools-call.adoc +++ /dev/null @@ -1,56 +0,0 @@ -= rpk ai mcp tools call -:description: rpk ai mcp tools call -:page-preview: true - -Invoke a tool on an MCP server through the aigw MCP proxy. - -The server's /mcp/v1/ endpoint is reached with the same bearer token -used by the rest of rpai; aigw resolves user-delegated OAuth tokens from the -vault when the MCP server is configured with --user-oauth-provider. - -Arguments passed to the tool are a JSON object supplied via --args. Example: - - rpk ai mcp tools call gf-servicenow-sand2 listtablerecords \ - --args '{"tableName":"incident","sysparm_limit":3}' - -With --code-mode the call targets the virtual code-mode sibling endpoint -(/mcp/v1/-code). That endpoint exposes search (tool catalog for the -primary) and execute (runs JavaScript in a sandbox with call_tool bound to -the primary's tools). Example: - - rpk ai mcp tools call pg-garrett execute --code-mode \ - --args '{"code":"var r = call_tool({name:\"query\", arguments:{query:\"SELECT 1\"}}); JSON.stringify(r);"}' - -== Usage - -[,bash] ----- -rpk ai mcp tools call [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--args |string |JSON object of tool arguments, e.g. '{"foo":"bar"}'. Empty means no arguments. - -|--code-mode |- |Target the virtual code-mode sibling endpoint (-code) instead of the primary. - -|-h, --help |- |help for call. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-tools-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-tools-list.adoc deleted file mode 100644 index 86246f70..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-tools-list.adoc +++ /dev/null @@ -1,49 +0,0 @@ -= rpk ai mcp tools list -:description: rpk ai mcp tools list -:page-preview: true - -List tools on an MCP server by calling tools/list through the aigw MCP proxy. - -Hits the server's /mcp/v1/ endpoint, so the same auth and token-vault -path used by tools/call is exercised here. Useful for checking that a managed -MCP's tool schema loaded correctly and that a user-delegated server is -reachable with the caller's vault token. - -With --code-mode the session targets the virtual code-mode sibling endpoint -(/mcp/v1/-code), which exposes the sandbox meta-tools (search, -execute). To see the parent's tool catalog from the sandbox, invoke the -search tool explicitly: - - rpk ai mcp tools call search --code-mode - -== Usage - -[,bash] ----- -rpk ai mcp tools list [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--code-mode |- |Target the virtual code-mode sibling endpoint (-code) instead of the primary. - -|-h, --help |- |help for list. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-tools.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-tools.adoc deleted file mode 100644 index b94d150e..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-tools.adoc +++ /dev/null @@ -1,35 +0,0 @@ -= rpk ai mcp tools -:description: rpk ai mcp tools -:page-preview: true - -Interact with tools on an MCP server - -== Usage - -[,bash] ----- -rpk ai mcp tools [command] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for tools. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai mcp tools [command] --help" for more information about a command. -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-types.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-types.adoc deleted file mode 100644 index 1d7eb90a..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-types.adoc +++ /dev/null @@ -1,35 +0,0 @@ -= rpk ai mcp types -:description: rpk ai mcp types -:page-preview: true - -List available managed MCP types - -== Usage - -[,bash] ----- -rpk ai mcp types [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for types. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-update.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-update.adoc deleted file mode 100644 index e9deb4bb..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp-update.adoc +++ /dev/null @@ -1,47 +0,0 @@ -= rpk ai mcp update -:description: rpk ai mcp update -:page-preview: true - -Update an MCP server - -== Usage - -[,bash] ----- -rpk ai mcp update [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--description |string |human-readable description of the server. - -|--enabled |- |whether server is enabled (default true). - -|-h, --help |- |help for update. - -|--transport |string |new transport. - -|--url |string |new server URL. - -|--user-oauth-provider |string |for remote servers: name of the OAuthProvider whose per-user tokens should authenticate upstream requests. Managed MCPs carry their own auth oneof inside the per-MCP config and are not updated via this flag. - -|--user-oauth-scopes |strings |minimum OAuth scopes a user's connection must have (user_oauth.required_scopes). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp.adoc deleted file mode 100644 index 48e3f2e7..00000000 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-mcp.adoc +++ /dev/null @@ -1,42 +0,0 @@ -= rpk ai mcp -:description: rpk ai mcp -:page-preview: true - -Manage MCP servers (create, get, list, update, delete, types) - -== Usage - -[,bash] ----- -rpk ai mcp [command] ----- - -== Aliases - -[,bash] ----- -mcp, mcp-server ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for mcp. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai mcp [command] --help" for more information about a command. -|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-model-get.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-model-get.adoc index b7666412..b7e3c3f6 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-model-get.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-model-get.adoc @@ -1,37 +1,4 @@ = rpk ai model get -:description: rpk ai model get :page-preview: true -Get model details from the catalog - -== Usage - -[,bash] ----- -rpk ai model get [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for get. - -|--provider-type |string |provider type (for disambiguation when a model is exposed by multiple providers). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-model-get.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-model-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-model-list.adoc index c96fd7ac..2385a7ca 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-model-list.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-model-list.adoc @@ -1,37 +1,4 @@ = rpk ai model list -:description: rpk ai model list :page-preview: true -List available models in the catalog - -== Usage - -[,bash] ----- -rpk ai model list [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for list. - -|--provider-type |string |filter by provider type (openai, openai-compatible, anthropic, google, bedrock). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-model-list.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-model.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-model.adoc index 644bbab2..e756744f 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-model.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-model.adoc @@ -1,48 +1,4 @@ = rpk ai model -:description: rpk ai model :page-preview: true -Discover the models the Redpanda AI gateway exposes. - -The catalog is read-only — `model list` and `model get` are the only verbs. The -catalog is populated from each LLM provider's metadata plus any extras the -operator has pinned to a tenant. - -Aliases: `models`, `m`. - -== Usage - -[,bash] ----- -rpk ai model [command] ----- - -== Aliases - -[,bash] ----- -model, models, m ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for model. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai model [command] --help" for more information about a command. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-model.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-apply.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-apply.adoc index feda6656..656a96bc 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-apply.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-apply.adoc @@ -1,49 +1,4 @@ = rpk ai oauth-client apply -:description: rpk ai oauth-client apply :page-preview: true -Reconcile OAuth clients from one or more YAML manifests. - -For each manifest: create the resource if absent, otherwise update only the -fields that are present in the manifest AND differ from the live resource. -Fields you omit are left untouched; to clear a field, write it explicitly. -Lists, maps and oneof variants replace wholesale. Fields that can only be set -at creation time are immutable; changing one is an error. - -Manifests round-trip with `get -o yaml` for this resource. Pass -f - to -read stdin. - -This does not delete resources absent from the manifests (no prune), and drift -is detected only for the fields a manifest names — see `diff --help`. - -== Usage - -[,bash] ----- -rpk ai oauth-client apply -f [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-f, --filename |strings |manifest file, directory, or - for stdin (repeatable). - -|-h, --help |- |help for apply. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client-apply.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-create.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-create.adoc index a3b86107..9d46bf71 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-create.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-create.adoc @@ -1,55 +1,4 @@ = rpk ai oauth-client create -:description: rpk ai oauth-client create :page-preview: true -Register an OAuth client. The generated client_secret is printed -once to stderr with a "copy this now" banner — it cannot be retrieved -afterward. Store it in whatever secret manager the external tool uses. - -== Usage - -[,bash] ----- -rpk ai oauth-client create [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--allowed-resource |strings |MCP URL this client can request tokens for; "*" = any. repeatable (default [*]). - -|--display-name |string |human-readable display name shown on the consent card (required). - -|--enabled |- |whether the client may request tokens (default true). - -|--grant-types |strings |grant types: authorization_code, refresh_token (default [authorization_code,refresh_token]). - -|-h, --help |- |help for create. - -|--logo-uri |string |https:// logo URI shown on the consent card. - -|--name |string |client name (required; AIP-122 resource identifier). - -|--pkce-required |- |require PKCE (RFC 7636) on authorization requests (default true). - -|--redirect-uri |strings |allowed redirect URI (exact match; repeatable, required). - -|--token-endpoint-auth-method |string |token endpoint auth: client_secret_basic, client_secret_post, none (default "client_secret_basic"). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client-create.adoc[tag=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 index bfcaf54a..043cfabf 100644 --- 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 @@ -1,35 +1,4 @@ = rpk ai oauth-client dcr get -:description: rpk ai oauth-client dcr get :page-preview: true -Show the tenant's DCR settings - -== Usage - -[,bash] ----- -rpk ai oauth-client dcr get [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for get. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client-dcr-get.adoc[tag=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 index 2d9d83bb..e6b5c78d 100644 --- 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 @@ -1,35 +1,4 @@ = rpk ai oauth-client dcr iat list -:description: rpk ai oauth-client dcr iat list :page-preview: true -List Initial Access Tokens (plaintext is never shown) - -== Usage - -[,bash] ----- -rpk ai oauth-client dcr iat list [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for list. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client-dcr-iat-list.adoc[tag=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 index 132e5abb..2eb88ead 100644 --- 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 @@ -1,39 +1,4 @@ = rpk ai oauth-client dcr iat mint -:description: rpk ai oauth-client dcr iat mint :page-preview: true -Mint a one-shot Initial Access Token - -== Usage - -[,bash] ----- -rpk ai oauth-client dcr iat mint [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for mint. - -|--label |string |human-readable label shown in the IAT list (recommended). - -|--ttl |duration |validity window, e.g. 1h, 24h, 168h (0 = server default of 1h; ceiling 720h). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client-dcr-iat-mint.adoc[tag=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 index 4f071d0b..63808c9b 100644 --- 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 @@ -1,37 +1,4 @@ = rpk ai oauth-client dcr iat revoke -:description: rpk ai oauth-client dcr iat revoke :page-preview: true -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. - -== Usage - -[,bash] ----- -rpk ai oauth-client dcr iat revoke [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for revoke. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client-dcr-iat-revoke.adoc[tag=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 index b2011c5e..3c308969 100644 --- 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 @@ -1,38 +1,4 @@ = rpk ai oauth-client dcr iat -:description: rpk ai oauth-client dcr iat :page-preview: true -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. - -== Usage - -[,bash] ----- -rpk ai oauth-client dcr iat [command] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for iat. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai oauth-client dcr iat [command] --help" for more information about a command. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client-dcr-iat.adoc[tag=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 index 8630b324..cfc9fdb4 100644 --- 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 @@ -1,61 +1,4 @@ = rpk ai oauth-client dcr update -:description: rpk ai oauth-client dcr update :page-preview: true -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: - - rpk ai oauth-client dcr update --enabled --admission-mode open - -Require admin-minted Initial Access Tokens instead: - - rpk ai oauth-client dcr update --admission-mode initial-access-token - -Turn the endpoint off again: - - rpk ai oauth-client dcr update --enabled=false - -== Usage - -[,bash] ----- -rpk ai oauth-client dcr update [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--admission-mode |string |how callers are admitted: open, initial-access-token. - -|--allowed-resource |strings |MCP URL every DCR-issued client may request tokens for; "*" = any. repeatable. - -|--client-cap |int32 |max concurrent DCR-issued clients (0 = runtime default). - -|--enabled |- |whether the public registration endpoint accepts requests. - -|-h, --help |- |help for update. - -|--inactive-ttl-days |int32 |days of inactivity before a DCR client is removed (0 = never). - -|--rate-per-hour |int32 |max registrations per hour (0 = runtime default). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client-dcr-update.adoc[tag=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 index f5bb46d8..c6c846c8 100644 --- 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 @@ -1,46 +1,4 @@ = rpk ai oauth-client dcr -:description: rpk ai oauth-client dcr :page-preview: true -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: - - 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. - -== Usage - -[,bash] ----- -rpk ai oauth-client dcr [command] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for dcr. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai oauth-client dcr [command] --help" for more information about a command. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client-dcr.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-delete.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-delete.adoc index 8f007b02..f88d7028 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-delete.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-delete.adoc @@ -1,35 +1,4 @@ = rpk ai oauth-client delete -:description: rpk ai oauth-client delete :page-preview: true -Delete an OAuth client - -== Usage - -[,bash] ----- -rpk ai oauth-client delete [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for delete. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client-delete.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-diff.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-diff.adoc index d2c258c8..f1e46561 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-diff.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-diff.adoc @@ -1,43 +1,4 @@ = rpk ai oauth-client diff -:description: rpk ai oauth-client diff :page-preview: true -Dry-run of apply for OAuth clients. Prints, per manifest, whether apply would -create, update (and which fields), or leave the resource unchanged. Exits -non-zero when any change is pending, so CI can gate on "no drift". - -Note: diff proves only that the fields a manifest names match live. It does not -detect resources that exist live but are absent from the manifests (no prune), -nor drift in fields a manifest omits. - -== Usage - -[,bash] ----- -rpk ai oauth-client diff -f [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-f, --filename |strings |manifest file, directory, or - for stdin (repeatable). - -|-h, --help |- |help for diff. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client-diff.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-get.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-get.adoc index 5bcb7847..134af7a9 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-get.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-get.adoc @@ -1,35 +1,4 @@ = rpk ai oauth-client get -:description: rpk ai oauth-client get :page-preview: true -Get an OAuth client - -== Usage - -[,bash] ----- -rpk ai oauth-client get [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for get. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client-get.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-list.adoc index 5cb1d873..d4636f0d 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-list.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-list.adoc @@ -1,37 +1,4 @@ = rpk ai oauth-client list -:description: rpk ai oauth-client list :page-preview: true -List OAuth clients - -== Usage - -[,bash] ----- -rpk ai oauth-client list [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--filter-name |string |filter by name (contains). - -|-h, --help |- |help for list. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client-list.adoc[tag=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 index cacc731d..afc18c2b 100644 --- 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 @@ -1,40 +1,4 @@ = rpk ai oauth-client revoke-tokens -:description: rpk ai oauth-client revoke-tokens :page-preview: true -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. - -== Usage - -[,bash] ----- -rpk ai oauth-client revoke-tokens [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for revoke-tokens. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client-revoke-tokens.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-update.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-update.adoc new file mode 100644 index 00000000..3a369403 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client-update.adoc @@ -0,0 +1,4 @@ += rpk ai oauth-client update +:page-preview: true + +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client-update.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client.adoc index b3b06501..bdc722f4 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-client.adoc @@ -1,51 +1,4 @@ = rpk ai oauth-client -:description: rpk ai oauth-client :page-preview: true -Manage OAuth clients registered with the AI gateway's in-dataplane -OAuth Authorization Server. - -An OAuthClient is the external tool (Claude.ai, ChatGPT, Cursor, …) that -requests access tokens for an MCP. Create one per tool you want to allow -in; the client_secret is returned exactly once on create and cannot be -retrieved afterward. Rotate via delete + re-create until Phase 2 lands -a dedicated rotation RPC. - -Aliases: `oauth-clients`, `oc`. - -== Usage - -[,bash] ----- -rpk ai oauth-client [command] ----- - -== Aliases - -[,bash] ----- -oauth-client, oauth-clients, oc ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for oauth-client. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai oauth-client [command] --help" for more information about a command. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-client.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-apply.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-apply.adoc index e752ecda..2caaafd6 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-apply.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-apply.adoc @@ -1,49 +1,4 @@ = rpk ai oauth-provider apply -:description: rpk ai oauth-provider apply :page-preview: true -Reconcile OAuth providers from one or more YAML manifests. - -For each manifest: create the resource if absent, otherwise update only the -fields that are present in the manifest AND differ from the live resource. -Fields you omit are left untouched; to clear a field, write it explicitly. -Lists, maps and oneof variants replace wholesale. Fields that can only be set -at creation time are immutable; changing one is an error. - -Manifests round-trip with `get -o yaml` for this resource. Pass -f - to -read stdin. - -This does not delete resources absent from the manifests (no prune), and drift -is detected only for the fields a manifest names — see `diff --help`. - -== Usage - -[,bash] ----- -rpk ai oauth-provider apply -f [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-f, --filename |strings |manifest file, directory, or - for stdin (repeatable). - -|-h, --help |- |help for apply. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-provider-apply.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-create.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-create.adoc index 0daca563..c19d87a5 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-create.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-create.adoc @@ -1,60 +1,4 @@ = rpk ai oauth-provider create -:description: rpk ai oauth-provider create -:page-aliases: rpk/rpk-ai/rpk-ai-oauth-create.adoc :page-preview: true -Create an OAuth provider - -== Usage - -[,bash] ----- -rpk ai oauth-provider create [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--auth-endpoint |string |OAuth authorization endpoint URL (required). - -|--client-id |string |OAuth client ID (required). - -|--client-secret-ref |string |secret name for the client secret (UPPER_SNAKE_CASE). - -|--display-name |string |human-readable display name (required). - -|--enabled |- |whether provider is enabled (default true). - -|--grant-types |strings |grant types: browser-consent, token-exchange (default [browser-consent]). - -|-h, --help |- |help for create. - -|--name |string |provider name (required). - -|--pkce |- |require PKCE for authorization code grants. - -|--revocation-endpoint |string |OAuth token revocation endpoint URL. - -|--scopes |strings |default OAuth scopes. - -|--token-auth-method |string |token endpoint auth: client-secret-basic, client-secret-post, none (default "client-secret-basic"). - -|--token-endpoint |string |OAuth token endpoint URL (required). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-provider-create.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-delete.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-delete.adoc index f48c2a1d..184d77fb 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-delete.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-delete.adoc @@ -1,36 +1,4 @@ = rpk ai oauth-provider delete -:description: rpk ai oauth-provider delete -:page-aliases: rpk/rpk-ai/rpk-ai-oauth-delete.adoc :page-preview: true -Delete an OAuth provider - -== Usage - -[,bash] ----- -rpk ai oauth-provider delete [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for delete. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-provider-delete.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-diff.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-diff.adoc index 137359f0..3d5e3bd5 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-diff.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-diff.adoc @@ -1,43 +1,4 @@ = rpk ai oauth-provider diff -:description: rpk ai oauth-provider diff :page-preview: true -Dry-run of apply for OAuth providers. Prints, per manifest, whether apply would -create, update (and which fields), or leave the resource unchanged. Exits -non-zero when any change is pending, so CI can gate on "no drift". - -Note: diff proves only that the fields a manifest names match live. It does not -detect resources that exist live but are absent from the manifests (no prune), -nor drift in fields a manifest omits. - -== Usage - -[,bash] ----- -rpk ai oauth-provider diff -f [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-f, --filename |strings |manifest file, directory, or - for stdin (repeatable). - -|-h, --help |- |help for diff. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-provider-diff.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-get.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-get.adoc index 03bc0ee9..c7ac21cc 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-get.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-get.adoc @@ -1,36 +1,4 @@ = rpk ai oauth-provider get -:description: rpk ai oauth-provider get -:page-aliases: rpk/rpk-ai/rpk-ai-oauth-get.adoc :page-preview: true -Get an OAuth provider - -== Usage - -[,bash] ----- -rpk ai oauth-provider get [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for get. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-provider-get.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-list.adoc index 9318326b..11656028 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-list.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-list.adoc @@ -1,38 +1,4 @@ = rpk ai oauth-provider list -:description: rpk ai oauth-provider list -:page-aliases: rpk/rpk-ai/rpk-ai-oauth-list.adoc :page-preview: true -List OAuth providers - -== Usage - -[,bash] ----- -rpk ai oauth-provider list [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--filter-name |string |filter by name (contains). - -|-h, --help |- |help for list. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-provider-list.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-update.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-update.adoc index aa2c60fe..ce3a12f1 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-update.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider-update.adoc @@ -1,52 +1,4 @@ = rpk ai oauth-provider update -:description: rpk ai oauth-provider update -:page-aliases: rpk/rpk-ai/rpk-ai-oauth-update.adoc :page-preview: true -Update an OAuth provider - -== Usage - -[,bash] ----- -rpk ai oauth-provider update [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--auth-endpoint |string |new authorization endpoint URL. - -|--client-secret-ref |string |new client secret reference. - -|--display-name |string |new display name. - -|--enabled |- |whether provider is enabled (default true). - -|-h, --help |- |help for update. - -|--pkce |- |require PKCE. - -|--revocation-endpoint |string |new revocation endpoint URL. - -|--scopes |strings |new default scopes. - -|--token-endpoint |string |new token endpoint URL. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-provider-update.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider.adoc index e91bc179..913c0324 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-oauth-provider.adoc @@ -1,48 +1,4 @@ = rpk ai oauth-provider -:description: rpk ai oauth-provider -:page-aliases: rpk/rpk-ai/rpk-ai-oauth.adoc :page-preview: true -Manage OAuth authorization-server configurations registered with the Redpanda AI gateway. - -OAuth providers describe third-party authorization servers (GitHub, Google, Slack, ...) -that user-facing MCP servers can authenticate against via the device-consent flow. - -Aliases: `oauth`, `op`. - -== Usage - -[,bash] ----- -rpk ai oauth-provider [command] ----- - -== Aliases - -[,bash] ----- -oauth-provider, oauth, op ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for oauth-provider. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai oauth-provider [command] --help" for more information about a command. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-oauth-provider.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-apply.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-apply.adoc new file mode 100644 index 00000000..665d855e --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-apply.adoc @@ -0,0 +1,4 @@ += rpk ai policy apply +:page-preview: true + +include::streaming:reference:partial$rpk-ai/rpk-ai-policy-apply.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-create.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-create.adoc new file mode 100644 index 00000000..dad08424 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-create.adoc @@ -0,0 +1,4 @@ += rpk ai policy create +:page-preview: true + +include::streaming:reference:partial$rpk-ai/rpk-ai-policy-create.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-delete.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-delete.adoc new file mode 100644 index 00000000..f0e5ccb2 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-delete.adoc @@ -0,0 +1,4 @@ += rpk ai policy delete +:page-preview: true + +include::streaming:reference:partial$rpk-ai/rpk-ai-policy-delete.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-diff.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-diff.adoc new file mode 100644 index 00000000..2a91acf5 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-diff.adoc @@ -0,0 +1,4 @@ += rpk ai policy diff +:page-preview: true + +include::streaming:reference:partial$rpk-ai/rpk-ai-policy-diff.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-get.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-get.adoc new file mode 100644 index 00000000..d9b17296 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-get.adoc @@ -0,0 +1,4 @@ += rpk ai policy get +:page-preview: true + +include::streaming:reference:partial$rpk-ai/rpk-ai-policy-get.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-list.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-list.adoc new file mode 100644 index 00000000..7adb344c --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-list.adoc @@ -0,0 +1,4 @@ += rpk ai policy list +:page-preview: true + +include::streaming:reference:partial$rpk-ai/rpk-ai-policy-list.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-update.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-update.adoc new file mode 100644 index 00000000..0f87fd0f --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy-update.adoc @@ -0,0 +1,4 @@ += rpk ai policy update +:page-preview: true + +include::streaming:reference:partial$rpk-ai/rpk-ai-policy-update.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy.adoc new file mode 100644 index 00000000..f49ae82e --- /dev/null +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-policy.adoc @@ -0,0 +1,4 @@ += rpk ai policy +:page-preview: true + +include::streaming:reference:partial$rpk-ai/rpk-ai-policy.adoc[tag=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 index 746c30cf..95621303 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-run-claude.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-run-claude.adoc @@ -1,95 +1,4 @@ = rpk ai run claude -:description: rpk ai run claude :page-preview: true -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. - -Both auth modes run in your REAL Claude Code config home, so your workspace -trust, onboarding, theme, and MCP servers all apply. rpai writes nothing into -~/.claude in either mode: - - - managed (api key): the gateway apiKeyHelper (`rpk ai auth token`, which Claude - Code re-runs to refresh the bearer; aigw injects the upstream Anthropic key) - is passed via `claude --settings` as a JSON string — off disk, merged on top - of your settings, your ~/.claude/settings.json untouched. - - passthrough (enterprise/Max subscription): your existing subscription login - (stored under your config home) is used. rpai only sets the gateway base URL - and the X-Redpanda-Cloud-Token header (minted fresh at launch) in the - environment; your subscription OAuth flows through aigw to Anthropic untouched. - -Pass --claude-config-dir to run against an isolated config home instead of your -real one (rpai still never writes into it). - -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 `rpk ai 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. - -Anthropic and Bedrock providers are supported. A bedrock provider launches -Claude Code in its native Bedrock mode pointed at the same gateway prefix; aigw -signs the upstream call with the provider's AWS credentials (SigV4), so no AWS -keys ever reach your machine and the managed apiKeyHelper auth works exactly as -above (passthrough does not apply — there is no Bedrock analog of a Claude -subscription). Pass -m an inference-profile id from the provider's model -allowlist (Bedrock Anthropic models 4.6+ carry a us./eu./apac./global. prefix). -Claude Code's background (small/fast) model defaults to a Haiku-class inference -profile in Bedrock mode; if the provider's allowlist doesn't include it, export -ANTHROPIC_SMALL_FAST_MODEL with an allowlisted id. - -Pass Claude Code's own flags after a literal --: - - rpk ai run claude -L anthropic -m claude-sonnet-4-6 -- --permission-mode plan - rpk ai run claude -L bedrock -m us.anthropic.claude-sonnet-4-6 -- -p "hi" - -== Usage - -[,bash] ----- -rpk ai run claude [flags] [-- CLAUDE_ARGS...] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--bedrock |- |force bedrock mode. Only needed when you have invoke-only access and rpai can't read the provider to detect its type; when the provider can be read, its own type wins. - -|--claude-config-dir |string |run against this CLAUDE_CONFIG_DIR instead of your real/inherited config home (rpai never writes into it; the managed apiKeyHelper rides in --settings). Default: your real home, so trust/onboarding/theme/MCP all apply. - -|-h, --help |- |help for claude. - -|-L, --llmprovider |string |aigw LLM provider name to route through (an anthropic or bedrock provider). - -|-m, --model |string |model id to use (must be in the provider's allowlist; for bedrock providers an inference-profile id like us.anthropic.claude-sonnet-4-6); omit to let Claude Code pick its default. - -|--passthrough |- |force passthrough (enterprise/subscription) auth mode. Only needed when you have invoke-only access and rpai can't read the provider to detect the mode; when the provider can be read, its own setting wins. - -|--print-settings |- |print the generated Claude Code settings.json plus launch env, then exit (no claude needed; the provider type/mode resolve via a best-effort gateway lookup — offline the dump falls back to the managed anthropic shape, or bedrock with --bedrock). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-run-claude.adoc[tag=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 index af173a72..ea2df12e 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-run-codex.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-run-codex.adoc @@ -1,63 +1,4 @@ = rpk ai run codex -:description: rpk ai run codex :page-preview: true -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 `rpk ai 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 --: - - rpk ai run codex -L openai -m gpt-5.3-codex -e high -- --ask-for-approval never - -== Usage - -[,bash] ----- -rpk ai run codex [flags] [-- CODEX_ARGS...] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--codex-home |string |persistent CODEX_HOME dir (default: a throwaway temp dir); its config.toml is regenerated each run and the dir is tightened to 0700 — your real ~/.codex is refused. - -|-e, --effort |string |model reasoning effort: minimal{vbar}low{vbar}medium{vbar}high (omit to let Codex use its default). - -|-h, --help |- |help for codex. - -|-L, --llmprovider |string |aigw LLM provider name to route through (must be openai/openai_compatible). - -|-m, --model |string |model id to use (must be in the provider's allowlist); omit to let Codex pick its default. - -|--no-auto-trust |- |do not pre-trust the launch directory; let Codex show its normal first-run trust prompt instead (default: the launch dir is auto-trusted under a workspace-write sandbox). - -|--print-config |- |print the generated Codex config.toml and exit (no gateway call, no codex needed). - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-run-codex.adoc[tag=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 index c203c49c..19cd7bd2 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-run.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-run.adoc @@ -1,37 +1,4 @@ = rpk ai run -:description: rpk ai run :page-preview: true -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. - -== Usage - -[,bash] ----- -rpk ai run [command] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for run. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai) Use "rpk ai run [command] --help" for more information about a command. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-run.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-uninstall.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-uninstall.adoc index 4370259c..87a6848c 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-uninstall.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-uninstall.adoc @@ -1,31 +1,4 @@ = rpk ai uninstall -:description: rpk ai uninstall :page-preview: true -Uninstall the Redpanda AI CLI - -== Usage - -[,bash] ----- -rpk ai uninstall [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |Help for uninstall. - -|--config |string |Redpanda or rpk config file; default search paths are "/var/lib/redpanda/.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 |- |Ignore rpk.yaml and redpanda.yaml; use default settings. - -|--profile |string |rpk profile to use. - -|-v, --verbose |- |Enable verbose logging. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-uninstall.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-upgrade.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-upgrade.adoc index c9d99f4f..b2242e19 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-upgrade.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-upgrade.adoc @@ -1,33 +1,4 @@ = rpk ai upgrade -:description: rpk ai upgrade :page-preview: true -Upgrade to the latest Redpanda AI CLI version - -== Usage - -[,bash] ----- -rpk ai upgrade [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |Help for upgrade. - -|--no-confirm |- |Disable confirmation prompt for major version upgrades. - -|--config |string |Redpanda or rpk config file; default search paths are "/var/lib/redpanda/.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 |- |Ignore rpk.yaml and redpanda.yaml; use default settings. - -|--profile |string |rpk profile to use. - -|-v, --verbose |- |Enable verbose logging. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-upgrade.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai-version.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai-version.adoc index 77e4e374..6825d992 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai-version.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai-version.adoc @@ -1,35 +1,4 @@ = rpk ai version -:description: rpk ai version :page-preview: true -Print rpk ai version and commit - -== Usage - -[,bash] ----- -rpk ai version [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |help for version. - -|-o, --format |string |output format: table{vbar}wide{vbar}json{vbar}yaml{vbar}markdown (env: RPAI_FORMAT) (default "table"). - -|--no-color |- |disable colored output (env: NO_COLOR). - -|-c, --rpai-config |string |path to rpai config (env: RPAI_CONFIG) (default "/var/lib/redpanda/.rpai/config"). - -|-s, --rpai-endpoint |string |override the selected environment's AI Gateway URL for this invocation. - -|-p, --rpai-profile |string |rpai profile name (env: RPAI_PROFILE). - -|-v, --rpai-verbose |- |verbose debug logging to stderr (env: RPAI_VERBOSE). - -|--token |string |static bearer token override (ambient RPAI_TOKEN is ignored under rpk ai). -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai-version.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-ai/rpk-ai.adoc b/modules/reference/pages/rpk/rpk-ai/rpk-ai.adoc index 7dd3eed1..4e932fc5 100644 --- a/modules/reference/pages/rpk/rpk-ai/rpk-ai.adoc +++ b/modules/reference/pages/rpk/rpk-ai/rpk-ai.adoc @@ -1,32 +1,4 @@ = rpk ai -:description: rpk ai :page-preview: true -Manage the Redpanda AI Gateway - -== Usage - -[,bash] ----- -rpk ai [flags] -rpk ai [command] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |Help for ai. - -|--config |string |Redpanda or rpk config file; default search paths are "/var/lib/redpanda/.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 |- |Ignore rpk.yaml and redpanda.yaml; use default settings. - -|--profile |string |rpk profile to use. - -|-v, --verbose |- |Enable verbose logging. -|=== \ No newline at end of file +include::streaming:reference:partial$rpk-ai/rpk-ai.adoc[tag=single-source]