Skip to content

Commit 633f637

Browse files
author
ukgorclawbot-stack
committed
Add English README and release notes
1 parent 73f7942 commit 633f637

File tree

3 files changed

+137
-0
lines changed

3 files changed

+137
-0
lines changed

README.en.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Telegram Multi-Bot Stack
2+
3+
A Telegram multi-bot framework with:
4+
5+
- separated group bots and private bots
6+
- multi-role collaboration across `OpenClaw / Gemini / Codex / Claude`
7+
- shared task queue
8+
- shared memory summaries
9+
- one-command env and launchd generation
10+
- flexible bot count scaling
11+
12+
This project is suitable for:
13+
14+
- task routing and reporting in team Telegram groups
15+
- high-permission execution in private chat
16+
- running multiple bots at once with clearly separated responsibilities
17+
18+
Language:
19+
20+
- Chinese: [README.md](./README.md)
21+
- English: [README.en.md](./README.en.md)
22+
23+
## Quick Start
24+
25+
```bash
26+
git clone https://github.com/ukgorclawbot-stack/telegram-multi-bot-stack.git
27+
cd telegram-multi-bot-stack
28+
bash ./install.sh
29+
bash ./configure.sh
30+
bash ./apply_stack.sh
31+
```
32+
33+
If you want a beginner-friendly walkthrough, read:
34+
35+
- [INSTALL.md](./INSTALL.md)
36+
37+
If you only want to preview generated files without starting services:
38+
39+
```bash
40+
git clone https://github.com/ukgorclawbot-stack/telegram-multi-bot-stack.git
41+
cd telegram-multi-bot-stack
42+
bash ./install.sh
43+
bash ./configure.sh
44+
bash ./bootstrap_bot_stack.sh generate
45+
```
46+
47+
## Core Files
48+
49+
- `group_bot.py`: shared entrypoint for group and private bot roles
50+
- `bot.py`: compatibility entrypoint for legacy Codex direct handling
51+
- `bootstrap_bot_stack.py`: generates env and launchd files from a TOML stack spec
52+
- `configure_stack.py`: interactive configuration wizard
53+
- `bootstrap_bot_stack.sh`: wrapper for generate/apply/export-live/migration-template
54+
- `apply_stack.sh`: loads local tokens and applies the stack
55+
56+
## Common Commands
57+
58+
```bash
59+
# Install dependencies
60+
bash ./install.sh
61+
62+
# Run interactive configuration
63+
bash ./configure.sh
64+
65+
# Generate files only, do not start services
66+
bash ./bootstrap_bot_stack.sh generate
67+
68+
# Generate and start services
69+
bash ./apply_stack.sh
70+
71+
# Run system health checks
72+
bash ./health_check.sh
73+
```
74+
75+
## Advanced Features
76+
77+
```bash
78+
# Reverse export a live stack into a sanitized TOML file
79+
bash ./bootstrap_bot_stack.sh export-live
80+
81+
# Build a migration-ready template for a fresh machine
82+
bash ./bootstrap_bot_stack.sh migration-template
83+
```
84+
85+
## License
86+
87+
MIT

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
- 一键生成 env 和 launchd
1010
- 可扩容到任意数量 bot
1111

12+
语言:
13+
- 中文:[README.md](./README.md)
14+
- English: [README.en.md](./README.en.md)
15+
1216
适合这些场景:
1317
- 团队协作群里的任务拆分和汇报
1418
- 私聊里的高权限开发与执行

RELEASE_NOTES_v0.1.0.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Telegram Multi-Bot Stack v0.1.0
2+
3+
First public release of the stack.
4+
5+
## Highlights
6+
7+
- One-command install, configure, and apply flow
8+
- Supports separated group bots and private bots
9+
- Supports flexible bot counts through a TOML stack file
10+
- Includes reverse export from a live stack
11+
- Includes migration-ready template generation for new machines
12+
- Includes health check tooling for Telegram, bot services, monitor output, and report output
13+
14+
## Quick Start
15+
16+
```bash
17+
git clone https://github.com/ukgorclawbot-stack/telegram-multi-bot-stack.git
18+
cd telegram-multi-bot-stack
19+
bash ./install.sh
20+
bash ./configure.sh
21+
bash ./apply_stack.sh
22+
```
23+
24+
## Recommended Docs
25+
26+
- Chinese quick guide: `README.md`
27+
- English quick guide: `README.en.md`
28+
- Beginner install guide: `INSTALL.md`
29+
30+
## Included Commands
31+
32+
```bash
33+
bash ./install.sh
34+
bash ./configure.sh
35+
bash ./apply_stack.sh
36+
bash ./health_check.sh
37+
bash ./bootstrap_bot_stack.sh generate
38+
bash ./bootstrap_bot_stack.sh export-live
39+
bash ./bootstrap_bot_stack.sh migration-template
40+
```
41+
42+
## Notes
43+
44+
- Secrets are not committed. Fill bot tokens through `.bot_tokens.env`.
45+
- Generated runtime files are ignored by Git.
46+
- This release is designed for macOS and launchd-based local deployment.

0 commit comments

Comments
 (0)