For the complete documentation index, see llms.txt. Markdown versions of all docs pages are available by appending .md to any docs URL.
CLI docs
Review the reference docs for the kagent CLI commands.
Review the kagent CLI commands and learn how to use them effectively.
kagent agent- Discover agents and work with their conversationskagent apply- Create or update an Agent or AgentTemplatekagent bug-report- Generate a bug reportkagent completion- Generate the autocompletion script for the specified shellkagent config- Inspect and validate configurationkagent dashboard- Open the kagent dashboardkagent db- Database operations (migrations, inspection)kagent install- Install kagentkagent sandbox- Run commands and transfer files in standalone sandboxeskagent uninstall- Uninstall kagentkagent version- Print the kagent version
kagent agent
Discover agents and work with their conversations.
kagent agent get
Get an Agent.
kagent agent invoke
Invoke a Session.
kagent agent list
List Agents.
kagent agent session
Manage agent conversations.
kagent agent session create
Create a Session.
kagent agent session delete
Delete a Session.
kagent agent session get
Get a Session.
kagent agent session list
List your Sessions.
kagent agent session push
Manage A2A task push callbacks.
kagent agent session push create
Add or replace a task callback.
kagent agent session push delete
Remove a task callback.
kagent agent session push get
Get a task callback.
kagent agent session push list
List active task callbacks.
kagent agent template
Discover reusable agent templates.
kagent agent template get
Get an AgentTemplate.
kagent agent template list
List AgentTemplates.
kagent apply
Create or update an Agent or AgentTemplate.
kagent bug-report
Generate a bug report.
kagent completion
Generate the autocompletion script for the specified shell.
kagent completion bash
Generate the autocompletion script for bash.
kagent completion fish
Generate the autocompletion script for fish.
kagent completion powershell
Generate the autocompletion script for powershell.
kagent completion zsh
Generate the autocompletion script for zsh.
kagent config
Inspect and validate configuration.
kagent config schema
Print the protobuf descriptor set, including validation rules.
kagent config validate
Validate configuration without connecting to services.
kagent config view
Print effective configuration without expanding secret files.
kagent dashboard
Open the kagent dashboard.
kagent db
Database operations (migrations, inspection).
kagent db migrate
Apply, roll back, and inspect database migrations.
kagent db migrate down
Roll back the latest N migrations.
kagent db migrate goto
Move one source to version V.
kagent db migrate status
Show migration status.
kagent db migrate up
Apply all pending migrations.
kagent db migrate version
Show the applied migration version.
kagent install
Install kagent.
kagent sandbox
Run commands and transfer files in standalone sandboxes.
kagent sandbox create
Create a sandbox from a prepared template.
kagent sandbox delete
delete a sandbox.
kagent sandbox download
Download a file, replacing the local destination only after success.
kagent sandbox exec
Start a command once and wait for its result.
kagent sandbox get
get a sandbox.
kagent sandbox kill
Terminate a process and its children.
kagent sandbox list
List your sandboxes.
kagent sandbox process
Inspect process status without waiting.
kagent sandbox resume
resume a sandbox.
kagent sandbox suspend
suspend a sandbox.
kagent sandbox templates
List SandboxTemplates in the selected namespace.
kagent sandbox upload
Stream a local file into a sandbox (replaces the remote file).
kagent sandbox wait
Collect output and wait for an existing process without restarting it.
kagent uninstall
Uninstall kagent.
kagent version
Print the kagent version.