codelark 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -8,6 +8,7 @@
8
8
 
9
9
  - 代码仓库:https://github.com/huiyeruzhou/codelark
10
10
  - 文档站:https://huiyeruzhou.github.io/site/codelark/
11
+ - 当前 npm 版本:`codelark@0.1.1`
11
12
 
12
13
  ## 核心能力
13
14
 
@@ -57,6 +58,23 @@
57
58
 
58
59
  ### 安装
59
60
 
61
+ - 推荐使用 tmux provider 驱动本地 agent
62
+ - macOS
63
+ ```sh
64
+ # 安装Homebrew
65
+ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
66
+ # 安装 tmux
67
+ brew install tmux
68
+ ```
69
+ - Linux
70
+ ```sh
71
+ sudo apt install tmux
72
+ ```
73
+ - Windows
74
+ ```sh
75
+ winget install --id marlocarlo.psmux
76
+ ```
77
+
60
78
  > 如果你通过环境变量配置模型、代理或 API Key,需要在启动 `codelark` 前 export。
61
79
 
62
80
  ```bash
@@ -69,30 +87,27 @@ npm install -g codelark
69
87
  codelark run
70
88
  ```
71
89
 
72
- `codelark run` 会在启动 bridge 前为当前 CodeLark 配置初始化专属 lark-cli 运行环境:把飞书/Lark App 配置投影到 `~/.codelark/runtime/lark-cli-source/config.json`,绑定到 `~/.codelark/runtime/lark-cli/`,并把 `LARK_CHANNEL_CONFIG` 与 `LARKSUITE_CLI_CONFIG_DIR` 注入 bridge/agent 进程。如果默认 lark-cli 配置里已有同 App 的用户授权,启动时会复制到专属目录并切换为 user-default。这样 bridge 内部和 agent 调用 `lark-cli` 时会使用 CodeLark 当前配置,而不是误读默认用户 HOME 下的其他 lark-cli 配置。
73
-
74
- 默认工作台地址是 `http://127.0.0.1:4781`,端口被占用时会自动切到可用端口。查看当前状态和地址:
75
-
76
- ```bash
77
- codelark status
78
- codelark url
79
- ```
90
+ ## v0.1.1
80
91
 
81
- `setup` 向导的主要工作是:
92
+ `0.1.1` 改进了 tmux provider 的启动恢复和输入透传:Codex 启动弹窗、update prompt、delayed ready 和 `Working` 输入行都会被端到端验证并正确处理。`/tmux-screen` 的行数配置现在表示最终希望看到的行数,而不是直接传给 tmux 的额外历史行数。
82
93
 
83
- - 飞书鉴权:
84
- - 默认引导:使用 `lark-cli` 扫码创建或导入机器人配置。
85
- - 手动引导:直接粘贴飞书 `App ID` 和 `App Secret`。
86
- - 配置:
87
- - 选择默认 runtime:优先使用 `~/.codex`;检测到 `~/.claude-code-router` 会推荐 Claude Code Router;都没有时默认 Claude Code。
88
- - 之后选择默认工作目录,默认是运行 `codelark setup` 时的当前目录。
89
- - 以上内容会保存到 `~/.codelark/config.json`,并更新 `config.env`。`config.json` 是系统实际使用的配置文件;`config.env` 方便人工配置,也可通过环境变量覆盖,系统启动时会用 env 覆盖 json。`codelark run` / `codelark start` 会再把当前配置绑定到 CodeLark 专属 lark-cli 运行目录。
94
+ 完整发布说明见 [Release Notes](docs/guide/release-notes.md)。
90
95
 
91
- - 安装 skills:安装向导会说明并默认勾选这些 skill,也可以逐个关闭或全部取消。手动安装可运行:
96
+ ## 常用命令
97
+ - `/`:查看当前聊天/会话诊断;修改当前会话配置可用 `/provider`、`/model`、`/mode`、`/reasoning` 等。
98
+ - `/set`:修改全局默认配置
99
+ - `//...`:向模型发送以 `/` 开头的文本,例如 `//status` 会作为 `/status` 发给模型。
100
+ - 特别常用:`//goal`!
101
+ - `/tmux-screen`:显示本地 agent 的 TUI 界面,遇到卡住不动的问题排查用。
102
+ - `<enter>`、`<C-c>`、`<esc>`:向 tmux Provider 发送控制键。
103
+ - `/p tmux`:重启当前 runtime 的 tmux Provider 会话
104
+ - `/p sdk`:改为使用 SDK provider 提供 agent 服务。
105
+ - `/stop`:停止当前任务
106
+ - `/t`:查看最近本地 Codex / Claude Code 会话。
107
+ - `/t rename <名称>`:重命名当前线程;群聊通道会同步修改群聊名称,真实群名会自动带 `[botname]` 前缀。
108
+ - `/new`:发送创建表单,填写名称和工作目录后创建新的 IM 群聊会话。
109
+ - `/clear [名称] [路径]`:在当前聊天上下文创建新的对话并绑定过去,之后仍可用 `/t` 找回旧对话。
92
110
 
