Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions public/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,13 @@
<priority>0.8</priority>
</url>

<url>
<loc>https://kagent.dev/docs/kagent/resources/cli/kagent-completion</loc>
<lastmod>2025-11-20</lastmod>
<changefreq>weekly</changefreq>
<priority>0.8</priority>
</url>

<url>
<loc>https://kagent.dev/docs/kagent/resources/cli/kagent-dashboard</loc>
<lastmod>2025-11-20</lastmod>
Expand All @@ -259,6 +266,13 @@
<priority>0.8</priority>
</url>

<url>
<loc>https://kagent.dev/docs/kagent/resources/cli/kagent-help</loc>
<lastmod>2025-11-20</lastmod>
<changefreq>weekly</changefreq>
<priority>0.8</priority>
</url>

<url>
<loc>https://kagent.dev/docs/kagent/resources/cli/kagent-init</loc>
<lastmod>2025-11-20</lastmod>
Expand Down Expand Up @@ -490,13 +504,27 @@
<priority>0.8</priority>
</url>

<url>
<loc>https://kagent.dev/docs/kmcp/reference/kmcp-completion</loc>
<lastmod>2025-11-20</lastmod>
<changefreq>weekly</changefreq>
<priority>0.8</priority>
</url>

<url>
<loc>https://kagent.dev/docs/kmcp/reference/kmcp-deploy</loc>
<lastmod>2025-11-20</lastmod>
<changefreq>weekly</changefreq>
<priority>0.8</priority>
</url>

<url>
<loc>https://kagent.dev/docs/kmcp/reference/kmcp-help</loc>
<lastmod>2025-11-20</lastmod>
<changefreq>weekly</changefreq>
<priority>0.8</priority>
</url>

<url>
<loc>https://kagent.dev/docs/kmcp/reference/kmcp-init</loc>
<lastmod>2025-11-20</lastmod>
Expand Down
26 changes: 26 additions & 0 deletions src/app/docs/kagent/introduction/installation/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,32 @@ Another way to install kagent is using Helm.
```
</div>

## Advanced Configuration

Review the following advanced configuration options that you might want to set up for your kagent installation.

### Configure the controller service name

By default, kagent uses `kagent-controller` as the controller service name when constructing URLs for agent deployments. If you need to customize this name, set the `KAGENT_CONTROLLER_NAME` environment variable on the controller pod.

**Helm `--set` flag:**

```bash
helm install kagent oci://ghcr.io/kagent-dev/kagent/helm/kagent \
--namespace kagent \
--set controller.env[0].name=KAGENT_CONTROLLER_NAME \
--set controller.env[0].value=my-kagent
```

**Helm values file:**

```yaml
controller:
env:
- name: KAGENT_CONTROLLER_NAME
value: my-kagent
```

## Uninstallation

Refer to the [Uninstall](/docs/kagent/operations/uninstall) guide.
Expand Down
7 changes: 7 additions & 0 deletions src/app/docs/kagent/resources/cli/kagent-build/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ kagent build [project-directory] [flags]

**Flags:**
- `--image` - Full image specification (e.g., ghcr.io/myorg/my-agent:v1.0.0)
- `--platform` - Target platform for Docker build (e.g., linux/amd64, linux/arm64)
- `--push` - Push the image to the registry

**Global Flags:**
Expand Down Expand Up @@ -53,3 +54,9 @@ Build and push an image to a registry:
```bash
kagent build ./my-agent --image ghcr.io/myorg/my-agent:v1.0.0 --push
```

Build for a specific platform:

```bash
kagent build ./my-agent --platform linux/amd64 --image ghcr.io/myorg/my-agent:v1.0.0
```
25 changes: 25 additions & 0 deletions src/app/docs/kagent/resources/cli/kagent-completion/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "kagent completion"
pageOrder: 40
description: "kagent completion command"
---

# `kagent completion`

Generate the autocompletion script for kagent for the specified shell. See each sub-command's help for details on how to use the generated script.

```bash
kagent completion [command]
```

**Global Flags:**
- `--config` - config file
- `--kagent-url` - KAgent URL (default "http://localhost:8083")
- `--timeout` - Timeout (default 5m0s)

**Subcommands:**
- `bash` - Generate the autocompletion script for bash
- `fish` - Generate the autocompletion script for fish
- `powershell` - Generate the autocompletion script for powershell
- `zsh` - Generate the autocompletion script for zsh

7 changes: 7 additions & 0 deletions src/app/docs/kagent/resources/cli/kagent-deploy/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ kagent deploy [project-directory] [flags]
- `--dry-run` - Output YAML manifests without applying them to the cluster
- `--image, -i` - Image to use (defaults to `localhost:5001/{agentName}:latest`)
- `--namespace` - Kubernetes namespace to deploy to
- `--platform` - Target platform for Docker build (e.g., linux/amd64, linux/arm64)

**Global Flags:**
- `--kagent-url` - kagent URL (default: "http://localhost:8083")
Expand Down Expand Up @@ -69,3 +70,9 @@ Generate manifests without deploying:
kagent deploy ./my-agent --api-key "your-api-key" --dry-run > manifests.yaml
```

