PhoneWork/README.md
Yuyao Huang (Sam) 0eb29f2dcc feat: 初始化项目基础结构
添加项目基础文件和目录结构,包括:
- 初始化空包目录(bot/agent/orchestrator)
- 配置文件(config.py)和示例(keyring.example.yaml)
- 依赖文件(requirements.txt)
- 主程序入口(main.py)
- 调试脚本(debug_test.py)
- 文档说明(README.md)
- Git忽略文件(.gitignore)
- 核心功能模块(pty_process/manager/handler/feishu等)
2026-03-28 07:44:44 +08:00

49 lines
1015 B
Markdown

# PhoneWork
Feishu bot integration with Claude Code CLI.
## Architecture
- **Agent CLI**: Claude Code (print mode)
- **Chat Server**: FastAPI
- **Client**: Feishu bot API (long-connection)
## Setup
### 1. Feishu App
Create app at https://open.feishu.cn:
- Enable **Bot** capability
- Enable **long-connection event subscription** (no public URL needed)
- Get `FEISHU_APP_ID` and `FEISHU_APP_SECRET`
### 2. LLM Endpoint
Configure OpenAI-compatible endpoint:
- `OPENAI_BASE_URL`
- `OPENAI_API_KEY`
- `OPENAI_MODEL`
### 3. Claude Code CLI
- Install and authenticate `claude` command
- Ensure available in PATH
### 4. Configuration
```bash
cp keyring.example.yaml keyring.yaml
# Edit keyring.yaml with your credentials
```
### 5. Run
```bash
pip install -r requirements.txt
python main.py
```
## Requirements
| Item | Notes |
|---|---|
| Python 3.11+ | Required |
| Feishu App | Bot + long-connection enabled |
| OpenAI-compatible LLM | API endpoint and key |
| Claude Code CLI | Installed + authenticated |