Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,35 @@
** xref:reference:rpk/index.adoc[rpk Command Reference]
*** xref:reference:rpk/rpk-ai/rpk-ai.adoc[rpk ai]
**** xref:reference:rpk/rpk-ai/rpk-ai-agent.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a.adoc[]
****** xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-card.adoc[]
****** xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-send.adoc[]
****** xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-task.adoc[]
******* xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-task-cancel.adoc[]
******* xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-task-get.adoc[]
******* xref:reference:rpk/rpk-ai/rpk-ai-agent-a2a-task-watch.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-agent-apply.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-agent-create.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-agent-credential.adoc[]
****** xref:reference:rpk/rpk-ai/rpk-ai-agent-credential-create.adoc[]
****** xref:reference:rpk/rpk-ai/rpk-ai-agent-credential-delete.adoc[]
****** xref:reference:rpk/rpk-ai/rpk-ai-agent-credential-list.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-agent-delete.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-agent-diff.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-agent-get.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-agent-list.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-agent-start.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-agent-stop.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-agent-transcript.adoc[]
****** xref:reference:rpk/rpk-ai/rpk-ai-agent-transcript-get.adoc[]
****** xref:reference:rpk/rpk-ai/rpk-ai-agent-transcript-list.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-agent-update.adoc[]
**** xref:reference:rpk/rpk-ai/rpk-ai-connection.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-connection-list.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-connection-revoke.adoc[]
**** xref:reference:rpk/rpk-ai/rpk-ai-install.adoc[]
**** xref:reference:rpk/rpk-ai/rpk-ai-llm.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-llm-check.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-llm-create.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-llm-delete.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-llm-get.adoc[]
Expand All @@ -110,9 +133,20 @@
***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-update.adoc[]
**** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-create.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr.adoc[]
****** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-get.adoc[]
****** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat.adoc[]
******* xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-list.adoc[]
******* xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-mint.adoc[]
******* xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-iat-revoke.adoc[]
****** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-dcr-update.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-delete.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-get.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-list.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-oauth-client-revoke-tokens.adoc[]
**** xref:reference:rpk/rpk-ai/rpk-ai-run.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-run-claude.adoc[]
***** xref:reference:rpk/rpk-ai/rpk-ai-run-codex.adoc[]
**** xref:reference:rpk/rpk-ai/rpk-ai-uninstall.adoc[]
**** xref:reference:rpk/rpk-ai/rpk-ai-upgrade.adoc[]
**** xref:reference:rpk/rpk-ai/rpk-ai-version.adoc[]
Expand Down
40 changes: 40 additions & 0 deletions modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-card.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
= rpk ai agent a2a card
:description: pass:q[Fetch the A2A agent card — the JSON discovery document describing the agent's identity, skills, supported transports and capabilities. Use `-o` json to feed the raw card to other tools.]
:page-beta: true
:page-platforms: linux

// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc

// tag::single-source[]
Fetch the A2A agent card — the JSON discovery document describing the
agent's identity, skills, supported transports and capabilities.

Use `-o` json to feed the raw card to other tools.

NOTE: This command is only available on Linux.

== Usage

[,bash]
----
rpk ai agent a2a card [flags]
----





== Global flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`.
|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail.
|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings.
|--profile |string |`rpk` profile to use.
|-v, --verbose |bool |Enable verbose logging.
|===

// end::single-source[]
121 changes: 121 additions & 0 deletions modules/reference/pages/rpk/rpk-ai/rpk-ai-agent-a2a-send.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
= rpk ai agent a2a send
:description: Send a text message to an agent over A2A and print the reply. The message comes from the positional argument, or from stdin when the argument is omitted or "-" (so you can pipe a prompt in).
:page-beta: true
:page-platforms: linux

// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc

// tag::single-source[]
Send a text message to an agent over A2A and print the reply.

The message comes from the positional argument, or from stdin when the
argument is omitted or "-" (so you can pipe a prompt in).

By default the call blocks until the agent replies. Replies that spawn a
long-running task print the task id so you can follow up with
`rpai agent a2a task get|watch|cancel`. For work that may outlive
`--timeout` (default 5m), prefer `--stream` or `--no-block` so the task id is
in hand from the start.

Conversation state: every reply prints a context-id (stderr in the
default format, part of the JSON in `-o` json). Pass it back via
`--context-id` to continue the same conversation. When a task ends in
state input-required, answer it by sending again with both `--task-id`
and `--context-id` from the reply.

Output: the agent's reply text goes to stdout; ids and state go to
stderr as `key: value` lines so pipes stay clean. Use `-o` json for the
full A2A response (message or task object). With `--stream`, json and
yaml both emit one JSON event per line (JSONL).

Exit codes: 0 success or input-required, 4 task failed/canceled/
rejected, 1 anything else.

NOTE: This command is only available on Linux.

== Usage

[,bash]
----
rpk ai agent a2a send [flags]
----




== Examples

This section provides examples of how to use `rpk ai agent a2a send`.

# Ask and wait for the answer

[,bash]
----
rpai agent a2a send financial-advisor "What moved the S&P 500 today?"
----


[,bash]
----
# Continue the conversation from a previous reply's context-id
----
[,bash]
----
rpai agent a2a send financial-advisor --context-id CTX "Why?"
----


[,bash]
----
# Answer a task that ended in input-required
----
[,bash]
----
rpai agent a2a send financial-advisor --task-id TASK --context-id CTX "Account A-17"
----


[,bash]
----
# Pipe the prompt from a file, get the full JSON reply
----
[,bash]
----
cat prompt.txt | rpai agent a2a send financial-advisor -o json
----


[,bash]
----
# Stream events as they happen
----
[,bash]
----
rpai agent a2a send financial-advisor --stream "Give me a market summary"
----


[,bash]
----
# Fire-and-forget: submit, then poll with `task get`
----
[,bash]
----
rpai agent a2a send financial-advisor --no-block "Deep analysis please"
----


== Global flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`.
|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail.
|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings.
|--profile |string |`rpk` profile to use.
|-v, --verbose |bool |Enable verbose logging.
|===

// end::single-source[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
= rpk ai agent a2a task cancel
:description: Ask the agent to cancel a running task and print the task's resulting state. Cancellation is cooperative — the agent may already have finished, in which case the terminal state is returned unchanged.
:page-beta: true
:page-platforms: linux

// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc

// tag::single-source[]
Ask the agent to cancel a running task and print the task's resulting
state. Cancellation is cooperative — the agent may already have
finished, in which case the terminal state is returned unchanged.

NOTE: This command is only available on Linux.

== Usage

[,bash]
----
rpk ai agent a2a task cancel [flags]
----




== Examples

This section provides examples of how to use `rpk ai agent a2a task cancel`.

rpai agent a2a task cancel financial-advisor TASK_ID


== Global flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`.
|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail.
|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings.
|--profile |string |`rpk` profile to use.
|-v, --verbose |bool |Enable verbose logging.
|===

// end::single-source[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
= rpk ai agent a2a task get
:description: pass:q[Fetch a task's current state, status message, artifacts and (optionally truncated) message history. Use `-o` json for the full task object.]
:page-beta: true
:page-platforms: linux

// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc

// tag::single-source[]
Fetch a task's current state, status message, artifacts and (optionally
truncated) message history. Use `-o` json for the full task object.

NOTE: This command is only available on Linux.

== Usage

[,bash]
----
rpk ai agent a2a task get [flags]
----




== Examples

This section provides examples of how to use `rpk ai agent a2a task get`.

rpai agent a2a task get financial-advisor TASK_ID

[,bash]
----
rpai agent a2a task get financial-advisor TASK_ID --history 10 -o json
----


== Global flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`.
|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail.
|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings.
|--profile |string |`rpk` profile to use.
|-v, --verbose |bool |Enable verbose logging.
|===

// end::single-source[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
= rpk ai agent a2a task watch
:description: pass:q[Reattach to a running task's event stream (A2A tasks/resubscribe) and print events until the task reaches a terminal state. Use after a disconnected `--stream` send or a `--no-block` send.]
:page-beta: true
:page-platforms: linux

// This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs-extensions-and-macros/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc

// tag::single-source[]
Reattach to a running task's event stream (A2A tasks/resubscribe) and
print events until the task reaches a terminal state. Use after a
disconnected `--stream` send or a `--no-block` send.

Watch waits as long as the task runs (no timeout by default; bound it
with `--timeout`). Exit codes match send: 0 success or input-required,
4 task failed/canceled/rejected, 1 anything else.

NOTE: This command is only available on Linux.

== Usage

[,bash]
----
rpk ai agent a2a task watch [flags]
----




== Examples

This section provides examples of how to use `rpk ai agent a2a task watch`.

rpai agent a2a task watch financial-advisor TASK_ID

[,bash]
----
rpai agent a2a task watch financial-advisor TASK_ID -o json # one JSON event per line
----


== Global flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|--config |string |Redpanda or `rpk` config file; default search paths are "`~/.config/rpk/rpk.yaml"`, `$PWD/redpanda.yaml,` and `/etc/redpanda/redpanda.yaml`.
|-X, --config-opt |stringArray |Override `rpk` configuration settings; '`-X` help' for detail or '`-X` list' for terser detail.
|--ignore-profile |bool |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings.
|--profile |string |`rpk` profile to use.
|-v, --verbose |bool |Enable verbose logging.
|===

// end::single-source[]
Loading