Deploy with a specific platform for the Docker build:

```bash
kagent deploy ./my-agent --env-file .env --platform linux/amd64
```

19 changes: 19 additions & 0 deletions src/app/docs/kagent/resources/cli/kagent-help/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: "kagent help"
pageOrder: 150
description: "kagent help command"
---

# `kagent help`

Help provides help for any command in the `kagent` CLI.

```bash
kagent help [command] [flags]
```

**Global Flags:**
- `--config` - config file
- `--kagent-url` - KAgent URL (default "http://localhost:8083")
- `--timeout` - Timeout (default 5m0s)

19 changes: 10 additions & 9 deletions src/app/docs/kagent/resources/cli/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,20 @@ import QuickLink from '@/components/quick-link';
</div>

<div className="grid grid-cols-1 md:grid-cols-2 gap-6 mb-12">
<QuickLink title="kagent init" description="Create a bootstrap agent project" href="/docs/kagent/resources/cli/kagent-init" />
<QuickLink title="kagent add-mcp" description="Add an MCP server entry to kagent.yaml" href="/docs/kagent/resources/cli/kagent-add-mcp" />
<QuickLink title="kagent bug-report" description="Generate a bug report for troubleshooting" href="/docs/kagent/resources/cli/kagent-bug-report" />
<QuickLink title="kagent build" description="Build a Docker image for an agent project" href="/docs/kagent/resources/cli/kagent-build" />
<QuickLink title="kagent completion" description="Generate the autocompletion script for kagent for the specified shell" href="/docs/kagent/resources/cli/kagent-completion" />
<QuickLink title="kagent dashboard" description="Open the kagent dashboard" href="/docs/kagent/resources/cli/kagent-dashboard" />
<QuickLink title="kagent deploy" description="Deploy an agent to Kubernetes" href="/docs/kagent/resources/cli/kagent-deploy" />
<QuickLink title="kagent get" description="Get kagent resources (agents, sessions, tools)" href="/docs/kagent/resources/cli/kagent-get" />
<QuickLink title="kagent help" description="Help provides help for any command in the application" href="/docs/kagent/resources/cli/kagent-help" />
<QuickLink title="kagent init" description="Create a bootstrap agent project" href="/docs/kagent/resources/cli/kagent-init" />
<QuickLink title="kagent install" description="Install kagent on a Kubernetes cluster" href="/docs/kagent/resources/cli/kagent-install" />
<QuickLink title="kagent uninstall" description="Uninstall kagent from a Kubernetes cluster" href="/docs/kagent/resources/cli/kagent-uninstall" />
<QuickLink title="kagent invoke" description="Invoke a kagent agent to perform a task" href="/docs/kagent/resources/cli/kagent-invoke" />
<QuickLink title="kagent get" description="Get kagent resources (agents, sessions, tools)" href="/docs/kagent/resources/cli/kagent-get" />
<QuickLink title="kagent dashboard" description="Open the kagent dashboard" href="/docs/kagent/resources/cli/kagent-dashboard" />
<QuickLink title="kagent version" description="Print the kagent version information" href="/docs/kagent/resources/cli/kagent-version" />
<QuickLink title="kagent bug-report" description="Generate a bug report for troubleshooting" href="/docs/kagent/resources/cli/kagent-bug-report" />
<QuickLink title="kagent add-mcp" description="Add an MCP server entry to kagent.yaml" href="/docs/kagent/resources/cli/kagent-add-mcp" />
<QuickLink title="kagent run" description="Run an agent project locally with docker-compose and launch chat interface" href="/docs/kagent/resources/cli/kagent-run" />
<QuickLink title="kagent mcp" description="MCP server management commands" href="/docs/kagent/resources/cli/kagent-mcp" />
<QuickLink title="kagent run" description="Run an agent project locally with docker-compose and launch chat interface" href="/docs/kagent/resources/cli/kagent-run" />
<QuickLink title="kagent uninstall" description="Uninstall kagent from a Kubernetes cluster" href="/docs/kagent/resources/cli/kagent-uninstall" />
<QuickLink title="kagent version" description="Print the kagent version information" href="/docs/kagent/resources/cli/kagent-version" />
</div>
</div>

