Skip to content
This documentation covers the kagent 1.0 alpha. For the latest 0.x release, see the 0.x docs.

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

Page as Markdown

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 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 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 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 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 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.