docs: separate user and developer installation

This commit is contained in:
banteg
2025-12-29 20:16:56 +04:00
parent 718f465b55
commit 2dc6a61fa6
2 changed files with 23 additions and 16 deletions
+15
View File
@@ -2,6 +2,21 @@
This document describes the internal architecture and module responsibilities. This document describes the internal architecture and module responsibilities.
## Development Setup
```bash
# Clone and enter the directory
git clone https://github.com/banteg/takopi
cd takopi
# Run directly with uv (installs deps automatically)
uv run takopi --help
# Or install locally from the repo to test outside the repo
uv tool install .
takopi --help
```
## Module Responsibilities ## Module Responsibilities
### `exec_bridge.py` — Main Entry Point ### `exec_bridge.py` — Main Entry Point
+8 -16
View File
@@ -16,23 +16,23 @@ A Telegram bot that bridges messages to [Codex](https://github.com/openai/codex)
### Prerequisites ### Prerequisites
- Python 3.12+
- [uv](https://github.com/astral-sh/uv) package manager - [uv](https://github.com/astral-sh/uv) package manager
- Codex CLI on PATH - Codex CLI on PATH
### Installation ### Installation
```bash ```bash
# Clone and enter the directory # Install with uv, then run as `takopi`
cd takopi uv tool install takopi
takopi
# Run directly with uv (installs deps automatically) # or run with uvx
uv run takopi --help uvx takopi
``` ```
### Configuration ### Configuration
Create `~/.codex/takopi.toml` (or `./.codex/takopi.toml` for a repo-local config): Create `~/.codex/takopi.toml` (or `.codex/takopi.toml` for a repo-local config):
```toml ```toml
bot_token = "123456789:ABCdefGHIjklMNOpqrsTUVwxyz" bot_token = "123456789:ABCdefGHIjklMNOpqrsTUVwxyz"
@@ -52,7 +52,7 @@ Create a Codex profile in `~/.codex/config.toml`:
```toml ```toml
[profiles.takopi] [profiles.takopi]
model = "gpt-4.1" model = "gpt-5.2-codex"
``` ```
Then run takopi with: Then run takopi with:
@@ -116,15 +116,7 @@ Running two bridge processes with the same bot token will cause them to compete
## Development ## Development
See [`developing.md`](developing.md) for architecture details. See [`developing.md`](developing.md).
```bash
# Run tests
uv run pytest
# Run with debug logging
uv run takopi --debug 2>&1 | tee debug.log
```
## License ## License