2 changes: 1 addition & 1 deletion src/app/docs/kagent/resources/helm/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ A Helm chart for kagent, built with Google ADK
| controller.agentImage.registry | string | "" | |
| controller.agentImage.repository | string | "kagent-dev/kagent/app" | |
| controller.agentImage.tag | string | "" | |
| controller.env | list | [] | |
| controller.env | list | [] | Additional environment variables to set on the controller pod. For example, set `KAGENT_CONTROLLER_NAME` to customize the controller service name used for the kagent controller deployments. |
| controller.image.pullPolicy | string | "" | |
| controller.image.registry | string | "" | |
| controller.image.repository | string | "kagent-dev/kagent/controller" | |
Expand Down
20 changes: 20 additions & 0 deletions src/app/docs/kmcp/reference/kmcp-completion/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "kmcp completion"
pageOrder: 30
description: "kmcp completion command"
---

# `kmcp completion`

Generate the autocompletion script for kmcp for the specified shell. See each sub-command's help for details on how to use the generated script.

```bash
kmcp completion [flags]
```

**Subcommands:**
- `bash` - Generate the autocompletion script for bash
- `fish` - Generate the autocompletion script for fish
- `powershell` - Generate the autocompletion script for powershell
- `zsh` - Generate the autocompletion script for zsh

14 changes: 14 additions & 0 deletions src/app/docs/kmcp/reference/kmcp-help/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: "kmcp help"
pageOrder: 100
description: "kmcp help command"
---

# `kmcp help`

Help provides help for any command in the `kmcp` CLI.

```bash
kmcp help [command] [flags]
```

3 changes: 2 additions & 1 deletion src/app/docs/kmcp/reference/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,11 @@ import QuickLink from '@/components/quick-link';
<QuickLink title="API docs" description="kmcp API reference docs" href="/docs/kmcp/reference/api-ref" />
<QuickLink title="kmcp add-tool" description="Generate an MCP tool boilerplate that you can use as the base to create your own." href="/docs/kmcp/reference/kmcp-add-tool" />
<QuickLink title="kmcp build" description="Build a Docker image for your MCP server." href="/docs/kmcp/reference/kmcp-build" />
<QuickLink title="kmcp completion" description="Generate the autocompletion script for kmcp for the specified shell" href="/docs/kmcp/reference/kmcp-completion" />
<QuickLink title="kmcp deploy" description="Deploy your MCP server to a Kubernetes cluster." href="/docs/kmcp/reference/kmcp-deploy" />
<QuickLink title="kmcp init" description="Create a scaffold for your MCP server project." href="/docs/kmcp/reference/kmcp-init" />
<QuickLink title="kmcp install" description="Install the KMCP controller manager and all its dependencies." href="/docs/kmcp/reference/kmcp-install" />
<QuickLink title="kmcp run" description="Run an MCP server on your local machine." href="/docs/kmcp/reference/kmcp-run" />
<QuickLink title="kmcp secrets" description="Create Kubernetes secrets for the environment variables that you want to use in your MCP server." href="/docs/kmcp/reference/kmcp-secrets" />
</div>
</div>
</div>
10 changes: 10 additions & 0 deletions src/config/navigation.json
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,16 @@
"title": "kmcp secrets",
"href": "/docs/kmcp/reference/kmcp-secrets",
"description": "kmcp secrets command"
},
{
"title": "kmcp completion",
"href": "/docs/kmcp/reference/kmcp-completion",
"description": "kmcp completion command"
},
{
"title": "kmcp help",
"href": "/docs/kmcp/reference/kmcp-help",
"description": "kmcp help command"
}
]
}
Expand Down