Documentation

kagent run#

Run an agent project locally with docker-compose and launch an interactive chat interface.

kagent run [project-directory] [flags]

Arguments:

  • project-directory - The directory containing the agent project (default: current directory)

Flags:

  • --build - Rebuild the Docker image before running
  • --project-dir - Project directory (default: current directory)

Global Flags:

  • --kagent-url - kagent URL (default: "http://localhost:8083")
  • --namespace, -n - Namespace (default: "kagent")
  • --output-format, -o - Output format (default: "table")
  • --timeout - Timeout duration (default: 300s)
  • --verbose, -v - Verbose output

About kagent run#

The kagent run command runs an agent project locally using docker-compose and launches an interactive chat session. This way, you can test and interact with your agent before deploying it to a Kubernetes cluster.

Rebuilding before running#

Use the --build flag to rebuild the Docker image before running the agent. This is useful when you've made changes to your agent code and want to test the updated version without manually running kagent build first.

kagent run --build

This command rebuilds the agent image and then starts the interactive chat interface. It's equivalent to running kagent build followed by kagent run.

Example#

Run an agent project from the current directory:

kagent run

Run an agent project from a specific directory:

kagent run ./my-agent

Rebuild the image and run the agent:

kagent run --build

This is useful after making code changes to ensure you're testing the latest version of your agent.

Kagent Lab: Discover kagent and kmcp
Free, on‑demand lab: build custom AI agents with kagent and integrate tools via kmcp on Kubernetes.
Start the Lab