CLI

Reference documentation for the arctl command-line interface.

The arctl command-line interface (CLI) is the primary tool for managing agents, MCP servers, skills, and prompts in AgentRegistry.

Installation

Download and install the arctl CLI:

curl -sSL https://storage.googleapis.com/agentregistry-enterprise/install.sh | ARCTL_VERSION=v2026.9.0 sh
export PATH=$HOME/.arctl/bin:$PATH

After you install the CLI, you must authenticate it against your OIDC provider before you can run commands. For the full setup, including login, see the Get started guide.

Quick start

# Scaffold a new agent project
arctl init agent my-agent

# Run the agent locally
arctl run ./my-agent

# Apply resources to the registry
arctl apply -f my-agent/agent.yaml

# List all agents
arctl get agents

Environment variables

You can configure arctl using the following environment variables:

Variable	Description
`ARCTL_API_TOKEN`	Registry bearer token for authentication
`ARCTL_API_BASE_URL`	Registry base URL (default: http://localhost:12121)

Global flags

All commands support the following global flags:

-h, --help: Display help information for the command.
--registry-token string: Registry bearer token (overrides ARCTL_API_TOKEN).
--registry-url string: Registry URL (overrides ARCTL_API_BASE_URL; default http://localhost:12121).

Commands

Install the CLI

Where to find the steps for installing the arctl command-line interface.

arctl

arctl is a CLI tool for managing agents, MCP servers, skills, and prompts.

arctl apply

Apply one or more registry resources from a YAML file

arctl bug-report

Collect registry resources and installation logs

arctl build

Build a Docker image for a declarative resource project

arctl completion

Generate the autocompletion script for the specified shell

arctl completion bash

Generate the autocompletion script for bash

arctl completion fish

Generate the autocompletion script for fish

arctl completion powershell

Generate the autocompletion script for powershell

arctl completion zsh

Generate the autocompletion script for zsh

arctl configure

Write the JSON config a client needs to connect to arctl

arctl configure claude-code

Configure Claude Code

arctl configure cursor

Configure Cursor AI Editor

arctl configure kiro

Configure Kiro agentic IDE

arctl configure vscode

Configure Visual Studio Code

arctl db

Database operations (migrations, inspection)

arctl db migrate

Apply, roll back, and inspect database migrations

arctl db migrate down

Roll back the N most-recent applied migrations for the selected source

arctl db migrate force

Mark version V as applied without running its SQL

arctl db migrate status

Show how many migrations are applied vs pending across all sources

arctl db migrate up

Apply all pending migrations across every registered source

arctl db migrate version

Print the highest applied migration version

arctl delete

Delete a registry resource by type and name, or from a file

arctl get

List or retrieve registry resources by type

arctl init

Scaffold a declarative agent, MCP, skill, or prompt project

arctl init agent

Scaffold an agent project with YAML and framework stubs

arctl init mcp

Scaffold an MCP server project with YAML and framework stubs

arctl init prompt

Create a declarative prompt YAML (ar.dev/v1alpha1)

arctl init skill

Scaffold a skill project with YAML and source stubs

arctl pull

Fetch a registry resource’s source repo to a local directory

arctl run

Run the agent or MCP server in the current project directory

arctl runtime

Runtime bootstrap helpers

arctl runtime setup

Generate runtime bootstrap configuration

arctl runtime setup bedrock-agent-core

Generate AWS bootstrap artifacts for the BedrockAgentCore runtime

arctl user

User management

arctl user info

Print the user info from the stored token

arctl user login

arctl user logout

Logout from the enterprise CLI

arctl user whoami

Show current user identity and roles

arctl version

Display the arctl CLI and registry server versions

arctl wait

Wait for a registry resource to reach a target state

arctl wrap-agent-image

Wrap an agent image with the agent-proxy layer

Changelogs Helm