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
5 changes: 3 additions & 2 deletions content/docs/agents/deploy/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,13 @@ If you plan to deploy your agent to a Kubernetes cluster in a cloud provider env

1. Deploy the agent to your cluster.
```sh
arctl agent deploy myagent --runtime kubernetes --namespace default
arctl deployments create myagent --type agent --provider-id kubernetes-default --namespace default
```

Example output:
```console
Agent 'myagent' version 'latest' deployed to kubernetes runtime in namespace 'default'
Waiting for agent 'myagent' to become ready...
Agent 'myagent' version 'latest' deployed to providerId=kubernetes-default in namespace 'default'
```

2. **Local test setups only**: Revert the changes that you previously made to your kubeconfig file.
Expand Down
8 changes: 4 additions & 4 deletions content/docs/agents/deploy/local.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,18 @@ Local deployments spin up Docker containers on your local machine from images th

2. Deploy the agent to your local environment. The following command spins up a Docker container by using Docker compose.
```sh
arctl agent deploy myagent --runtime local
arctl deployments create myagent --type agent
```

3. List the containers in your environment. Verify that you see a container with the `ghcr.io/myagent:latest` image.
```sh
docker ps
arctl deployments list
```

Example output:
```console
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
816ad44cba11 ghcr.io/myagent:latest "kagent-adk run --ho…" About a minute ago Up About a minute 0.0.0.0:40529->40529/tcp, [::]:40529->40529/tcp
ID NAME VERSION TYPE PROVIDER STATUS AGE
e817f070 myagent 0.1.0 agent local deployed 5s
```

{{% /tab %}}
Expand Down
2 changes: 1 addition & 1 deletion content/docs/agents/skills.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ The agent can then load and use the skills from the `/skills` folder at runtime.
When you deploy an agent that references skills to Kubernetes, agentregistry resolves the skills and adds them to the Agent custom resource (CR). The kagent operator then handles pulling the skills into the agent pod.

```sh
arctl agent deploy myagent --provider-id kubernetes-default
arctl deployments create myagent --type agent --provider-id kubernetes-default
```

During deployment, arctl:
Expand Down
2 changes: 1 addition & 1 deletion content/docs/mcp/deploy/local.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Local deployments spin up Docker containers on your local machine from images th

2. Deploy the MCP server to your local environment. The following command spins up a Docker container from the `user/my-mcp-server` artifact reference that is published in agentregistry.
```sh
arctl mcp deploy user/my-mcp-server --runtime local --version 0.1.0
arctl deployments create user/my-mcp-server --type mcp --version 0.1.0
```

Example output:
Expand Down
18 changes: 11 additions & 7 deletions content/docs/reference/cli/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,7 @@ description:
{{< card link="arctl-agent-build" title="arctl agent build" >}}
{{< card link="arctl-agent-run" title="arctl agent run" >}}
{{< card link="arctl-agent-publish" title="arctl agent publish" >}}
{{< card link="arctl-agent-deploy" title="arctl agent deploy" >}}
{{< card link="arctl-agent-delete" title="arctl agent delete" >}}
{{< card link="arctl-agent-remove" title="arctl agent remove" >}}
{{< card link="arctl-agent-unpublish" title="arctl agent unpublish" >}}
{{< card link="arctl-agent-add-mcp" title="arctl agent add-mcp" >}}
{{< card link="arctl-agent-add-prompt" title="arctl agent add-prompt" >}}

Expand All @@ -48,10 +45,7 @@ description:
{{< card link="arctl-mcp-build" title="arctl mcp build" >}}
{{< card link="arctl-mcp-run" title="arctl mcp run" >}}
{{< card link="arctl-mcp-publish" title="arctl mcp publish" >}}
{{< card link="arctl-mcp-deploy" title="arctl mcp deploy" >}}
{{< card link="arctl-mcp-remove" title="arctl mcp remove" >}}
{{< card link="arctl-mcp-delete" title="arctl mcp delete" >}}
{{< card link="arctl-mcp-unpublish" title="arctl mcp unpublish" >}}

{{< /cards >}}

Expand All @@ -67,7 +61,17 @@ description:
{{< card link="arctl-skill-pull" title="arctl skill pull" >}}
{{< card link="arctl-skill-remove" title="arctl skill remove" >}}
{{< card link="arctl-skill-delete" title="arctl skill delete" >}}
{{< card link="arctl-skill-unpublish" title="arctl skill unpublish" >}}

{{< /cards >}}

