larkway 0.3.6 → 0.3.8

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
@@ -2,7 +2,7 @@
2
2
 
3
3
  > Turn your Claude Code or Codex subscription into a Feishu (Lark) agent your whole team can @-mention.
4
4
 
5
- [中文版](README.zh.md)
5
+ 🌐 [larkway.dev](https://larkway.dev) · [中文版](README.zh.md)
6
6
 
7
7
  ---
8
8
 
@@ -12,6 +12,14 @@ You @ the bot in a Feishu thread. It runs on your machine — reading your real
12
12
 
13
13
  ---
14
14
 
15
+ ## 💬 Join the community (Feishu)
16
+
17
+ See Larkway in action and talk through how to set it up for your team — scan to join the **Larkway 交流群** (QR never expires):
18
+
19
+ <img src="https://raw.githubusercontent.com/chuckwu0/larkway/main/assets/larkway-feishu-qr.jpg" width="260" alt="Larkway Feishu group QR" />
20
+
21
+ ---
22
+
15
23
  ## Why
16
24
 
17
25
  The engineers on your team know how a feature is actually implemented. Everyone else has to ask them. That friction compounds: a data analyst wondering whether a metric counts deleted records, a PM asking which API endpoint powers a chart, a QA engineer trying to reproduce a bug without context.
@@ -64,13 +72,11 @@ This boundary is intentional. Workflow changes go into your repository's agent g
64
72
 
65
73
  ## Quick start
66
74
 
67
- > **Note:** npm publish is pending. Until then, install straight from the GitHub repo (the `prepack` build runs on install):
75
+ > Install globally with npm:
68
76
  >
69
77
  > ```bash
70
- > npm i -g github:chuckwu0/larkway
78
+ > npm i -g larkway
71
79
  > ```
72
- >
73
- > Once published: `npm i -g larkway`
74
80
 
75
81
  ```bash
76
82
  # 1. Check your environment
@@ -107,7 +113,7 @@ Larkway never injects `ANTHROPIC_API_KEY` or any other API key. The subprocess i
107
113
  | **L2 identity memory** | "Who I am, what I must not do, where to find the workflow" (thin) | `~/.larkway/bots/<id>.memory.md` |
108
114
  | **L3 workflow** | State machine, gates, commands — the actual job | **Your business repo**: `AGENTS.md`, `CLAUDE.md`, `.agents/skills/`, `.claude/skills/` |
109
115
 
110
- Secrets live only in `~/.larkway/.env` (mode 0600). Config and memory contain no secrets and are safe to share via the central config library.
116
+ Secrets live only in `~/.larkway/.env` (mode 0600). Config and memory contain no secrets.
111
117
 
112
118
  ---
113
119
 
@@ -115,7 +121,6 @@ Secrets live only in `~/.larkway/.env` (mode 0600). Config and memory contain no
115
121
 
116
122
  - **Multiple bots on one bridge** — a read-only Q&A bot and a write-capable engineering bot can share the same process, each with its own L1/L2/L3 definition
117
123
  - **Web UI** — `larkway ui` opens a local management dashboard (127.0.0.1 + token); create bots, edit memory, watch live logs
118
- - **Central config library** — `larkway promote <id>` pushes bot config (no secrets) to a shared git repository so teammates can `larkway sync` and discover bots; the library stores config, not deployment state
119
124
  - **Session continuity** — every Feishu thread maps to a persistent `session_id`; the agent remembers what it did in prior turns
120
125
  - **Agent Workspace** — per-thread git worktrees; the agent can run multiple threads concurrently without git conflicts
121
126
  - **Codex runtime pre-checks** — `larkway doctor` validates Codex state directory writability before start
@@ -144,9 +149,6 @@ Secrets live only in `~/.larkway/.env` (mode 0600). Config and memory contain no
144
149
  | `larkway memory edit <id>` | Edit L2 identity memory |
145
150
  | `larkway perms <id>` | Adjust L1 permissions |
146
151
  | `larkway ui` | Start local web management UI |
147
- | `larkway central set \| show \| unset` | Connect/disconnect central config library |
148
- | `larkway promote <id>` | Push bot config (no secrets) to central library |
149
- | `larkway sync` | Pull bot configs from central library |
150
152
  | `larkway update` | Upgrade Larkway and restart bridge |
151
153
 
152
154
  ---
package/README.zh.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  > 把你的 Claude Code 或 Codex 订阅变成全团队都能 @ 的飞书 Agent。
4
4
 
5
- [English](README.md)
5
+ 🌐 [larkway.dev](https://larkway.dev) · [English](README.md)
6
6
 
7
7
  ---
8
8
 
@@ -12,6 +12,14 @@
12
12
 
13
13
  ---
14
14
 
15
+ ## 💬 交流群(飞书)
16
+
17
+ 想看实际效果、聊聊怎么给你的团队搭 agent?扫码加入 **Larkway 交流群**(二维码永久有效):
18
+
19
+ <img src="https://raw.githubusercontent.com/chuckwu0/larkway/main/assets/larkway-feishu-qr.jpg" width="260" alt="Larkway 交流群 飞书二维码" />
20
+
21
+ ---
22
+
15
23
  ## 背景
16
24
 
17
25
  工程师知道某个功能是怎么实现的,其他人不知道,只能问。这个摩擦不断叠加:数据分析师想弄清楚某个指标有没有过滤已删除的记录,PM 想知道某个图表背后调的是哪个 API,QA 工程师在没有上下文的情况下试图复现一个 bug。
@@ -64,13 +72,11 @@ lark.card ◄── agent 读仓库、跑 bash、改代码、
64
72
 
65
73
  ## 快速上手
66
74
 
67
- > **注意:** npm 包尚未发布。现阶段直接从 GitHub 仓库安装(`prepack` 会在安装时自动构建):
75
+ > 全局安装:
68
76
  >
69
77
  > ```bash
70
- > npm i -g github:chuckwu0/larkway
78
+ > npm i -g larkway
71
79
  > ```
72
- >
73
- > 发布后可直接:`npm i -g larkway`
74
80
 
75
81
  ```bash
76
82
  # 1. 检查环境
@@ -107,7 +113,7 @@ Larkway 不注入 `ANTHROPIC_API_KEY` 或任何其他 API key。子进程继承
107
113
  | **L2 身份 memory** | "我是谁、禁止什么、工作流指针"(薄) | `~/.larkway/bots/<id>.memory.md` |
108
114
  | **L3 工作流** | 状态机、gate、命令——实际的工作内容 | **业务 repo**:`AGENTS.md`、`CLAUDE.md`、`.agents/skills/`、`.claude/skills/` |
109
115
 
110
- 密钥只存在本机 `~/.larkway/.env`(权限 0600)。配置和 memory 不含密钥,可以安全地通过中心配置库共享。
116
+ 密钥只存在本机 `~/.larkway/.env`(权限 0600)。配置和 memory 不含密钥。
111
117
 
112
118
  ---
113
119
 
@@ -115,7 +121,6 @@ Larkway 不注入 `ANTHROPIC_API_KEY` 或任何其他 API key。子进程继承
115
121
 
116
122
  - **一个 bridge 跑多个 bot** —— 只读答疑 bot 和有写权限的工程 bot 可以共用同一个进程,各自有独立的 L1/L2/L3 定义
117
123
  - **Web 管理面** —— `larkway ui` 打开本地管理后台(127.0.0.1 + token),可以建 bot、编辑 memory、查看实时日志
118
- - **中心配置库** —— `larkway promote <id>` 把 bot 配置(不含密钥)推送到共享 git 仓库,队友可以 `larkway sync` 发现和复用;库只存配置,不存部署状态
119
124
  - **Session 续接** —— 每个飞书话题映射到持久 `session_id`,agent 记得之前做了什么
120
125
  - **Agent Workspace** —— 每个话题独立 git worktree,agent 并发处理多个话题不冲突
121
126
  - **Codex 运行时预检** —— `larkway doctor` 在启动前验证 Codex 状态目录可写
@@ -144,9 +149,6 @@ Larkway 不注入 `ANTHROPIC_API_KEY` 或任何其他 API key。子进程继承
144
149
  | `larkway memory edit <id>` | 编辑 L2 身份 memory |
145
150
  | `larkway perms <id>` | 调整 L1 权限 |
146
151
  | `larkway ui` | 启动本地 Web 管理面 |
147
- | `larkway central set \| show \| unset` | 连接/断开中心配置库 |
148
- | `larkway promote <id>` | 把 bot 配置(不含密钥)推送到中心库 |
149
- | `larkway sync` | 从中心库拉 bot 配置 |
150
152
  | `larkway update` | 升级 Larkway 并重启 bridge |
151
153
 
152
154
  ---