{"id":23494450,"url":"https://github.com/elizaOS/eliza","last_synced_at":"2025-08-27T19:31:08.929Z","repository":{"id":247548424,"uuid":"826170402","full_name":"elizaOS/eliza","owner":"elizaOS","description":"Autonomous agents for everyone","archived":false,"fork":false,"pushed_at":"2025-08-20T15:55:06.000Z","size":1097660,"stargazers_count":16621,"open_issues_count":70,"forks_count":5302,"subscribers_count":152,"default_branch":"develop","last_synced_at":"2025-08-20T16:11:32.074Z","etag":null,"topics":["agent","agentic","ai","autonomous","chatbot","crypto","discord","eliza","elizaos","framework","plugins","rag","slack","swarm","telegram"],"latest_commit_sha":null,"homepage":"https://eliza.how/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elizaOS.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-07-09T07:55:40.000Z","updated_at":"2025-08-20T15:42:21.000Z","dependencies_parsed_at":"2024-07-29T02:28:48.207Z","dependency_job_id":"bdf7a7eb-6567-4f43-98b8-dacfdd4ff4ee","html_url":"https://github.com/elizaOS/eliza","commit_stats":null,"previous_names":["rubyresearch/rubyagent","rubyresearch/agent","rubyresearch/eliza","lalalune/eliza","elizaos/eliza"],"tags_count":253,"template":false,"template_full_name":null,"purl":"pkg:github/elizaOS/eliza","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elizaOS%2Feliza","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elizaOS%2Feliza/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elizaOS%2Feliza/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elizaOS%2Feliza/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elizaOS","download_url":"https://codeload.github.com/elizaOS/eliza/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elizaOS%2Feliza/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271404621,"owners_count":24753786,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-20T02:00:09.606Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agent","agentic","ai","autonomous","chatbot","crypto","discord","eliza","elizaos","framework","plugins","rag","slack","swarm","telegram"],"created_at":"2024-12-25T03:02:43.960Z","updated_at":"2025-08-27T19:31:08.920Z","avatar_url":"https://github.com/elizaOS.png","language":"TypeScript","readme":"# Eliza\n\nA framework for multi-agent development and deployment\n\n## ✨ Features\n\n- 🛠️ Full-featured Discord, Telegram, and Farcaster connectors (and many more!)\n- 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, Gemini, etc.)\n- 🎨 Modern and professional UI with a redesigned dashboard for managing agents and groups.\n- 💬 Robust real-time communication with enhanced channel and message handling.\n- 👥 Multi-agent and group support with intuitive management.\n- 📚 Easily ingest and interact with your documents.\n- 💾 Retrievable memory and document store.\n- 🚀 Highly extensible - create your own actions and clients.\n- 📦 Just works!\n\n## 🎯 Use Cases\n\n- 🤖 Chatbots\n- 🕵️ Autonomous Agents\n- 📈 Business Process Handling\n- 🎮 Video Game NPCs\n- 🧠 Trading\n\n## 🚀 Quick Start\n\n### Prerequisites\n\n- [Node.js](https://nodejs.org/) (v23 or higher recommended)\n- [bun](https://bun.sh/docs/installation)\n\n\u003e **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required.\n\n### Use the CLI (Recommended)\n\nThe ElizaOS CLI provides the fastest and most reliable way to create, configure, and run agents. It handles all the complex setup automatically.\n\n#### 1. Install the CLI\n\n```bash\n# Install the ElizaOS CLI globally\nbun install -g @elizaos/cli\n\n# Verify installation\nelizaos --version\n\n# Get help with available commands\nelizaos --help\n```\n\n#### 2. Create Your First Project\n\n```bash\n# Create a new project with interactive setup\nelizaos create my-agent\n\n# Or create with specific options (skips prompts)\nelizaos create my-agent --yes --type project\n```\n\n**Recommended Options for Beginners:**\n\n- **Database**: `pglite` (lightweight, no setup required)\n- **Model Provider**: `openai` (most reliable and well-tested)\n- **Project Type**: `project` (full ElizaOS application with runtime and agents)\n\n#### 3. Configure Your Agent\n\n```bash\ncd my-agent\n\n# Edit your local env file\nelizaos env edit-local\n\n# Or manually edit the .env file with your preferred editor\nnano .env\n```\n\n**Essential Environment Variables:**\n\n```bash\n# Required: Your model API key\nOPENAI_API_KEY=your_api_key_here\n\n# Optional: Logging level (info, debug, error)\nLOG_LEVEL=info\n\n# Optional: Discord bot token (if using Discord)\nDISCORD_APPLICATION_ID=your_discord_app_id\nDISCORD_API_TOKEN=your_discord_bot_token\n```\n\n#### 4. Start Your Agent\n\n```bash\n# Build and start your agent\nelizaos start\n\n# Or start with debug logging for development\nLOG_LEVEL=debug elizaos start\n```\n\nAfter starting, your agent will be available at:\n\n- **Web Interface**: http://localhost:3000\n- **API Endpoint**: http://localhost:3000/api\n\n#### 5. Development Workflow\n\n```bash\n# Make changes to your agent code\n# Then rebuild and restart\nbun run build\nelizaos start\n\n# Run tests to verify your changes\nelizaos test\n```\n\n#### Advanced CLI Commands\n\n```bash\n# Create specific components\nelizaos create my-plugin --type plugin    # Create a new plugin\nelizaos create my-agent --type agent      # Create a new agent character\nelizaos create my-tee --type tee          # Create a TEE project\n\n# Environment management\nelizaos env list            # Show all environment variables\nelizaos env reset           # Reset to default .env.example\n\n# Testing options\nelizaos test --name \"my-test\"    # Run specific tests\nelizaos test e2e                 # Run end-to-end tests only\nelizaos test component           # Run component tests only\n\n# Agent management\nelizaos agent list                      # List all available agents\nelizaos agent start --name \"Agent\"     # Start a specific agent by name\nelizaos agent stop --name \"Agent\"      # Stop a running agent\nelizaos agent get --name \"Agent\"       # Get agent details\nelizaos agent set --name \"Agent\" --file config.json  # Update agent configuration\n```\n\n#### Debugging and Logging\n\nElizaOS uses comprehensive logging to help you understand what your agent is doing:\n\n```bash\n# Different log levels\nLOG_LEVEL=error elizaos start    # Only errors\nLOG_LEVEL=info elizaos start     # General information (default)\nLOG_LEVEL=debug elizaos start    # Detailed debugging info\nLOG_LEVEL=verbose elizaos start  # Everything (very detailed)\n\n# Advanced debugging (combine with LOG_LEVEL=debug)\nELIZA_DEBUG=true elizaos start          # Enable ElizaOS debug output\nNODE_ENV=development elizaos start      # Development mode with extra logging\n```\n\n**Pro Tips:**\n\n- Use `elizaos --help` to see all available commands and global options\n- Use `elizaos \u003ccommand\u003e --help` for detailed help on any specific command\n- Use `LOG_LEVEL=debug` during development to see detailed execution flow\n- Check the web interface at http://localhost:3000 for real-time agent status\n- Use `elizaos test` frequently to catch issues early\n- Keep your `.env` file secure and never commit it to version control\n\n#### Available Commands Reference\n\n**All CLI Commands:**\n\n```bash\nelizaos create     # Create new projects, plugins, agents, or TEE projects\nelizaos start      # Start the agent server with character profiles\nelizaos agent      # Manage agents (list, start, stop, get, set)\nelizaos test       # Run tests (component, e2e, or all)\nelizaos env        # Manage environment variables and configuration\nelizaos dev        # Start in development mode with auto-rebuild\nelizaos update     # Update CLI and project dependencies\n# To stop agents, use Ctrl+C in the terminal where elizaos start is running\nelizaos publish    # Publish plugins to registry\nelizaos plugins    # Manage and discover plugins\nelizaos monorepo   # Monorepo development utilities\nelizaos tee        # Trusted Execution Environment commands\n\n# Get help for any specific command\nelizaos \u003ccommand\u003e --help    # e.g., elizaos create --help, elizaos agent --help\n```\n\n### Manually Start Eliza (Only recommended if you know what you are doing)\n\n#### Prerequisites\n\n- **Node.js** (v18+ recommended)\n- **bun** (for CLI and dependencies)\n- **git** (for project/plugin tests)\n\n#### Checkout the latest release\n\n```bash\n# Clone the repository\ngit clone https://github.com/elizaos/eliza.git\n\n# This project iterates fast, so we recommend checking out the latest release\ngit checkout $(git describe --tags --abbrev=0)\n# If the above doesn't checkout the latest release, this should work:\n# git checkout $(git describe --tags `git rev-list --tags --max-count=1`)\n```\n\n#### Edit the .env file\n\nCopy .env.example to .env and fill in the appropriate values.\n\n```\ncp .env.example .env\n```\n\nNote: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON\n\n#### Start Eliza\n\nImportant! We now use Bun. If you are using npm, you will need to install Bun:\nhttps://bun.sh/docs/installation\n\n```bash\nbun install\nbun run build\nbun start\n```\n\n### Interact via Browser\n\nOnce Eliza is running, access the modern web interface at http://localhost:3000. It has been professionally redesigned and features:\n\n- A welcoming dashboard with a gradient hero section and clear calls-to-action for creating agents and groups.\n- Visually enhanced cards for managing agents and groups, including status indicators and member counts.\n- Real-time chat capabilities with your agents.\n- Character configuration options.\n- Plugin management.\n- Comprehensive memory and conversation history.\n- Responsive design for an optimal experience on various screen sizes.\n\n## Citation\n\nWe now have a [paper](https://arxiv.org/pdf/2501.06781) you can cite for the Eliza OS:\n\n```bibtex\n@article{walters2025eliza,\n  title={Eliza: A Web3 friendly AI Agent Operating System},\n  author={Walters, Shaw and Gao, Sam and Nerd, Shakker and Da, Feng and Williams, Warren and Meng, Ting-Chien and Han, Hunter and He, Frank and Zhang, Allen and Wu, Ming and others},\n  journal={arXiv preprint arXiv:2501.06781},\n  year={2025}\n}\n```\n\n## Contributors\n\n\u003ca href=\"https://github.com/elizaos/eliza/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=elizaos/eliza\" alt=\"Eliza project contributors\" /\u003e\n\u003c/a\u003e\n\n## Star History\n\n[![Star History Chart](https://api.star-history.com/svg?repos=elizaos/eliza\u0026type=Date)](https://star-history.com/#elizaos/eliza\u0026Date)\n\n## Git Hooks\n\nThis project uses git hooks to ensure code quality:\n\n- **pre-commit**: Automatically formats staged files using Prettier before committing\n\nTo run the pre-commit hook manually:\n\n```bash\nbun run pre-commit\n```\n\n## 📂 Repository Structure\n\nEliza is organized as a monorepo using Bun, Lerna, and Turbo for efficient package management and build orchestration. Here's a detailed overview of the project structure:\n\n- **`/` (Root)**:\n\n  - `.github/`: GitHub Actions workflows for CI/CD pipelines and issue templates\n  - `.husky/`: Git hooks configuration, including pre-commit formatting\n  - `.devcontainer/`: Development container configurations for consistent environments\n  - `packages/`: Core packages and modules (detailed below)\n  - `scripts/`: Build, development, and utility scripts\n  - `data/`: Application and user data storage\n  - `AGENTS.md`: Comprehensive agent documentation and specifications\n  - `CHANGELOG.md`: Detailed version history and changes\n  - `Dockerfile`, `docker-compose.yaml`: Container configurations for deployment\n  - `lerna.json`, `package.json`, `turbo.json`: Monorepo configuration and workspace definitions\n\n- **`/packages/`**: Core components of the Eliza framework:\n  - `core/`: The foundational package (@elizaos/core) implementing:\n    - PDF processing capabilities\n    - Logging and error handling infrastructure\n  - `app/`: Tauri-based cross-platform application (@elizaos/app)\n    - React-based UI implementation\n    - Tauri plugins for system integration\n    - Desktop and mobile builds support\n  - `autodoc/`: Documentation automation tool (@elizaos/autodoc)\n    - LangChain-powered documentation generation\n    - TypeScript parsing and analysis\n    - GitHub integration via Octokit\n  - `cli/`: Command-line interface for Eliza management\n  - `client/`: Client libraries for web interfaces\n  - `create-eliza/`: Project scaffolding tool\n  - `docs/`: Official documentation source files\n  - `plugin-bootstrap/`: **Essential communication core** (@elizaos/plugin-bootstrap)\n    - **Required for basic agent functionality** - handles all message processing\n    - Provides critical event handlers (MESSAGE_RECEIVED, VOICE_MESSAGE_RECEIVED, etc.)\n    - Implements fundamental agent actions (reply, follow/unfollow, mute/unmute)\n    - Contains core evaluators and providers for agent cognition\n    - Manages message processing pipeline and response generation\n    - **Mandatory unless building custom event handling system**\n  - `plugin-sql/`: Database integration (@elizaos/plugin-sql)\n    - PostgreSQL integration with PGLite support\n    - Drizzle ORM for type-safe queries\n    - Migration management tools\n    - Integration testing support\n  - `plugin-starter/`: Template for creating new plugins\n  - `project-starter/`, `project-tee-starter/`: Project templates\n\nThis architecture enables modular development, clear separation of concerns, and scalable feature implementation across the Eliza ecosystem.\n","funding_links":[],"categories":["AI Agent Frameworks","Framework Integrations","AI","telegram","TypeScript","Rust","Table of Open-Source AI Agents Projects","A01_文本生成_文本对话","AI Agents","Open Source Projects","🤖 AI Agent Frameworks","Agent Integration \u0026 Deployment Tools","Agent Frameworks"],"sub_categories":["Typescript","ClawRouter — Cost Optimizer for Existing API Key Users","General Agent Frameworks","Smart Contract Toolkits","大语言对话模型及数据","Infrastructure","E","AI Agent Orchestration"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FelizaOS%2Feliza","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FelizaOS%2Feliza","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FelizaOS%2Feliza/lists"}