## Deployment Commands

{{< cards >}}

{{< card link="arctl-deployments-create" title="arctl deployments create" >}}
{{< card link="arctl-deployments-list" title="arctl deployments list" >}}
{{< card link="arctl-deployments-show" title="arctl deployments show" >}}
{{< card link="arctl-deployments-delete" title="arctl deployments delete" >}}

{{< /cards >}}

Expand Down
34 changes: 0 additions & 34 deletions content/docs/reference/cli/arctl-agent-deploy.md

This file was deleted.

27 changes: 0 additions & 27 deletions content/docs/reference/cli/arctl-agent-remove.md

This file was deleted.

30 changes: 0 additions & 30 deletions content/docs/reference/cli/arctl-agent-unpublish.md

This file was deleted.

41 changes: 41 additions & 0 deletions content/docs/reference/cli/arctl-deployments-create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: arctl deployments create
weight: 10
---

Create a deployment for an agent or MCP server from the registry.

## Usage

```sh
arctl deployments create <name> [flags]
```

Example:
```sh
arctl deployments create my-agent --type agent --version latest
arctl deployments create my-agent --type agent --version 1.2.3
arctl deployments create my-agent --type agent --provider-id kubernetes-default --namespace my-namespace
arctl deployments create my-mcp-server --type mcp --version 1.0.0
arctl deployments create my-mcp-server --type mcp -e KEY=VALUE -a ARG=value
```

## Command-specific flags

```sh
--type string: Resource type to deploy (agent or mcp) (required)
--version string: Version to deploy (default "latest")
--provider-id string: Deployment target provider ID (default "local")
--namespace string: Kubernetes namespace for deployment
--wait: Wait for the deployment to become ready before returning (default true)
--prefer-remote: Prefer using a remote source when available
-e, --env stringArray: Environment variables to set (KEY=VALUE)
-a, --arg stringArray: Runtime arguments for MCP servers (KEY=VALUE)
--header stringArray: HTTP headers for remote MCP servers (KEY=VALUE)
```

## Global flags
```sh
-v, --verbose: Enable verbose output.
-h, --help: Display help information for the command.
```
26 changes: 26 additions & 0 deletions content/docs/reference/cli/arctl-deployments-delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: arctl deployments delete
weight: 10
---

Delete a deployment by its ID. This removes the deployment record and tears down any associated resources.

## Usage

```sh
arctl deployments delete <deployment-id>
```

Example:
```sh
arctl deployments delete abc12345
arctl deployments delete abc12345-def6-7890-ghij-klmnopqrstuv
```

The deployment ID can be the full ID or a unique prefix (as shown in `arctl deployments list`).

## Global flags
```sh
-v, --verbose: Enable verbose output.
-h, --help: Display help information for the command.
```
37 changes: 37 additions & 0 deletions content/docs/reference/cli/arctl-deployments-list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: arctl deployments list
weight: 10
---

List all deployments (agents and MCP servers).

## Usage

```sh
arctl deployments list [flags]
```

Example:
```sh
arctl deployments list
arctl deployments list --type agent
arctl deployments list --type mcp
arctl deployments list --status deployed
arctl deployments list --provider local
arctl deployments list -o json
```

## Command-specific flags

```sh
--type string: Filter by resource type (agent or mcp)
--status string: Filter by deployment status (deploying, deployed, failed, cancelled, discovered)
--provider string: Filter by provider ID
-o, --output string: Output format (table, json) (default "table")
```

## Global flags
```sh
-v, --verbose: Enable verbose output.
-h, --help: Display help information for the command.
```
33 changes: 33 additions & 0 deletions content/docs/reference/cli/arctl-deployments-show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: arctl deployments show
weight: 10
---

Show detailed information about a deployment, including its status, provider, environment variables, and endpoint URL.

## Usage

```sh
arctl deployments show <deployment-id> [flags]
```

Example:
```sh
arctl deployments show eb2d8231
arctl deployments show eb2d8231-def6-7890-ghij-klmnopqrstuv
arctl deployments show eb2d8231 -o json
```

The deployment ID can be the full ID or a unique prefix (as shown in `arctl deployments list`).

## Command-specific flags

```sh
-o, --output string: Output format (table, json) (default "table")
```

## Global flags
```sh
-v, --verbose: Enable verbose output.
-h, --help: Display help information for the command.
```
38 changes: 0 additions & 38 deletions content/docs/reference/cli/arctl-mcp-deploy.md

This file was deleted.

Loading