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 npm:
npm install -g @elizaos/cli@beta
Or use it directly with npx:
npx @elizaos/cli@beta [command]
Available Commands
Command | Description |
---|---|
create | Create new projects, plugins, or agents |
start | Start an ElizaOS project or agent |
dev | Run a project in development mode with hot reloading |
agent | Manage agent configurations and state |
plugin | Develop and publish plugins |
project | Manage project configuration and settings |
env | Configure environment variables and API keys |
publish | Publish packages to npm registry |
update | Update ElizaOS components |
update-cli | Update the ElizaOS CLI itself |
test | Run tests for your project |
tee | Manage TEE (Trusted Execution Environment) deployments |
Global Options
These options apply to most commands:
Option | Description |
---|---|
--help , -h | Display help information |
--version , -v | Display version information |
--debug | Enable debug logging |
--quiet | Suppress non-essential output |
--json | Output results in JSON format |
Project Structure
For detailed information about project and plugin structure, see the Quickstart Guide.
Environment Configuration
For detailed information about environment configuration, see the Environment Command documentation.
Development vs Production
ElizaOS supports two main modes of operation:
-
Development Mode (
dev
command)- Hot reloading
- Detailed error messages
- File watching
- See Dev Command for details
-
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.
Related Documentation
- Quickstart Guide: Complete workflow guide
- Environment Configuration: Managing environment variables
Quick Start
Note: This assumes you installed the CLI tool (
npm install -g @elizaos/cli@beta
)
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:
- Create a new project with
create
- Configure settings with
env
- Develop using
dev
for hot reloading - Test functionality with
test
- Start in production with
start
- Share by publishing with
publish
Working with Plugins
Plugins extend the functionality of your agents. Use the plugin
command for development tasks like publishing your own plugins.
To add or remove plugins from your project, use the project
command (see project
command documentation).
# Example: Publish the plugin in the current directory (requires setup)
elizaos plugin publish
# Example: Test publishing the plugin to npm
elizaos plugin publish --npm --test
Environment Configuration
Configure your API keys and environment variables with the env
command:
# Set OpenAI API key
elizaos env set OPENAI_API_KEY your-api-key
# List all environment variables
elizaos env list