Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 96 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,102 @@ poetry shell
poetry run python main.py
```



## FAQ

### What is ZerePy?

ZerePy is an **open-source Python framework** for deploying your own AI agents on X (Twitter), powered by multiple LLMs. Built from a modularized version of the Zerebro backend, ZerePy lets you launch agents with similar core functionality for social media automation and engagement.

### Why Use ZerePy?

| Feature | Benefit |
|---------|---------|
| **CLI Interface** | Easy command-line management of your agents |
| **Modular Connection System** | Plug-and-play architecture for different platforms |
| **Blockchain Integration** | Support for Solana, Ethereum, GOAT, Monad |
| **Social Platform Integrations** | Twitter/X, Farcaster, Echochambers |
| **Multiple LLM Support** | OpenAI, Anthropic, EternalAI, Ollama, Hyperbolic, Galadriel, XAI (Grok) |
| **Open Source** | Free to use, modify, and deploy |

### What Language Models Does ZerePy Support?

ZerePy supports a wide range of LLM providers:

| Provider | Model Type | API Key Source |
|----------|------------|----------------|
| **OpenAI** | GPT models | [platform.openai.com/api-keys](https://platform.openai.com/api-keys) |
| **Anthropic** | Claude models | [console.anthropic.com](https://console.anthropic.com/account/keys) |
| **EternalAI** | Custom models | [eternalai.org/api](https://eternalai.org/api) |
| **Ollama** | Local models | Self-hosted |
| **Hyperbolic** | Various models | [app.hyperbolic.xyz](https://app.hyperbolic.xyz) |
| **Galadriel** | Custom models | [dashboard.galadriel.com](https://dashboard.galadriel.com) |
| **XAI (Grok)** | Grok models | X.AI API |

### What Social Platforms Can I Integrate?

| Platform | Integration Details |
|----------|---------------------|
| **Twitter/X** | X API key and secret ([developer.x.com](https://developer.x.com/en/docs/authentication/oauth-1-0a/api-key-and-secret)) |
| **Farcaster** | Warpcast recovery phrase |
| **Echochambers** | API key and endpoint |

### What Blockchain Networks Are Supported?

| Network | Integration |
|---------|-------------|
| **Solana** | Private key authentication |
| **Ethereum** | Private key authentication |
| **GOAT** | Great Onchain Agent Toolkit |
| **Monad** | Private key authentication |

### How Do I Get Started?

**Quick Start with Replit Template:**

1. Fork the [Replit template](https://replit.com/@blormdev/ZerePy?v=1)
2. Click the run button
3. Your CLI is ready to use

**Manual Installation:**

| Step | Command |
|------|---------|
| 1. Install Poetry | Follow [python-poetry.org](https://python-poetry.org/docs/#installing-with-the-official-installer) |
| 2. Clone repo | `git clone https://github.com/blorm-network/ZerePy.git` |
| 3. Enter directory | `cd zerepy` |
| 4. Install dependencies | `poetry install --no-root` |

### What Are the System Requirements?

| Requirement | Version |
|-------------|---------|
| **Python** | 3.10 or higher |
| **Poetry** | 1.5 or higher |

### Is ZerePy Free?

Yes! ZerePy is **open-source software**. You need to provide your own API keys for LLMs and social platforms, but the framework itself is free to use. Check the repository license for full details.

### Do I Need My Own API Keys?

Yes, ZerePy uses **BYOK (Bring Your Own Key)** approach:

| Category | Required Keys |
|----------|---------------|
| **LLM** | At least one LLM API key (OpenAI, Anthropic, etc.) |
| **Social** | X API key/secret, Farcaster phrase, Echochambers key (based on needs) |
| **On-chain** | Private keys for Solana/Ethereum/Monad |

### Where Can I Get Help?

| Resource | Link |
|----------|------|
| **GitHub Repository** | [github.com/blorm-network/ZerePy](https://github.com/blorm-network/ZerePy) |
| **Replit Template** | [replit.com/@blormdev/ZerePy](https://replit.com/@blormdev/ZerePy?v=1) |
| **Issues** | [GitHub Issues](https://github.com/blorm-network/ZerePy/issues) |

## Configure connections & launch an agent

1. Configure your desired connections:
Expand Down