diff --git a/public/sitemap.xml b/public/sitemap.xml index f4dca152..3ae5c3de 100644 --- a/public/sitemap.xml +++ b/public/sitemap.xml @@ -238,6 +238,13 @@ 0.8 + + https://kagent.dev/docs/kagent/resources/cli/kagent-completion + 2025-11-20 + weekly + 0.8 + + https://kagent.dev/docs/kagent/resources/cli/kagent-dashboard 2025-11-20 @@ -259,6 +266,13 @@ 0.8 + + https://kagent.dev/docs/kagent/resources/cli/kagent-help + 2025-11-20 + weekly + 0.8 + + https://kagent.dev/docs/kagent/resources/cli/kagent-init 2025-11-20 @@ -490,6 +504,13 @@ 0.8 + + https://kagent.dev/docs/kmcp/reference/kmcp-completion + 2025-11-20 + weekly + 0.8 + + https://kagent.dev/docs/kmcp/reference/kmcp-deploy 2025-11-20 @@ -497,6 +518,13 @@ 0.8 + + https://kagent.dev/docs/kmcp/reference/kmcp-help + 2025-11-20 + weekly + 0.8 + + https://kagent.dev/docs/kmcp/reference/kmcp-init 2025-11-20 diff --git a/src/app/docs/kagent/introduction/installation/page.mdx b/src/app/docs/kagent/introduction/installation/page.mdx index bdfdae36..f47c86be 100644 --- a/src/app/docs/kagent/introduction/installation/page.mdx +++ b/src/app/docs/kagent/introduction/installation/page.mdx @@ -147,6 +147,32 @@ Another way to install kagent is using Helm. ``` +## 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. diff --git a/src/app/docs/kagent/resources/cli/kagent-build/page.mdx b/src/app/docs/kagent/resources/cli/kagent-build/page.mdx index bf82b191..94262ea8 100644 --- a/src/app/docs/kagent/resources/cli/kagent-build/page.mdx +++ b/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 +``` diff --git a/src/app/docs/kagent/resources/cli/kagent-completion/page.mdx b/src/app/docs/kagent/resources/cli/kagent-completion/page.mdx new file mode 100644 index 00000000..53ff353d --- /dev/null +++ b/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 + diff --git a/src/app/docs/kagent/resources/cli/kagent-deploy/page.mdx b/src/app/docs/kagent/resources/cli/kagent-deploy/page.mdx index 9e19e13f..da1f9295 100644 --- a/src/app/docs/kagent/resources/cli/kagent-deploy/page.mdx +++ b/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 +``` + diff --git a/src/app/docs/kagent/resources/cli/kagent-help/page.mdx b/src/app/docs/kagent/resources/cli/kagent-help/page.mdx new file mode 100644 index 00000000..555cd5ea --- /dev/null +++ b/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) + diff --git a/src/app/docs/kagent/resources/cli/page.mdx b/src/app/docs/kagent/resources/cli/page.mdx index cdf820db..acc25196 100644 --- a/src/app/docs/kagent/resources/cli/page.mdx +++ b/src/app/docs/kagent/resources/cli/page.mdx @@ -13,19 +13,20 @@ import QuickLink from '@/components/quick-link';
- + + + + + + + - - - - - - - + + +
- diff --git a/src/app/docs/kagent/resources/helm/page.mdx b/src/app/docs/kagent/resources/helm/page.mdx index b54ed9df..aa1a0856 100644 --- a/src/app/docs/kagent/resources/helm/page.mdx +++ b/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" | | diff --git a/src/app/docs/kmcp/reference/kmcp-completion/page.mdx b/src/app/docs/kmcp/reference/kmcp-completion/page.mdx new file mode 100644 index 00000000..08e6c72f --- /dev/null +++ b/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 + diff --git a/src/app/docs/kmcp/reference/kmcp-help/page.mdx b/src/app/docs/kmcp/reference/kmcp-help/page.mdx new file mode 100644 index 00000000..32a55eb8 --- /dev/null +++ b/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] +``` + diff --git a/src/app/docs/kmcp/reference/page.mdx b/src/app/docs/kmcp/reference/page.mdx index dc286653..82d73570 100644 --- a/src/app/docs/kmcp/reference/page.mdx +++ b/src/app/docs/kmcp/reference/page.mdx @@ -16,10 +16,11 @@ import QuickLink from '@/components/quick-link'; + - \ No newline at end of file + diff --git a/src/config/navigation.json b/src/config/navigation.json index a8aec001..868e41bb 100644 --- a/src/config/navigation.json +++ b/src/config/navigation.json @@ -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" } ] }