Agentic Data Plane

rpk ai docs

Read published Agentic Data Plane guides and command references without signing in.

With no path, browse a searchable picker in an interactive terminal, or print an index when piped. Page paths are relative to the ADP documentation, such as cli or connect/coding-agents. Full ADP documentation URLs also work.

In a terminal, output renders Markdown with less -FRX in secure mode when available. The PAGER environment variable is not used. Piped output is plain Markdown. Use -o json or -o yaml for structured documents and catalogs, -o markdown for raw Markdown, or --non-interactive to avoid prompts and paging. The default table and wide formats select terminal-aware output.

Search matches catalog titles, paths, and descriptions, not page bodies. Documentation tracks the published website, not your installed CLI version. Use a command’s --help output for the flags your installation supports.

Responses are cached for one hour. On temporary network failures, an older cached response is returned with a warning and stale=true in structured output. Use --refresh to require a fresh response instead.

This command was introduced in ai version 0.2.92.

Usage

rpk ai docs [flags]

Examples

This section provides examples of how to use rpk ai docs.

rpk ai docs
rpk ai docs cli
rpk ai docs search "oauth"
rpk ai docs search "mcp server create" -o json
rpk ai docs connect/coding-agents --web
rpk ai docs cli --url

Subcommands

Command Description

rpk ai docs search

Search guide and command-reference titles, paths and descriptions.

Flags

Value Type Description

--no-pager

bool

write directly to the terminal without a pager.

--non-interactive

bool

print plain Markdown without a picker or pager.

--refresh

bool

require fresh documentation; do not fall back to cached content.

--url

bool

print URLs without opening them (page URLs need no network).

--web

bool

open the page in your browser instead of reading it.

Global flags

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.