From 1b55df508ce67d7ab80f31066ca7e90408032e5e Mon Sep 17 00:00:00 2001 From: Mikkel Georgsen Date: Fri, 16 Jan 2026 14:42:47 +0000 Subject: [PATCH] Add README.md with project overview Visual documentation optimized for Forgejo with ASCII diagrams, feature table, command reference, architecture overview, and roadmap. Co-Authored-By: Claude Opus 4.5 --- README.md | 166 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 166 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bad5c0b --- /dev/null +++ b/README.md @@ -0,0 +1,166 @@ +

+ πŸ—Ώ MoAI +

+ +

+ Master of AIs
+ Multi-model AI roundtable for collaborative brainstorming +

+ +

+ Python 3.11+ + Status: Phase 1 + License: MIT +

+ +--- + +## πŸ’‘ The Idea + +Instead of asking **one** AI a question, ask a **team** of AIs. + +``` +You: "How should we architect our new microservice?" + +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Claude β”‚ β”‚ GPT β”‚ β”‚ Gemini β”‚ +β””β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”˜ + β”‚ β”‚ β”‚ + β–Ό β–Ό β–Ό + "Event "Start "Consider + sourcing simple, the team's + gives you monolith experience + audit first..." level..." + trails..." + β”‚ β”‚ β”‚ + β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β–Ό + 🀝 Discussion Rounds + β–Ό + πŸ“‹ Consensus Summary +``` + +Models see each other's responses, debate, agree, disagree, and build upon ideas. You get richer, more diverse insightsβ€”then export everything as clean markdown. + +--- + +## ✨ Features + +| Feature | Description | +|---------|-------------| +| πŸ”€ **Open Mode** | Ask all models in parallelβ€”get diverse initial takes | +| πŸ’¬ **Discuss Mode** | Sequential rounds where models respond to each other | +| 🎯 **@Mentions** | Direct questions to specific models: `@claude explain more` | +| 🀝 **Consensus** | Auto-generated summary of agreements & disagreements | +| πŸ“ **Projects** | Organize discussions by topic with persistent context | +| πŸ“€ **Export** | Beautiful markdown documents of entire discussions | + +--- + +## πŸš€ Quick Start + +```bash +# Clone & setup +git clone https://git.example.com/mikkel/moai.git +cd moai +uv sync # or: pip install -e ".[dev]" + +# Configure +cp .env.example .env +# Edit .env with your tokens + +# Run +python -m moai.bot.main +``` + +--- + +## πŸ€– Telegram Commands + +### Projects +``` +/projects List all projects +/project new "Name" Create project +/project select Switch project +/project models claude,gpt,gemini +``` + +### Discussion +``` +/open Ask all models (parallel) +/discuss [rounds] Start discussion (default: 3 rounds) +@claude Direct message to Claude +@gpt Direct message to GPT +/stop End current discussion +``` + +### Output +``` +/consensus Generate agreement summary +/export Export as markdown +``` + +--- + +## πŸ—οΈ Architecture + +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Telegram Bot │────▢│ Python Backend β”‚ +β”‚ (thin client) β”‚ β”‚ β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ + β”‚ β”‚ Handlers β”‚ β”‚ Orchestratorβ”‚ β”‚ + β”‚ β””β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”˜ β”‚ + β”‚ β”‚ β”‚ β”‚ + β”‚ β–Ό β–Ό β”‚ + β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ + β”‚ β”‚ SQLite β”‚ β”‚ AI Client β”‚ β”‚ + β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”˜ β”‚ + β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ Requesty / OpenRouter β”‚ + β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ + β”‚ β”‚ Claude β”‚ GPT β”‚ Gemini β”‚ β”‚ + β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ + β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` + +--- + +## πŸ“ Roadmap + +- [x] **M1** Bot basics (`/help`, `/status`) +- [ ] **M2** Project CRUD +- [ ] **M3** Single model Q&A +- [ ] **M4** Open mode (parallel) +- [ ] **M5** Discuss mode (sequential) +- [ ] **M6** Consensus generation +- [ ] **M7** Markdown export +- [ ] **M8** @mention support +- [ ] **Phase 2** Web UI + +--- + +## πŸ› οΈ Tech Stack + +| Layer | Technology | +|-------|------------| +| Bot | `python-telegram-bot` (async) | +| Backend | Python 3.11+, FastAPI | +| Database | SQLite β†’ PostgreSQL | +| AI Routing | Requesty / OpenRouter | +| Linting | Ruff | +| Testing | pytest | + +--- + +## πŸ“„ License + +MIT Β© 2026 + +--- + +

+ Why ask one AI when you can ask them all? πŸ—Ώ +