|
1 | | -# Moltbook Agent |
| 1 | +# Python Moltbook Agent |
2 | 2 |
|
3 | | -Autonomous Moltbook agent scaffold (Phase A baseline). |
| 3 | +An autonomous, Docker-ready Moltbook bot with: |
| 4 | + |
| 5 | +- feed ingestion (RSS + Moltbook feed) |
| 6 | +- configurable persona and submolt routing |
| 7 | +- Gemini-powered draft generation |
| 8 | +- safe dry-run mode and rate limits |
| 9 | +- strict lint/type/test gates for reliable changes |
| 10 | + |
| 11 | +Moltbook website: https://www.moltbook.com/ |
| 12 | + |
| 13 | +## Join Moltbook (Required Onboarding) |
| 14 | + |
| 15 | +Read and follow the official instructions in [skill.md](skill.md) and on https://moltbook.com/skill.md. |
| 16 | + |
| 17 | +High-level flow: |
| 18 | + |
| 19 | +1. Send [skill.md](skill.md) to your agent. |
| 20 | +2. Agent signs up and returns a claim link. |
| 21 | +3. You tweet to verify ownership. |
| 22 | + |
| 23 | +After claim is complete, set `MB_API_KEY` in your local `.env`. |
| 24 | + |
| 25 | +## Core Configuration Files |
| 26 | + |
| 27 | +- [configs/agent.yaml](configs/agent.yaml) |
| 28 | + - Runtime and operational controls (heartbeat, limits, logging defaults). |
| 29 | +- [configs/submolts.yaml](configs/submolts.yaml) |
| 30 | + - Per-submolt behavior and personality (persona, tone, topics, abilities, thresholds, dry-run per submolt). |
| 31 | +- [configs/gemini.yaml](configs/gemini.yaml) |
| 32 | + - Gemini generation settings (model, temperature, top-p/top-k, function-calling, URL lookup behavior). |
4 | 33 |
|
5 | 34 | ## Quickstart |
6 | 35 |
|
7 | | -1. Create virtual environment and install dependencies. |
8 | | -2. Copy `.env.example` to `.env` and set `MB_GEMINI_API_KEY`. |
9 | | -3. If you already have Moltbook key, set `MB_API_KEY`; otherwise keep `MB_AUTO_REGISTER=true` and the bot will register and output claim details. |
10 | | -4. Complete claim verification (tweet/email), then put issued key into `MB_API_KEY`. |
11 | | -5. (Optional) set `MB_RSS_FEED_URLS` as comma-separated feed URLs. |
12 | | -6. Run locally: `python -m app.main`. |
| 36 | +1. Create and activate a Python environment. |
| 37 | +2. Install dependencies. |
| 38 | +3. Copy `.env.example` to `.env`. |
| 39 | +4. Set at minimum: |
| 40 | + - `MB_GEMINI_API_KEY` |
| 41 | + - `MB_API_KEY` (after claim), or keep `MB_AUTO_REGISTER=true` for onboarding flow. |
| 42 | +5. Optional: set `MB_RSS_FEED_URLS` to one or more comma-separated feed URLs. |
| 43 | +6. Run one dry-run cycle: |
| 44 | + - `MB_RUNTIME__AUTONOMOUS_MODE=false` |
| 45 | + - `MB_RUNTIME__RUN_ONCE=true` |
| 46 | + - `python -m app.main` |
| 47 | + |
| 48 | +## AI settings |
13 | 49 |
|
14 | | -## Gemini settings |
| 50 | +By default, this project is configured for the Gemini API (for the free tier). You can swap it out for any AI API. |
15 | 51 |
|
16 | 52 | - Settings file: `configs/gemini.yaml` |
17 | 53 | - Override path with `MB_GEMINI_CONFIG_PATH` |
@@ -45,6 +81,5 @@ GitHub Actions workflow is included in [.github/workflows/ci.yml](.github/workfl |
45 | 81 |
|
46 | 82 | ## Safety Notes |
47 | 83 |
|
48 | | -- Never share secrets from `.env`. |
49 | 84 | - Only send Moltbook API keys to `https://www.moltbook.com` as required by [skill.md](skill.md). |
50 | 85 | - Start in dry-run mode before enabling autonomous posting. |
0 commit comments