​
Usage

elizaos agent [options] [command]

​
Subcommands

SubcommandAliasesDescriptionRequired OptionsAdditional Options
listlsList available agents-j, --json, -r, --remote-url <url>, -p, --port <port>
getgGet agent details-n, --name <name>-j, --json, -o, --output [file], -r, --remote-url, -p, --port
startsStart an agent with a character profileOne of: -n, --name, --path, --remote-character-r, --remote-url <url>, -p, --port <port>
stopstStop an agent-n, --name <name>-r, --remote-url <url>, -p, --port <port>
removermRemove an agent-n, --name <name>-r, --remote-url <url>, -p, --port <port>
setUpdate agent configuration-n, --name <name> AND one of: -c, --config OR -f, --file-r, --remote-url <url>, -p, --port <port>
clear-memoriesclearClear all memories for an agent-n, --name <name>-r, --remote-url <url>, -p, --port <port>

​
Options Reference

​
Common Options (All Subcommands)

  • -r, --remote-url <url>: URL of the remote agent runtime
  • -p, --port <port>: Port to listen on

​
Output Options (for list and get)

  • -j, --json: Output as JSON format instead of the default table format.
  • -o, --output [file]: For the get command, saves the agent’s configuration to a JSON file. If no filename is provided, defaults to {name}.json.

​
Get Specific Options

  • -n, --name <name>: Agent id, name, or index number from list (required)

​
Start Specific Options

  • -n, --name <name>: Name of an existing agent to start
  • --path <path>: Path to local character JSON file
  • --remote-character <url>: URL to remote character JSON file

​
Stop/Remove Specific Options

  • -n, --name <name>: Agent id, name, or index number from list (required)

​
Set Specific Options

  • -n, --name <name>: Agent id, name, or index number from list (required)
  • -c, --config <json>: Agent configuration as JSON string
  • -f, --file <path>: Path to agent configuration JSON file

​
Clear Memories Specific Options

  • -n, --name <name>: Agent id, name, or index number from list (required)