ElizaOS CLI

The ElizaOS Command Line Interface (CLI) provides a comprehensive set of tools to create, manage, and interact with ElizaOS projects and agents.

Installation

Install the ElizaOS CLI globally using Bun:

bun install -g @elizaos/cli

Available Commands

Command	Description
create	Initialize a new project, plugin, or agent
monorepo	Clone ElizaOS monorepo from a specific branch (defaults to develop)
plugins	Manage ElizaOS plugins
agent	Manage ElizaOS agents
tee	Manage TEE deployments
start	Start the Eliza agent with configurable plugins and services
update	Update ElizaOS CLI and project dependencies
test	Run tests for Eliza agent projects and plugins
env	Manage environment variables and secrets
dev	Start the project or plugin in development mode with auto-rebuild, detailed logging, and file change detection
publish	Publish a plugin to the registry

Global Options

These options apply to all commands:

Option	Description
--help, -h	Display help information
--version, -v	Display version information

Output and Logging

• --no-emoji: Disables emoji characters in the output. This is useful for CI/CD environments or terminals that do not render emojis correctly.
• --verbose: Enables verbose logging, providing detailed, step-by-step output for debugging purposes.
• --quiet: Suppresses all non-essential output, showing only critical errors.

Configuration

• --config <path>: Specifies a path to a custom configuration file, overriding the default configuration.
• --no-auto-install: Disables the automatic prompt to install Bun if it is not detected.

Examples

Controlling Output

# Get verbose output for the start command for debugging
elizaos --verbose start

# Run tests with clean output for a CI/CD pipeline
elizaos --no-emoji --quiet test

Using a Custom Configuration

# Start the agent using a specific configuration file
elizaos --config ./path/to/my-config.json start

Getting Information

# Check your CLI version
elizaos --version

# Get help for the 'agent' command
elizaos agent --help

# Get help for the 'agent start' subcommand
elizaos agent start --help

Project Structure

For detailed information about project and plugin structure, see the Quickstart Guide.

Environment Configuration

Configure your API keys and environment variables with the env command:

# Edit local environment variables interactively
elizaos env edit-local

# List all environment variables
elizaos env list

# Interactive environment manager
elizaos env interactive

Development vs Production

ElizaOS supports two main modes of operation:

1. Development Mode (dev command)

   • Hot reloading
   • Detailed error messages
   • File watching
   • See Dev Command for details

2. Production Mode (start command)

   • Optimized performance
   • Production-ready configuration
   • See Start Command for details

Quick Start

For a complete guide to getting started with ElizaOS, see the Quickstart Guide.

Creating a new project

# Create a new project using the interactive wizard
elizaos create

# Or specify a name directly
elizaos create my-agent-project

Starting a project

# Navigate to your project directory
cd my-agent-project

# Start the project
elizaos start

Development mode

# Run in development mode with hot reloading
elizaos dev

Working with Projects

ElizaOS organizes work into projects, which can contain one or more agents along with their configurations, knowledge files, and dependencies. The CLI provides commands to manage the entire lifecycle of a project:

1. Create a new project with create
2. Configure settings with env
3. Develop using dev for hot reloading
4. Test functionality with test
5. Start in production with start
6. Share by publishing with publish

Working with Plugins

Plugins extend the functionality of your agents. Use the plugins command for managing plugins and publish for publishing your own:

# List available plugins
elizaos plugins list

# Add a plugin to your project
elizaos plugins add @elizaos/plugin-discord

# Publish your plugin (from plugin directory)
elizaos publish

# Test publishing without making changes
elizaos publish --test

Related Documentation

• Quickstart Guide: Complete workflow guide
• Environment Configuration: Managing environment variables

---