vibego 0.2.59__tar.gz → 1.0.0__tar.gz

vibego-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

vibego-1.0.0/PKG-INFO

@@ -0,0 +1,236 @@
+Metadata-Version: 2.4
+Name: vibego
+Version: 1.0.0
+Summary: vibego CLI: tools for bootstrapping and managing the Telegram Master Bot
+Author: DavidChan
+License-Expression: LicenseRef-Proprietary
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: MacOS
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Environment :: Console
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiogram<4.0.0,>=3.0.0
+Requires-Dist: aiohttp-socks>=0.10.0
+Requires-Dist: aiosqlite>=0.19.0
+Requires-Dist: markdown-it-py<4.0.0,>=3.0.0
+Dynamic: license-file
+
+# vibego - vibe coding via Telegram anytime, anywhere
+
+**Drive your terminal AI CLI via Telegram anytime and anywhere (supports Codex / ClaudeCode)**
+
+For the Simplified Chinese version, see [README-zh.md](README-zh.md).
+
+## Features
+
+1. Control your terminal AI CLI through Telegram whenever you need it.
+2. Capture lightweight task management and bug reports directly inside Telegram.
+3. Switch between Codex / ClaudeCode terminal CLIs in one tap from Telegram.
+4. Send commands over the HTTPS channel provided by the Telegram Bot API, protected by end‑to‑end TLS.
+5. Keep runtime logs and state files under `~/.config/vibego/` so sensitive data never leaves the machine.
+
+## Environment Requirements
+
+- Install the core CLI dependencies with Homebrew to keep scripts aligned:
+  ```bash
+  brew install python@3.11 tmux
+  ```
+  The CLI verifies Python >= 3.11 when you run `vibego start` (see `pyproject.toml` `requires-python` and the Python
+  guard in `vibego_cli/main.py`). Validate with `python3 --version` (must show 3.11+) and `tmux -V`.
+- To run the Codex model you also need the Codex CLI:
+  ```bash
+  brew install codex
+  ```
+  `scripts/run_bot.sh` checks for the `codex` executable before the worker launches. Confirm with `codex --version`.
+- The scripts use the `python3` available on your `PATH` and automatically create `~/.config/vibego/runtime/venv` on
+  first launch to install Python dependencies. If you prefer to bootstrap manually:
+  ```bash
+  python3 -m venv ~/.config/vibego/runtime/venv
+  source ~/.config/vibego/runtime/venv/bin/activate
+  ```
+  Set `VIBEGO_RUNTIME_ROOT` if you need a custom runtime location (pipx users typically do not).
+
+## Quick Start
+
+### Create and retrieve a Telegram bot token
+
+Use the official Telegram BotFather guide (<https://core.telegram.org/bots#botfather>):
+
+1. Search for `@BotFather` in the Telegram client and start a chat.
+2. Send `/start`, then `/newbot`, and follow the prompts for bot name and username.
+3. BotFather returns an HTTP API token resembling `123456789:ABC...`; store it safely.
+4. To regenerate or reset the token, send `/token` in the same chat and pick the bot.
+
+### Install and start vibego
+
+Before continuing, make sure Codex / ClaudeCode CLIs are installed and logged in, and that you have a Telegram bot token
+ready.
+
+- Consider merging the contents of [AGENTS-en.md](AGENTS-en.md) into your `$HOME/.codex/AGENTS.md` or
+  `$HOME/.claude/CLAUDE.md`.
+
+```bash
+pipx install vibego  # or pip install --user vibego
+vibego init          # initialise the config directory and persist the Master Bot Token
+vibego start         # start the master service
+```
+
+## Directory Layout
+
+- `bot.py`: aiogram 3 worker that supports multiple model sessions (Codex / ClaudeCode / reserved Gemini).
+- `scripts/run_bot.sh`: one-click bootstrap (builds venv, starts tmux + model CLI + bot).
+- `scripts/stop_bot.sh`: terminates the worker for a project (tmux session + bot process).
+- `scripts/start_tmux_codex.sh`: low-level tmux/CLI launcher invoked by `run_bot.sh`, forces UTF‑8 via `tmux -u`.
+- `scripts/models/`: model configuration modules (`common.sh` / `codex.sh` / `claudecode.sh` / `gemini.sh`).
+- `logs/<model>/<project>/`: runtime logs (`run_bot.log`, `model.log`, `bot.pid`, `current_session.txt`), defaulted to
+  `~/.config/vibego/logs/`.
+    - `model.log` is rotated by `scripts/log_writer.py`, with 20 MB cap per file and 24-hour retention (override via
+      `MODEL_LOG_MAX_BYTES`, `MODEL_LOG_RETENTION_SECONDS`).
+- `.env.example`: configuration template to copy to `.env` and adjust.
+
+## Logs & Directories
+
+```
+~/.config/vibego/logs/
+  └─ codex/
+      └─ mall-backend/
+           ├─ run_bot.log     # output from run_bot.sh
+           ├─ model.log       # model CLI output captured through tmux pipe-pane
+           ├─ bot.pid         # current bot process PID (used by stop_bot.sh)
+           └─ current_session.txt  # pointer to the latest JSONL session
+```
+
+> Starting in 2025, all logs, databases, and state files default to `~/.config/vibego/`. Use
+`./scripts/migrate_runtime.sh` to migrate legacy files created inside the repository back into the runtime directory.
+
+## Model Switching
+
+- Supported model parameters: `codex`, `claudecode`, `gemini` (placeholder).
+- Switch flow: `stop_bot.sh --model <old>` → `run_bot.sh --model <new>`.
+- Each model keeps an isolated configuration in `scripts/models/<model>.sh`; shared logic lives in
+  `scripts/models/common.sh`.
+- `ACTIVE_MODEL` is echoed in `/start` replies and logs, and exported to the environment for `bot.py`.
+
+### Codex
+
+| Variable             | Description                                                                      |
+|----------------------|----------------------------------------------------------------------------------|
+| `CODEX_WORKDIR`      | Codex CLI working directory (defaults to the value in `.env` or repository root) |
+| `CODEX_CMD`          | Launch command, default `codex --dangerously-bypass-...`                         |
+| `CODEX_SESSION_ROOT` | JSONL root directory (default `~/.codex/sessions`)                               |
+| `CODEX_SESSION_GLOB` | JSONL file pattern (default `rollout-*.jsonl`)                                   |
+
+### ClaudeCode
+
+| Variable              | Description                                                  |
+|-----------------------|--------------------------------------------------------------|
+| `CLAUDE_WORKDIR`      | Project directory (defaults to the same value used by Codex) |
+| `CLAUDE_CMD`          | CLI launch command, for example `claude --project <path>`    |
+| `CLAUDE_PROJECT_ROOT` | JSONL root directory (default `~/.claude/projects`)          |
+| `CLAUDE_SESSION_GLOB` | JSONL file pattern (default `*.jsonl`)                       |
+| `CLAUDE_PROJECT_KEY`  | Optional: explicitly set `~/.claude/projects/<key>`          |
+
+### Gemini (placeholder)
+
+- `scripts/models/gemini.sh` currently contains a placeholder command to be expanded once the official CLI is available.
+
+## aiogram Worker Behaviour
+
+- `/start`: returns `chat_id`, `MODE`, and `ACTIVE_MODEL`; logs record `chat_id` and `user_id`.
+- Text messages:
+    1. Pick the `SessionAdapter` based on `ACTIVE_MODEL`, read `current_session.txt`, and search `MODEL_SESSION_ROOT` if
+       necessary.
+    2. Inject the prompt into tmux (send `Esc` to clear modes, `Ctrl+J` for newline, `Enter` to submit).
+    3. Initialise offsets from `SESSION_OFFSETS`; `_deliver_pending_messages()` streams tail updates from the JSONL log.
+    4. During the watcher phase, the bot informs the user the `ACTIVE_MODEL` is processing and pushes the result once
+       ready (Markdown preserved).
+- MODE = A still honours `AGENT_CMD` for direct CLI execution.
+
+## New Scripts
+
+- `run_bot.sh`
+    - `--model <name>`: codex / claudecode / gemini.
+    - `--project <slug>`: directory name for logs/sessions; defaults to a slug derived from the working directory.
+    - `--foreground`: keep the process in the foreground (default: background via `nohup`).
+    - `--no-stop`: skip the pre-launch stop step (defaults to invoking `stop_bot.sh` for idempotency).
+- `stop_bot.sh`
+    - Idempotent stop: issues `tmux kill-session`, terminates the process from `bot.pid`, and clears cached files.
+    - Example: `./scripts/stop_bot.sh --model codex --project mall-backend`.
+
+## Configuration Highlights
+
+### `.env` (master global configuration)
+
+- Location: `~/.config/vibego/.env` (override with `VIBEGO_CONFIG_DIR`).
+- `MASTER_BOT_TOKEN`: token for the master bot; collected by `vibego init` and required for startup.
+- `MASTER_CHAT_ID` / `MASTER_USER_ID`: captured automatically the first time you interact with the master in Telegram to
+  mark authorised admins.
+- `MASTER_WHITELIST`: comma-separated list of chat IDs. Leave empty to allow any chat; latest value always wins if auto
+  updates occur.
+- You can add optional variables for proxies, log level, default model, etc. Scripts fall back to sensible defaults if
+  unspecified.
+
+- Project definitions persist in `~/.config/vibego/config/master.db` (SQLite) with a JSON mirror at
+  `~/.config/vibego/config/projects.json`. For offline edits, use the `config/projects.json.example` template in the
+  repository.
+- The master “⚙️ Project Management” menu can create/edit/delete projects; offline JSON edits are imported at startup
+  and synced to the database.
+- Required fields: `bot_name`, `bot_token`, `project_slug`, `default_model`.
+- Optional fields: `workdir` (project path), `allowed_chat_id` (pre-authorised chat). Leave blank to let the worker
+  capture the first valid chat and persist it to `~/.config/vibego/state/master_state.json`.
+- Other custom fields are currently ignored.
+
+### Automatic Authorisation & State
+
+- If `allowed_chat_id` is empty when the worker starts, the first authorised message writes to `state/state.json` and is
+  applied immediately.
+- Master restarts: call `stop_bot.sh` first, then restore running projects from the saved state.
+
+## Roadmap
+
+- Master bot will poll all project bots and invoke run/stop scripts to orchestrate workers; current version ships the
+  worker layout and logging standard first.
+- Gemini CLI support will be added once an official integration path is available.
+
+## Notes
+
+- `~/.config/vibego/.env` stores sensitive tokens and admin metadata—never commit it.
+- To trim log size, clean up `logs/<model>/<project>/` as needed or adjust script thresholds.
+- If you previously ran an old source checkout, run `./scripts/migrate_runtime.sh` and ensure only `.example` templates
+  remain in the repository to avoid committing databases or logs.
+- The master caches version checks and reminds you once per release; rerun `/projects` or restart the master to force a
+  new check.
+
+## Master Control
+
+- Launch the admin bot with `MASTER_BOT_TOKEN` (running `python master.py`).
+- Master stores the project list in `~/.config/vibego/config/master.db`; use the project management menu or edit
+  `~/.config/vibego/config/projects.json` directly. Key fields:
+    - `bot_name`: Telegram bot username (with or without `@`; CLI adds `@` when displaying).
+    - `bot_token`: Telegram token for the worker.
+    - `default_model`: default model (codex / claudecode / gemini).
+    - `project_slug`: directory/log slug.
+    - `workdir`: project working directory (optional).
+    - `allowed_chat_id`: authorised chat injected into the runtime environment.
+- State snapshot: `~/.config/vibego/state/master_state.json` records the active model and running status for each
+  project. On restart the master calls `stop_bot.sh`, then restores workers according to the state file.
+
+### Management Commands
+
+| Command                     | Description                                                                 |
+|-----------------------------|-----------------------------------------------------------------------------|
+| `/projects`                 | List all projects with their current status and model.                      |
+| `/run <project> [model]`    | Start a project worker; optional `model` overrides the default/current one. |
+| `/stop <project>`           | Stop the project worker.                                                    |
+| `/switch <project> <model>` | Stop the worker and relaunch it with a new model.                           |
+| `/start`                    | Show help and the total number of projects.                                 |
+| `/upgrade`                  | Run `pipx upgrade vibego && vibego stop && vibego start` to self-upgrade.   |
+
+- `<project>` accepts either the `project_slug` or `@bot_name`. Responses automatically render clickable `@` links.
+
+> The master only interacts with the admin bot. Project bots continue to handle business traffic through the worker (
+`bot.py`) launched by `run_bot.sh`.

vibego-1.0.0/README.md

@@ -0,0 +1,215 @@
+# vibego - vibe coding via Telegram anytime, anywhere
+
+**Drive your terminal AI CLI via Telegram anytime and anywhere (supports Codex / ClaudeCode)**
+
+For the Simplified Chinese version, see [README-zh.md](README-zh.md).
+
+## Features
+
+1. Control your terminal AI CLI through Telegram whenever you need it.
+2. Capture lightweight task management and bug reports directly inside Telegram.
+3. Switch between Codex / ClaudeCode terminal CLIs in one tap from Telegram.
+4. Send commands over the HTTPS channel provided by the Telegram Bot API, protected by end‑to‑end TLS.
+5. Keep runtime logs and state files under `~/.config/vibego/` so sensitive data never leaves the machine.
+
+## Environment Requirements
+
+- Install the core CLI dependencies with Homebrew to keep scripts aligned:
+  ```bash
+  brew install python@3.11 tmux
+  ```
+  The CLI verifies Python >= 3.11 when you run `vibego start` (see `pyproject.toml` `requires-python` and the Python
+  guard in `vibego_cli/main.py`). Validate with `python3 --version` (must show 3.11+) and `tmux -V`.
+- To run the Codex model you also need the Codex CLI:
+  ```bash
+  brew install codex
+  ```
+  `scripts/run_bot.sh` checks for the `codex` executable before the worker launches. Confirm with `codex --version`.
+- The scripts use the `python3` available on your `PATH` and automatically create `~/.config/vibego/runtime/venv` on
+  first launch to install Python dependencies. If you prefer to bootstrap manually:
+  ```bash
+  python3 -m venv ~/.config/vibego/runtime/venv
+  source ~/.config/vibego/runtime/venv/bin/activate
+  ```
+  Set `VIBEGO_RUNTIME_ROOT` if you need a custom runtime location (pipx users typically do not).
+
+## Quick Start
+
+### Create and retrieve a Telegram bot token
+
+Use the official Telegram BotFather guide (<https://core.telegram.org/bots#botfather>):
+
+1. Search for `@BotFather` in the Telegram client and start a chat.
+2. Send `/start`, then `/newbot`, and follow the prompts for bot name and username.
+3. BotFather returns an HTTP API token resembling `123456789:ABC...`; store it safely.
+4. To regenerate or reset the token, send `/token` in the same chat and pick the bot.
+
+### Install and start vibego
+
+Before continuing, make sure Codex / ClaudeCode CLIs are installed and logged in, and that you have a Telegram bot token
+ready.
+
+- Consider merging the contents of [AGENTS-en.md](AGENTS-en.md) into your `$HOME/.codex/AGENTS.md` or
+  `$HOME/.claude/CLAUDE.md`.
+
+```bash
+pipx install vibego  # or pip install --user vibego
+vibego init          # initialise the config directory and persist the Master Bot Token
+vibego start         # start the master service
+```
+
+## Directory Layout
+
+- `bot.py`: aiogram 3 worker that supports multiple model sessions (Codex / ClaudeCode / reserved Gemini).
+- `scripts/run_bot.sh`: one-click bootstrap (builds venv, starts tmux + model CLI + bot).
+- `scripts/stop_bot.sh`: terminates the worker for a project (tmux session + bot process).
+- `scripts/start_tmux_codex.sh`: low-level tmux/CLI launcher invoked by `run_bot.sh`, forces UTF‑8 via `tmux -u`.
+- `scripts/models/`: model configuration modules (`common.sh` / `codex.sh` / `claudecode.sh` / `gemini.sh`).
+- `logs/<model>/<project>/`: runtime logs (`run_bot.log`, `model.log`, `bot.pid`, `current_session.txt`), defaulted to
+  `~/.config/vibego/logs/`.
+    - `model.log` is rotated by `scripts/log_writer.py`, with 20 MB cap per file and 24-hour retention (override via
+      `MODEL_LOG_MAX_BYTES`, `MODEL_LOG_RETENTION_SECONDS`).
+- `.env.example`: configuration template to copy to `.env` and adjust.
+
+## Logs & Directories
+
+```
+~/.config/vibego/logs/
+  └─ codex/
+      └─ mall-backend/
+           ├─ run_bot.log     # output from run_bot.sh
+           ├─ model.log       # model CLI output captured through tmux pipe-pane
+           ├─ bot.pid         # current bot process PID (used by stop_bot.sh)
+           └─ current_session.txt  # pointer to the latest JSONL session
+```
+
+> Starting in 2025, all logs, databases, and state files default to `~/.config/vibego/`. Use
+`./scripts/migrate_runtime.sh` to migrate legacy files created inside the repository back into the runtime directory.
+
+## Model Switching
+
+- Supported model parameters: `codex`, `claudecode`, `gemini` (placeholder).
+- Switch flow: `stop_bot.sh --model <old>` → `run_bot.sh --model <new>`.
+- Each model keeps an isolated configuration in `scripts/models/<model>.sh`; shared logic lives in
+  `scripts/models/common.sh`.
+- `ACTIVE_MODEL` is echoed in `/start` replies and logs, and exported to the environment for `bot.py`.
+
+### Codex
+
+| Variable             | Description                                                                      |
+|----------------------|----------------------------------------------------------------------------------|
+| `CODEX_WORKDIR`      | Codex CLI working directory (defaults to the value in `.env` or repository root) |
+| `CODEX_CMD`          | Launch command, default `codex --dangerously-bypass-...`                         |
+| `CODEX_SESSION_ROOT` | JSONL root directory (default `~/.codex/sessions`)                               |
+| `CODEX_SESSION_GLOB` | JSONL file pattern (default `rollout-*.jsonl`)                                   |
+
+### ClaudeCode
+
+| Variable              | Description                                                  |
+|-----------------------|--------------------------------------------------------------|
+| `CLAUDE_WORKDIR`      | Project directory (defaults to the same value used by Codex) |
+| `CLAUDE_CMD`          | CLI launch command, for example `claude --project <path>`    |
+| `CLAUDE_PROJECT_ROOT` | JSONL root directory (default `~/.claude/projects`)          |
+| `CLAUDE_SESSION_GLOB` | JSONL file pattern (default `*.jsonl`)                       |
+| `CLAUDE_PROJECT_KEY`  | Optional: explicitly set `~/.claude/projects/<key>`          |
+
+### Gemini (placeholder)
+
+- `scripts/models/gemini.sh` currently contains a placeholder command to be expanded once the official CLI is available.
+
+## aiogram Worker Behaviour
+
+- `/start`: returns `chat_id`, `MODE`, and `ACTIVE_MODEL`; logs record `chat_id` and `user_id`.
+- Text messages:
+    1. Pick the `SessionAdapter` based on `ACTIVE_MODEL`, read `current_session.txt`, and search `MODEL_SESSION_ROOT` if
+       necessary.
+    2. Inject the prompt into tmux (send `Esc` to clear modes, `Ctrl+J` for newline, `Enter` to submit).
+    3. Initialise offsets from `SESSION_OFFSETS`; `_deliver_pending_messages()` streams tail updates from the JSONL log.
+    4. During the watcher phase, the bot informs the user the `ACTIVE_MODEL` is processing and pushes the result once
+       ready (Markdown preserved).
+- MODE = A still honours `AGENT_CMD` for direct CLI execution.
+
+## New Scripts
+
+- `run_bot.sh`
+    - `--model <name>`: codex / claudecode / gemini.
+    - `--project <slug>`: directory name for logs/sessions; defaults to a slug derived from the working directory.
+    - `--foreground`: keep the process in the foreground (default: background via `nohup`).
+    - `--no-stop`: skip the pre-launch stop step (defaults to invoking `stop_bot.sh` for idempotency).
+- `stop_bot.sh`
+    - Idempotent stop: issues `tmux kill-session`, terminates the process from `bot.pid`, and clears cached files.
+    - Example: `./scripts/stop_bot.sh --model codex --project mall-backend`.
+
+## Configuration Highlights
+
+### `.env` (master global configuration)
+
+- Location: `~/.config/vibego/.env` (override with `VIBEGO_CONFIG_DIR`).
+- `MASTER_BOT_TOKEN`: token for the master bot; collected by `vibego init` and required for startup.
+- `MASTER_CHAT_ID` / `MASTER_USER_ID`: captured automatically the first time you interact with the master in Telegram to
+  mark authorised admins.
+- `MASTER_WHITELIST`: comma-separated list of chat IDs. Leave empty to allow any chat; latest value always wins if auto
+  updates occur.
+- You can add optional variables for proxies, log level, default model, etc. Scripts fall back to sensible defaults if
+  unspecified.
+
+- Project definitions persist in `~/.config/vibego/config/master.db` (SQLite) with a JSON mirror at
+  `~/.config/vibego/config/projects.json`. For offline edits, use the `config/projects.json.example` template in the
+  repository.
+- The master “⚙️ Project Management” menu can create/edit/delete projects; offline JSON edits are imported at startup
+  and synced to the database.
+- Required fields: `bot_name`, `bot_token`, `project_slug`, `default_model`.
+- Optional fields: `workdir` (project path), `allowed_chat_id` (pre-authorised chat). Leave blank to let the worker
+  capture the first valid chat and persist it to `~/.config/vibego/state/master_state.json`.
+- Other custom fields are currently ignored.
+
+### Automatic Authorisation & State
+
+- If `allowed_chat_id` is empty when the worker starts, the first authorised message writes to `state/state.json` and is
+  applied immediately.
+- Master restarts: call `stop_bot.sh` first, then restore running projects from the saved state.
+
+## Roadmap
+
+- Master bot will poll all project bots and invoke run/stop scripts to orchestrate workers; current version ships the
+  worker layout and logging standard first.
+- Gemini CLI support will be added once an official integration path is available.
+
+## Notes
+
+- `~/.config/vibego/.env` stores sensitive tokens and admin metadata—never commit it.
+- To trim log size, clean up `logs/<model>/<project>/` as needed or adjust script thresholds.
+- If you previously ran an old source checkout, run `./scripts/migrate_runtime.sh` and ensure only `.example` templates
+  remain in the repository to avoid committing databases or logs.
+- The master caches version checks and reminds you once per release; rerun `/projects` or restart the master to force a
+  new check.
+
+## Master Control
+
+- Launch the admin bot with `MASTER_BOT_TOKEN` (running `python master.py`).
+- Master stores the project list in `~/.config/vibego/config/master.db`; use the project management menu or edit
+  `~/.config/vibego/config/projects.json` directly. Key fields:
+    - `bot_name`: Telegram bot username (with or without `@`; CLI adds `@` when displaying).
+    - `bot_token`: Telegram token for the worker.
+    - `default_model`: default model (codex / claudecode / gemini).
+    - `project_slug`: directory/log slug.
+    - `workdir`: project working directory (optional).
+    - `allowed_chat_id`: authorised chat injected into the runtime environment.
+- State snapshot: `~/.config/vibego/state/master_state.json` records the active model and running status for each
+  project. On restart the master calls `stop_bot.sh`, then restores workers according to the state file.
+
+### Management Commands
+
+| Command                     | Description                                                                 |
+|-----------------------------|-----------------------------------------------------------------------------|
+| `/projects`                 | List all projects with their current status and model.                      |
+| `/run <project> [model]`    | Start a project worker; optional `model` overrides the default/current one. |
+| `/stop <project>`           | Stop the project worker.                                                    |
+| `/switch <project> <model>` | Stop the worker and relaunch it with a new model.                           |
+| `/start`                    | Show help and the total number of projects.                                 |
+| `/upgrade`                  | Run `pipx upgrade vibego && vibego stop && vibego start` to self-upgrade.   |
+
+- `<project>` accepts either the `project_slug` or `@bot_name`. Responses automatically render clickable `@` links.
+
+> The master only interacts with the admin bot. Project bots continue to handle business traffic through the worker (
+`bot.py`) launched by `run_bot.sh`.