Skip to content

Commit 221bb3f

Browse files
committed
update doc
1 parent bb481d9 commit 221bb3f

File tree

4 files changed

+88
-6
lines changed

4 files changed

+88
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,29 @@
11
# Ode
22

3+
[简体中文文档](README.zh-CN.md)
4+
35
Ode is a agent tool that bridges your coding agents (OpenCode, Claude Code, Codex and much more) to your favorite chat apps. Perfect for personal or team developers working on the go.
46

57
![Ode demo](static/ode-demo.png)
68

79
## Highlight features
810

9-
* Coding from anywhere, just chat and get response in slack.
10-
* Map coding session 1 - 1 to slack thread, and use worktree to get isolated, parallel coding is so easy.
11-
* Anyone in the channel can join coding without any extra setup, pay one account for all team members.
12-
* Message live message updates, you don't wait for response without any information, you can monitor from real-time text updates.
13-
* Per user git config, who start the thread becomes corresponding git commit author.
11+
* 🏖️ Coding from anywhere, just chat and get response in slack.
12+
* 🖇️ **Map coding session 1 - 1 to slack thread**, and use worktree to get isolated, parallel coding is so easy.
13+
* 👬 Anyone in the channel can join coding without any extra setup, **pay one account for all team members**.
14+
* 📝 **Message live message updates**, you don't wait for response without any information, you can monitor from real-time text updates.
15+
* 🐙 **Per user git config**, who start the thread becomes corresponding git commit author.
1416

1517
## Why Slack
1618

17-
* Slack has thread based messaging, making it easy to port to sessions in coding agents. Just focus on one thing in one thread.
19+
* Slack has **thread based** messaging, making it easy to port to sessions in coding agents. Just focus on one thing in one thread.
1820
* Support for message edit, markdown like text render make slack perfect to show coding related information.
1921
* Also want to support as much chatting tools as possible.
2022

23+
![Channel](static/channel-setting.png)
24+
25+
* **Channel based settings** lets you configure multiple work directories easily in one machine and one slack workspace.
26+
2127
## Setup
2228

2329
### Prerequisites

README.zh-CN.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Ode
2+
3+
[English](README.md)
4+
5+
Ode 是一个编程代理工具,可将你的编码Agent(OpenCode、Claude Code、Codex 等)连接到你常用的聊天应用中。非常适合个人开发者或团队在移动场景下协作开发。
6+
7+
![Ode demo](static/ode-demo.png)
8+
9+
## 核心特性
10+
11+
* 🏖️ 随时随地编码,在 Slack 中聊天即可获得响应。
12+
* 🖇️ **将编码会话与 Slack 线程 1:1 映射**,并结合 worktree 实现隔离开发,轻松并行协作。
13+
* 👬 频道内任何人都可以直接参与编码,无需额外配置,**一个账号可供团队成员共享使用**
14+
* 📝 **消息实时更新**,不再盲等回复,你可以通过实时文本更新持续跟踪进度。
15+
* 🐙 **按用户设置 git 配置**,由谁发起线程,就以谁作为对应提交作者。
16+
17+
## 为什么选择 Slack
18+
19+
* Slack 支持**线程式**消息,天然适合映射编码代理中的会话。一个线程只聚焦一件事。
20+
* 支持消息编辑、类 Markdown 文本渲染,Slack 非常适合展示编码相关信息。
21+
* 我们也希望后续支持尽可能多的聊天工具。
22+
23+
![Channel](static/channel-setting.png)
24+
25+
* **基于频道的设置**,可在同一台机器和同一个 Slack 工作区中轻松配置多个工作目录。
26+
27+
## 安装与配置
28+
29+
### 前置要求
30+
31+
- 已配置 OpenCode / Claude Code / Codex / Kimi Code... 至少一个编码 CLI。
32+
- 注册并配置一个启用了 Socket Mode 的 Slack Bot,获取其 APP TOKEN(xapp...)和 BOT TOKEN(xbot..)。
33+
- 如果你不太熟悉 Slack Bot 的配置与权限范围,可能会稍显复杂。可直接下载 [`slack-app-manifest.json`](https://raw.githubusercontent.com/odefun/ode/main/static/slack-app-manifest.json) 并通过 manifest 文件生成。
34+
35+
### 安装与运行
36+
37+
一行安装(macOS/Linux):
38+
39+
```bash
40+
curl -fsSL https://raw.githubusercontent.com/odefun/ode/main/scripts/install.sh | bash
41+
```
42+
43+
```bash
44+
ode
45+
# 如果你想暴露设置页面,可使用 ODE_WEB_HOST=0.0.0.0 ode
46+
```
47+
48+
设置界面可通过 http://127.0.0.1:9293 访问,或在 Slack 中使用 `/setting` 命令,例如 `@bot /setting`
49+
50+
## 代理列表
51+
52+
| 代理 | Logo | 项目 |
53+
| --- | --- | --- |
54+
| OpenCode | <img src="https://img.shields.io/badge/OpenCode-111111?style=for-the-badge&logo=opencollective&logoColor=white" alt="OpenCode logo" /> | [opencode.ai](https://opencode.ai/) |
55+
| Codex | <img src="https://img.shields.io/badge/Codex-111111?style=for-the-badge&logo=openai&logoColor=white" alt="Codex logo" /> | [github.com/openai/codex](https://github.com/openai/codex) |
56+
| Claude Code | <img src="https://img.shields.io/badge/Claude_Code-111111?style=for-the-badge&logo=anthropic&logoColor=white" alt="Claude Code logo" /> | [docs.anthropic.com/claude-code](https://docs.anthropic.com/en/docs/claude-code/overview) |
57+
| Kimi Code | <img src="https://img.shields.io/badge/Kimi_Code-111111?style=for-the-badge&logo=moonrepo&logoColor=white" alt="Kimi Code logo" /> | [moonshotai.github.io/kimi-cli](https://moonshotai.github.io/kimi-cli/) |
58+
| Qwen Code | <img src="https://img.shields.io/badge/Qwen_Code-111111?style=for-the-badge&logo=alibabacloud&logoColor=white" alt="Qwen Code logo" /> | [github.com/QwenLM/qwen-code](https://github.com/QwenLM/qwen-code) |
59+
| Kilo Code | <img src="https://img.shields.io/badge/Kilo_Code-111111?style=for-the-badge&logo=codeium&logoColor=white" alt="Kilo Code logo" /> | [kilo.ai/docs/code-with-ai/platforms/cli](https://kilo.ai/docs/code-with-ai/platforms/cli) |
60+
| Kiro CLI | <img src="https://img.shields.io/badge/Kiro_CLI-111111?style=for-the-badge&logo=amazonec2&logoColor=white" alt="Kiro CLI logo" /> | [kiro.dev/docs/cli/reference](https://kiro.dev/docs/cli/reference/cli-commands/) |
61+
62+
## 使用方式
63+
64+
1. 邀请机器人进入一个频道。
65+
2. 执行 `@bot /setting`,选择频道设置,选择你的编码 CLI(OpenCode 也可选择模型)以及工作目录。
66+
3. 使用 `@bot` 并附上你的提示词。
67+
4. 机器人会调用编码代理处理你的消息。
68+
69+
## Worktree
70+
71+
- 每个 Slack 线程都会使用一个独立的 git worktree,路径为 `<repoRoot>/.worktree/<threadId>`
72+
- 如果你不想使用 worktree,可执行 `@bot /setting`,进入通用设置并选择默认模式。
73+
74+
## 许可证
75+
76+
MIT

static/channel-setting.png

148 KB
Loading

static/ode-demo.png

-430 KB
Loading

0 commit comments

Comments
 (0)