中文说明 | 日本語の説明 | 한국어 설명 | Persian | Français | Português | Türkçe | Русский | Español | Italiano | ไทย | Deutsch | Tiếng Việt | עִברִית | Tagalog | Polski | Arabic | Hungarian | Srpski | Română | Nederlands | Ελληνικά

• 🛠️ Full-featured Twitter integration
• 🔗 Support for various models (Llama, Grok, OpenAI, Anthropic, Gemini, etc.)
• 👥 Multi-agent and room support
• 📚 Easily ingest and interact with your documents
• 💾 Retrievable memory and document store
• 🚀 Highly extensible - create your own actions and clients
• 📦 Just works!

AI Agent Dev School

• 🤖 Chatbots
• 🕵️ Autonomous Agents
• 📈 Business Process Handling
• 🎮 Video Game NPCs
• 🧠 Trading

• Python 2.7+
• Node.js 23+
• pnpm

Note for Windows Users: WSL 2 is required.

Bash git clone https://github.com/elizaos/eliza-starter.git cd eliza-starter cp .env.example .env pnpm i && pnpm build && pnpm start

bash Clone the repository git clone https://github.com/elizaos/eliza.git This project iterates fast, so we recommend checking out the latest release git checkout $(git describe --tags --abbrev=0) If the above doesn't checkout the latest release, this should work: git checkout $(git describe --tags git rev-list --tags --max-count=1)

Copy .env.example to .env and fill in the appropriate values. bash cp .env.example .env

Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON.

bash pnpm i pnpm build pnpm start The project iterates fast, sometimes you need to clean the project if you are coming back to the project pnpm clean

Once the agent is running, you should see the message to run pnpm start:client at the end. Open another terminal, move to the same directory, and then run the following command to chat with your agent:

bash pnpm start:client

Then read the Documentation to learn how to customize your Gigi.

The start script provides an automated way to set up and run Gigi:

bash sh scripts/start.sh

For detailed instructions on using the start script, including character management and troubleshooting, see our Start Script Guide.

Note: The start script handles all dependencies, environment setup, and character management automatically.

1. Open packages/core/src/defaultCharacter.ts to modify the default character. Uncomment and edit as needed.

2. To load custom characters:

   • Use pnpm start --characters="path/to/your/character.json"
   • Multiple character files can be loaded simultaneously.

3. Connect with X (Twitter):

   • Change "clients": [] to "clients": ["twitter"] in the character file to connect with X.

You may need to install Sharp. If you see an error when starting up, try installing it with the following command:

bash pnpm install --include=optional sharp

• GitHub Issues. Best for: bugs you encounter using Gigi, and feature proposals.
• Discord. Best for: sharing your applications and hanging out with the community.