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 add-mcp- Add an MCP server entry to kagent.yamlkagent bug-report- Generate a bug reportkagent build- Build a Docker images for an agent projectkagent completion- Generate the autocompletion script for the specified shellkagent dashboard- Open the kagent dashboardkagent db- Database operations (migrations, inspection)kagent deploy- Deploy an agent to Kuberneteskagent get- Get a kagent resourcekagent init- Initialize a new agent projectkagent install- Install kagentkagent invoke- Invoke a kagent agentkagent mcp- MCP (Model Context Protocol) server managementkagent run- Run agent project locally with docker-compose and launch chat interfacekagent uninstall- Uninstall kagentkagent version- Print the kagent version
kagent add-mcp
Add an MCP server entry to kagent.yaml.
kagent bug-report
Generate a bug report.
kagent build
Build a Docker images for an agent project.
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 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 N most-recent applied migrations for the selected source.
kagent db migrate force
Mark version V as applied without running its SQL.
kagent db migrate goto
Move the selected source’s schema to version V.
kagent db migrate status
Show how many migrations are applied vs pending across all sources.
kagent db migrate up
Apply all pending migrations across every registered source.
kagent db migrate version
Print the highest applied migration version.
kagent deploy
Deploy an agent to Kubernetes.
kagent get
Get a kagent resource.
kagent get agent
Get an agent or list all agents.
kagent get session
Get a session or list all sessions.
kagent get tool
Get tools.
kagent init
Initialize a new agent project.
kagent install
Install kagent.
kagent invoke
Invoke a kagent agent.
kagent mcp
MCP (Model Context Protocol) server management.
kagent mcp add-tool
Add a new MCP tool to your project.
kagent mcp build
Build MCP server as a Docker image.
kagent mcp deploy
Deploy MCP server to Kubernetes.
kagent mcp deploy package
Deploy an MCP server using a package manager (npx, uvx).
kagent mcp init
Initialize a new MCP server project.
kagent mcp init go
Initialize a new Go MCP server project.
kagent mcp init java
Initialize a new Java MCP server project.
kagent mcp init python
Initialize a new Python MCP server project.
kagent mcp init typescript
Initialize a new TypeScript MCP server project.
kagent mcp run
Run MCP server locally.
kagent mcp secrets
Manage project secrets.
kagent mcp secrets sync
Sync secrets to a Kubernetes environment from a local .env file.
kagent run
Run agent project locally with docker-compose and launch chat interface.
kagent uninstall
Uninstall kagent.
kagent version
Print the kagent version.