Merge pull request #272 from kagent-dev/adb-cli

CLI doc updates

Author: peterj

public/sitemap.xml

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

src/app/docs/kagent/introduction/installation/page.mdx

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

src/app/docs/kagent/resources/cli/kagent-build/page.mdx

@@ -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:**
@@ -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
+```

src/app/docs/kagent/resources/cli/kagent-completion/page.mdx

@@ -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
+

src/app/docs/kagent/resources/cli/kagent-deploy/page.mdx

@@ -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")
@@ -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
+```
+

src/app/docs/kagent/resources/cli/kagent-help/page.mdx

@@ -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)
+

src/app/docs/kagent/resources/cli/page.mdx

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

src/app/docs/kagent/resources/helm/page.mdx

@@ -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" |  |

src/app/docs/kmcp/reference/kmcp-completion/page.mdx

@@ -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
+

src/app/docs/kmcp/reference/kmcp-help/page.mdx

@@ -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]
+```
+