​
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

CommandDescription
createInitialize a new project, plugin, or agent
monorepoClone ElizaOS monorepo from a specific branch (defaults to develop)
pluginsManage ElizaOS plugins
agentManage ElizaOS agents
teeManage TEE deployments
startStart the Eliza agent with configurable plugins and services
updateUpdate ElizaOS CLI and project dependencies
testRun tests for Eliza agent projects and plugins
envManage environment variables and secrets
devStart the project or plugin in development mode with auto-rebuild, detailed logging, and file change detection
publishPublish a plugin to the registry

​
Global Options

These options apply to all commands:

OptionDescription
--help, -hDisplay help information
--version, -vDisplay version information
--no-emojiDisables emoji characters in the output
--no-auto-installDisables the automatic prompt to install Bun if it is not detected

​
Examples

​
Getting Version 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:

Development Mode

Hot reloading, detailed error messages, and file watching for rapid development.

Production Mode

Optimized performance and production-ready configuration for deployment.

​
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

Quickstart Guide

Complete workflow guide to get started with ElizaOS

Environment Configuration

Managing environment variables and configuration