For the complete documentation index, see llms.txt. Markdown versions of all docs pages are available by appending .md to any docs URL.

arctl init agent

Page as Markdown

Scaffold an agent project with YAML and framework stubs.

Scaffold a new agent project with declarative YAML and framework stubs.

Picks a framework + language interactively (or via --framework / --language). Writes:

  • agent.yaml — v1alpha1 envelope
  • arctl.yaml — local build config (framework + language)
  • .env — env vars the chosen framework needs (gitignored)

To wire a sibling arctl-init’d MCP project for local dev, pass --local-mcp. For an MCP at an arbitrary URL (remote, or local-not-arctl), edit .env after init and add an MCP_SERVERS_CONFIG entry, e.g.:

MCP_SERVERS_CONFIG=[{"name":"my-remote","type":"remote","url":"https://mcp.example.com/sse"}]

Usage

arctl init agent NAME [flags]

Examples:

arctl init agent myagent
arctl init agent myagent --framework adk --language python
arctl init agent myagent --local-mcp ../my-mcp

Command-specific flags

    --description string      Agent description
    --framework string        Framework (e.g. adk). Skips picker.
    --git string              Git repository URL
    --git-branch string       Git branch to record on the agent's source repository
    --git-commit string       Git commit SHA to pin the agent's source repository to
    --image string            Image tag override
    --language string         Language (e.g. python). Skips picker.
    --local-mcp strings       Path to a sibling MCP project; wires it into .env so the local agent can reach it. Repeatable.
    --mcp strings             Registry MCP server ref (name@version). Repeatable.
    --model-name string       Model name
    --model-provider string   Model provider

Global flags

-h, --help                    Display help information for the command.
    --output-dir string       Parent directory under which the project is created. Defaults to the current directory.
    --registry-token string   Registry bearer token (defaults to value of ARCTL_API_TOKEN env var)
    --registry-url string     Registry URL (overrides ARCTL_API_BASE_URL env var; defaults to http://localhost:12121)

See also

  • arctl init - Scaffold a declarative agent, MCP, skill, or prompt project