Introduction to Eliza

As seen powering @DegenSpartanAI and @aixvc_agent

What is Eliza?

Eliza is a powerful multi-agent simulation framework designed to create, deploy, and manage autonomous AI agents. Built with TypeScript, it provides a flexible and extensible platform for developing intelligent agents that can interact across multiple platforms while maintaining consistent personalities and knowledge.

Pro tip: copy paste the text from https://eliza.how/llms-full.txt into your preferred LLM.

Key Features

New in the Eliza v2 beta!

CLI Tool	Native GUI

• Platform Integration: Clients for Discord, X (Twitter), Telegram, and many others
• Flexible Model Support: Deepseek, Ollama, Grok, OpenAI, Anthropic, Gemini, LLama, etc.
• Character System: Create diverse agents using character files
• Multi-Agent Architecture: Manage multiple unique AI personalities simultaneously
• Memory Management: Easily ingest and interact with documents using RAG
• Media Processing: PDF, URLs, Audio transcription, Video processing, Image analysis, Conversation summarization
• Technical Foundation:
  • 100% TypeScript implementation
  • Modular architecture
  • Highly extensible action and plugin system
  • Custom client support
  • Comprehensive API

---

Installation

For detailed instructions on each path, including configuration options and extended capabilities, see our Quickstart Guide.

Prerequisites

• Node.js 23+
• Git for version control
• For Windows Users: WSL 2 is required

Eliza offers different paths depending on your goals:

Install CLI Tool (Recommended)

# make sure you have bun installed
npm install -g bun

# Install the CLI globally
npm install -g @elizaos/cli@beta # will be simpler after beta
# or install via bun
bun install -g @elizaos/cli@beta

# From a folder to install a project
elizaos create
cd new-agent
elizaos start

Then visit https://localhost:3000 to interact with your agent through a web interface.

Create a Test Project

# Create a new project through interactive setup
npx @elizaos/cli@beta create # will be simpler after beta

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

# Start your project
npx @elizaos/cli@beta start

Add a Custom Plugin

Add plugins to your project:

# List available plugins
elizaos plugins list

# Add a plugin
elizaos plugins add @elizaos/plugin-discord

# Create a plugin project
elizaos create --type plugin

Develop and test your plugin:

# Test your plugin
elizaos start

# Publish your plugin when ready
elizaos plugin publish

Contribute to ElizaOS Core

# Clone the repository
git clone git@github.com:elizaOS/eliza.git
cd eliza

# We are currently on the v2-develop branch
git checkout v2-develop

# Install dependencies and build
bun install
bun run build

# Start ElizaOS
bun start

Visit https://localhost:3000 to interact with your agent through a web interface.

If it fails the first time try the start command again

---

Community and Support

Eliza is backed by an active community of developers and users:

• Open Source: Contribute to the project on GitHub
• Technical Report (Whitepaper)
• Awesome Eliza
• Examples: Ready-to-use character templates and implementations
• Support: Active community for troubleshooting and discussion

Join us in building the future of autonomous AI agents with Eliza!