93
- ```bash
94
- codelark install-skills
95
- ```
96
111
 
97
112
  ## 典型使用方式
98
113
 
@@ -105,21 +120,6 @@ codelark install-skills
105
120
  /t
106
121
  ```
107
122
 
108
- `/t` 默认显示最近 20 条本地 Codex / Claude Code 会话。需要更多时发送:
109
-
110
- ```text
111
- /t all
112
- ```
113
-
114
- 查看最多 100 条本地 Codex / Claude Code 会话。
115
- 再通过:
116
-
117
- ```text
118
- /t 1
119
- ```
120
-
121
- 切到对应线程。
122
-
123
123
  ### 2. 继续对话
124
124
 
125
125
  绑定成功后,直接发送普通消息即可继续当前线程。
@@ -135,9 +135,7 @@ codelark install-skills
135
135
  /new
136
136
  ```
137
137
 
138
- 会发送创建表单,让你填写群聊名称和工作目录。表单会默认带出当前会话的工作目录;临时草稿线程也有自己的工作目录,可以直接作为默认目录。当前聊天还没有绑定会话时,会使用全局默认工作目录。
139
-
140
- 也可以用纯文本直接指定名称,或同时指定名称和目录:
138
+ 会发送创建表单,让你填写群聊名称和工作目录。表单会默认带出当前会话的工作目录也可以用纯文本直接指定名称,或同时指定名称和目录:
141
139
 
142
140
  ```text
143
141
  /new my-thread
@@ -149,36 +147,7 @@ codelark install-skills
149
147
 
150
148
  `/clear [名称] [路径]` 会在当前聊天上下文创建一个新的对话,并把当前聊天绑定过去;名称或路径包含空格时,请使用英文双引号 `"` 或英文单引号 `'`。之后可用 `/t` 重新附加到之前的对话。若当前 SDK 任务、共享镜像状态或 tmux TUI 追加输入仍显示运行中,会先询问是否终止旧对话;确认后再切换。群聊通道会同步重命名群聊,真实群名会自动带 `[botname]` 前缀。
151
149
 
152
- ## 常用命令
153
-
154
- ### 会话
155
150
 
156
- - `/t`:查看最近 20 条本地 Codex / Claude Code 会话。
157
- - 表格标记:绿色表示当前聊天绑定;灰色表示其他聊天已绑定。
158
- - `/t rename <名称>`:重命名当前线程;群聊通道会同步修改群聊名称,真实群名会自动带 `[botname]` 前缀。
159
- - `/new`:发送创建表单,填写名称和工作目录后创建新的 IM 群聊会话。
160
- - `/clear [名称] [路径]`:在当前聊天上下文创建新的对话并绑定过去,之后仍可用 `/t` 找回旧对话。
161
-
162
- ### 运行设置
163
-
164
- - `/`:查看/配置当前聊天,包括模型、模式、思考级别、共享镜像状态。
165
- - `/r <1-5>`:切换思考级别。
166
- - `/mode <normal|yolo>`:切换运行模式,自动映射到 Codex 和 Claude Code 的对应模式。
167
- - `/model <模型名>`:切换当前 IM 会话模型。
168
- - `/require-at`:查看当前飞书通道的群聊 @bot 要求;`/require-at on|off` 可切换是否必须 @bot。
169
- - `/set`:查看全局配置,然后用 `/set <key> <value>` 修改。
170
-
171
- ### 对话与诊断
172
-
173
- - `//...`:向模型发送以 `/` 开头的文本,例如 `//status` 会作为 `/status` 发给模型。
174
- - 特别常用:`//goal`!
175
- - `/tmux-screen`:诊断 Codex 的运行情况。
176
- - `<enter>`:向 Codex 对话发送回车。
177
- - `<C-c>`:向 Codex 对话发送终止。
178
- - `/p tmux`:重启 Codex 会话。
179
- - `/his [N]`:把当前线程最近消息渲染成卡片发送。
180
- - `/his json`:直接发送原始 Codex / Claude Code session JSONL 文件,不做二次包装或后处理。
181
- - `/stop`:停止当前任务;tmux Provider 中已有运行中 TUI turn 时会向 tmux 发送 `<C-c>`。
182
151
 
183
152
  ## 社区
184
153
 
package/SECURITY.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  ## Credential Storage
4
4
 
5
- CodeLark credentials are stored in `~/.codelark/config.env` and the local runtime data under `~/.codelark/`.
5
+ CodeLark credentials are stored in `~/.codelark/config.toml` and scoped TOML files under `~/.codelark/config/`. Legacy `config.json` / `config.env` files are migration inputs only and are not runtime configuration sources after migration.
6
6
 
7
7
  This repository never stores secrets in source control.
8
8