Agent Command

The agent command allows you to manage, configure, and interact with ElizaOS agents. Use this command to list, get information, start, stop, and update your agents.

Global Options

These options can be used with any agent subcommand:

• -r, --remote-url <url>: Specify the URL of the remote agent runtime. Overrides the AGENT_RUNTIME_URL environment variable.

Usage

Install the CLI first (npm install -g @elizaos/cli@beta)

elizaos agent <action> [options]

Actions

Action	Description
list, ls	List all agents
get, g	Show detailed information about a specific agent
start, s	Start an agent using a character definition
stop, st	Stop a running agent
remove, rm	Remove an agent definition
set	Update agent configuration

Options

The available options vary by action:

Option	Action(s)	Description	Required
-n, --name <name>	get,stop,rm,set	Agent ID, name, or index number from list	Yes
-n, --name <name>	start	Character name to start the agent with	No
-j, --json	list, get	Output in JSON format	No
-j, --json <json>	start	Character configuration as a JSON string	No
-p, --path <path>	start	Local path to character JSON file	No
-rc, --remote-character <url>	start	Remote URL to character JSON file	No
-c, --config <json>	set	Agent configuration as JSON string	No
-f, --file <path>	set	Path to agent configuration JSON file	No
-o, --output <file>	get	Output agent configuration to file (requires --json, default: {name}.json)	No

Usage Examples

List & Get Agents

# List all agents with their status
elizaos agent list

# List in JSON format
elizaos agent list --json

# Get detailed information about an agent
elizaos agent get --name customer-support

# Save agent configuration to file
elizaos agent get --name customer-support --json --output ./my-agent.json

Start & Stop Agents

# Start an agent by name
elizaos agent start --name customer-support

# Start from local JSON file
elizaos agent start --path ./agents/my-agent.json

# Start from remote URL
elizaos agent start --remote-character https://example.com/agents/my-agent.json

# Stop a running agent
elizaos agent stop --name customer-support

Update & Remove Agents

# Update agent configuration using JSON string
elizaos agent set --name customer-support --config '{"llm": {"model": "gpt-4-turbo"}}'

# Update configuration from file
elizaos agent set --name customer-support --file ./updated-config.json

# Remove an agent
elizaos agent remove --name old-agent

Agent Configuration

ElizaOS agents are configured through a combination of:

• Agent definition file
• Knowledge files
• Runtime configuration options

A typical agent definition looks like:

{
  "id": "customer-support",
  "name": "Customer Support Bot",
  "description": "Helps customers with common questions and issues",
  "character": {
    "persona": "You are a friendly and knowledgeable customer support agent.",
    "goals": ["Resolve customer issues efficiently", "Provide accurate information"],
    "constraints": [
      "Never share private customer information",
      "Escalate complex issues to human agents"
    ]
  },
  "llm": {
    "provider": "openai",
    "model": "gpt-4",
    "temperature": 0.7
  },
  "knowledge": [
    "./knowledge/shared/company-info.md",
    "./knowledge/customer-support/faq.md",
    "./knowledge/customer-support/policies.md"
  ],
  "services": {
    "discord": { "enabled": true, "channels": ["support"] },
    "web": { "enabled": true }
  }
}

FAQ

How do I fix "Agent not found" errors?

Check available agents using elizaos agent list and try using the agent ID directly with elizaos agent get --name agent_123456.

What should I do if I encounter configuration errors?

Validate your JSON syntax using a proper JSON validator and check the structure against the expected schema in the agent configuration example.

How do I resolve connection issues with the agent runtime?

First check if the runtime is running with elizaos start. If using a different address than the default (http://localhost:3000), set the AGENT_RUNTIME_URL environment variable: AGENT_RUNTIME_URL=http://my-server:3000 elizaos agent list.

Related Commands

• create: Create a new project with agents
• start: Start your project with agents
• dev: Run your project in development mode
• env: Configure environment variables