Skip to main content

Bridge QwenPaw (compatible with CoPaw) with larksuite/lark-cli for Feishu/Lark automation.

Project description

Lark Agent Bridge

PyPI CI

一键把飞书官方 lark-cli 接到 QwenPaw:自动检查安装、续跑授权、权限快照、可回滚(兼容 CoPaw)。

Windows · Linux · macOS 通用 | 当前支持 QwenPaw(兼容 CoPaw)


支持哪些飞书能力

接入后,QwenPaw 可通过本机 lark-cli 调用飞书官方能力(以你本机 lark-cli --help 为准),常见场景包括:

领域 常用命令 典型能力
协作办公 docs / drive / sheets / base / wiki 云文档、云空间、电子表格、多维表格、知识库
沟通与日程 im / calendar / vc / minutes / mail 即时消息、日程忙闲、视频会议、会议纪要、邮件
组织与流程 contact / task / approval / event 通讯录、任务、审批、事件订阅
扩展与高级 whiteboard / api / config / auth 白板、原生 OpenAPI 调用、应用配置、授权与权限检查

调用方式建议按三层走:快捷命令 → 已注册 API 命令 → 原生 lark-cli api

本项目只负责“桥接与治理”(安装检查、续跑、判权、回滚),不替代 lark-cli 本身能力。

能力与领域映射参考官方文档(随上游版本更新):


开始前先看一眼

检查项 怎么确认 没有怎么办
Python 3.10+ python --version python.org 下载
pip pip --version Python 自带;若报错见下方 FAQ
QwenPaw 已初始化 qwenpaw app 能打开 pip install qwenpaw 然后 qwenpaw init(旧版可用 copaw init
Node.js 18+ node --version Windows: winget install OpenJS.NodeJS.LTS;macOS: brew install node;Linux: sudo apt install nodejs npm

全部打勾就可以开始了。缺哪个先装哪个,setup 也会帮你检查。


快速开始

第 1 步:安装本工具

推荐(无需 Git) — 从 PyPI 安装已发布的 wheel:

pip install lark-agent-bridge

升级本工具:

pip install -U lark-agent-bridge

若 PyPI 上暂时搜不到包(例如维护者尚未完成首次上传),可用下面两种方式之一,同样不需要安装 Git

备选 A — 按 版本标签 安装源码 zip(固定版本,无需 Git;与下面命令里的标签名一致即可):

pip install "https://github.com/guodaxia103/lark-agent-bridge/archive/refs/tags/v0.3.8.zip"

v0.3.8 换成标签页最新的版本号即可。

备选 B — 需要本机已安装 Git — 跟踪 main 分支最新开发版:

pip install "git+https://github.com/guodaxia103/lark-agent-bridge.git@main"

开发者 — 克隆后可编辑安装:

git clone https://github.com/guodaxia103/lark-agent-bridge.git
cd lark-agent-bridge
pip install -e ".[dev]"

安装完成后,终端里应能运行 lark-bridge --version

第 2 步:一键配置

lark-bridge setup

setup 会依次检查 Python、QwenPaw、Node、lark-cli,按需安装,再把 lark_cli_bridge 技能写入 QwenPaw 工作区。

如果检测到 lark-cli 还没配置应用或还没登录,setup 会打印明确的下一步命令并立即停止(不会再让你在同一轮里“按 Enter 继续”),避免小白误操作后误以为已经配置完成。

第 3 步:完成飞书配置与登录

setup 会检测飞书配置和登录状态。如果还没配过,它会提示你在终端执行:

lark-cli config init --new    # 在浏览器里配置飞书应用
lark-cli auth login --recommend   # 在浏览器里登录飞书授权

这两步需要在浏览器中完成。完成后无需“按 Enter 继续”,直接重新执行下一条命令即可。 浏览器操作完成后,请重新执行:

lark-bridge resume

第 4 步:在 QwenPaw 中启用技能

在 QwenPaw 控制台新开一个对话,确认技能列表中出现 lark_cli_bridge 并已启用。

确认一下

lark-bridge status

看到各项打勾就说明一切就绪。


命令速查表

命令 用人话说 什么时候用
lark-bridge setup 一条龙:检查环境 → 装 lark-cli → 部署技能 第一次用、重装
lark-bridge install setup 完全一样(别名) 同上
lark-bridge upgrade 小白一键升级:更新技能并给下一步建议 工具升级后
lark-bridge resume 续跑安装:完成浏览器授权后继续部署 setup 中断后
lark-bridge status 体检单:环境、配置、技能状态 确认是否正常
lark-bridge update 更新技能文件(自动备份,可回滚) pip 升级本工具后
lark-bridge rollback 回滚到备份(默认最近一次) 误更新、误卸载后恢复
lark-bridge backups list/cleanup 查看/清理备份(保留最近 N 份) 备份太多、需要手动整理
lark-bridge fix 补技能 / 修清单 技能丢失、清单异常
lark-bridge verify 测 lark-cli:装没装好、能不能跑 装完 CLI 后自检
lark-bridge doctor 详细诊断:比 status 更啰嗦 需要把日志发给别人
lark-bridge perms sync/show/check 权限快照与 scope 检查 调飞书前先判权限
lark-bridge uninstall 卸技能,可选卸 lark-cli 不想用了、从零再来
lark-bridge cli ... 透传给 lark-cli(与直接敲 lark-cli ... 等价) 只想记一个命令前缀
lark-bridge lark ... cli 完全一样(别名) 同上

不确定有哪些命令时:lark-bridge --help


两套命令别混了

你敲的 是谁 干什么
lark-bridge … 本工具 检查环境、部署/更新/卸载 QwenPaw 技能
lark-cli … 飞书官方命令行 调飞书 API、登录/退出/查权限

想只记一个前缀lark-bridge clilark-bridge lark 后面接的内容会原样交给 lark-cli:

lark-bridge cli --version
lark-bridge cli auth login --recommend
lark-bridge lark wiki spaces list --page-all

各命令详解

setup / install

检查 Python、QwenPaw、Node;没有就提示或帮你装。检测到缺少 lark-cli 时,默认会自动安装(除非你显式传 --no-install-lark-cli)。最后把技能拷进 QwenPaw 工作区。

lark-bridge setup                          # 最常用
lark-bridge setup --workspace 你的工作区    # 指定工作区
lark-bridge setup --all-workspaces         # 所有工作区
lark-bridge setup --cn                     # 国内 npm 镜像
lark-bridge setup --skip-lark-check --force -y  # 只覆盖技能文件,跳过环境检查
lark-bridge setup --no-install-lark-cli    # 缺少 lark-cli 时不自动安装(高级选项)
参数 含义
--workspace <名字> 只处理指定工作区
--all-workspaces 所有工作区
--cn 安装 lark-cli 时使用国内 npm 镜像(不修改全局 npm 配置)
--no-install-lark-cli 缺少 lark-cli 时不自动安装(默认会自动安装)
--force 技能文件夹已存在也覆盖
--skip-lark-check 不检查 Node / lark-cli / 登录,只部署技能
-y / --yes 少问确认,适合脚本
flowchart TD
    S(["lark-bridge setup"]) --> P["检查 Python 和 QwenPaw"]
    P -->|没装 QwenPaw| TIP1["提示:pip install qwenpaw"]
    P -->|已有| N["检查 Node.js / npm"]
    N -->|没装| TIP2["告诉你去哪下载 Node"]
    N -->|已有| L{"电脑上有 lark-cli 吗?"}
    L -->|没有| INST["npm 全局安装 @larksuite/cli"]
    INST --> L
    L -->|有了| C{"飞书应用配好了吗?"}
    C -->|没有| CONF["提示执行 lark-cli config init --new"]
    CONF --> C
    C -->|好了| A{"登录飞书了吗?"}
    A -->|没有| LOGIN["提示执行 lark-cli auth login"]
    LOGIN --> A
    A -->|好了| SK["把技能写入 QwenPaw 工作区"]
    SK --> DONE(["完成"])

status

打印当前环境、飞书配置、技能是否在位。

lark-bridge status
lark-bridge status --workspace 你的工作区
lark-bridge status --all-workspaces   # 列出所有工作区

update

用当前安装的 lark-agent-bridge 自带的最新技能模板覆盖工作区,保留 skill.json 里已有的 config。执行前会自动创建备份。

lark-bridge update
lark-bridge update --workspace 你的工作区
lark-bridge update --all-workspaces
lark-bridge update --backup-keep 20
lark-bridge rollback --workspace 你的工作区 --backup-id latest

upgrade

面向小白的一键升级入口:更新工作区技能模板,并给出下一步建议(例如继续 status 或补登录)。 执行前会自动创建备份,可用 rollback 恢复。

lark-bridge upgrade
lark-bridge upgrade --with-lark-cli      # 同时尝试升级全局 lark-cli
lark-bridge upgrade --backup-keep 20

resume

setup 因为配置/登录未完成而中断后,浏览器操作结束即可继续部署。

lark-bridge resume
lark-bridge resume --workspace 你的工作区

rollback

将技能目录与 skill.json 恢复到备份状态(默认最近一次)。

lark-bridge rollback --workspace 你的工作区
lark-bridge rollback --workspace 你的工作区 --backup-id latest
lark-bridge rollback --all-workspaces

backups list/cleanup

查看或清理工作区备份。cleanup 会删除旧备份,仅保留最近 N 份。

lark-bridge backups list --workspace 你的工作区
lark-bridge backups cleanup --workspace 你的工作区 --keep 10
lark-bridge backups cleanup --all-workspaces --keep 10

perms sync/show/check

权限前置检查命令组(建议在调飞书前先跑):

lark-bridge perms sync                     # 写入权限快照
lark-bridge perms show                     # 查看当前快照
lark-bridge perms check --scope "wiki:wiki:readonly"

fix

技能目录缺失则补全,否则合并 skill.json。登录异常时提示你执行 lark-cli auth login

lark-bridge fix
lark-bridge fix --workspace 你的工作区
lark-bridge fix -y

verify

依次跑 lark-cli --version--helpconfig showauth statusdoctor。还没配飞书时中间几步黄字失败属正常。

lark-bridge verify

doctor

比 status 更详细,适合发给别人帮你排查。

lark-bridge doctor
lark-bridge doctor > report.txt

uninstall

删掉 QwenPaw 里的 lark_cli_bridge 技能和 skill.json 条目;可选卸载全局 lark-cli。

lark-bridge uninstall --skill-only    # 只卸技能
lark-bridge uninstall --skill-only --purge-lark-cli-config   # 额外清理 ~/.lark-cli 配置与登录凭证
lark-bridge uninstall -y              # 连 lark-cli 一起卸
lark-bridge uninstall --backup-keep 20

默认不会删 ~/.lark-cli 配置文件夹;仅当显式传 --purge-lark-cli-config(或交互中选择清理)时才会删除。也不会卸 pip 里的 lark-agent-bridge(需自行 pip uninstall lark-agent-bridge)。 如需查看错误码说明,见 docs/error-codes.md


lark-cli auth 子命令(清除授权、重新登录在这里)

以下命令在装好 lark-cli 后使用,不是 lark-bridge 的子命令。完整列表以 lark-cli auth --help 为准。

命令 含义 典型场景
lark-cli auth login 浏览器完成设备流授权 第一次登录、过期重登、补权限
lark-cli auth logout 清除本机 token 换账号前
lark-cli auth status 看 token 是否有效 怀疑登录失效
lark-cli auth list 列出本机已登录用户 多用户时
lark-cli auth scopes 查应用已开通的用户权限 对照后台
lark-cli auth check 检查 token 是否含指定 scope 调 API 前确认(--scope 必填)

说明auth logout 只清本机凭证,不会在飞书侧撤销授权。若要在飞书账号侧撤销,需在飞书客户端 > 账号安全 > 授权管理中操作。


常见问题

Q: 运行 setup 提示「Node.js 未找到」

系统 安装方式
Windows winget install OpenJS.NodeJS.LTS 或去 nodejs.org
macOS brew install node 或去 nodejs.org
Linux sudo apt install nodejs npm

安装后重新打开终端再跑 lark-bridge setup

Q: npm install 报权限错误

不要用 sudo npm install -g。改用用户级安装:

npm config set prefix ~/.npm-global
export PATH=~/.npm-global/bin:$PATH   # 加到 ~/.bashrc 或 ~/.zshrc
lark-bridge setup

Windows 一般不会遇到此问题。

Q: 飞书登录过期了

lark-cli auth login --recommend

Q: 想清除授权或换账号

lark-cli auth logout                   # 清除本机登录
lark-cli auth login --recommend        # 重新登录

若你准备完整重装并希望清掉本机 lark-cli 配置文件,可在卸载时加:

lark-bridge uninstall --skill-only --purge-lark-cli-config

Q: 在 QwenPaw / Agent 里执行 auth login 看不到链接

lark-cli 默认把链接打在 stderr,部分环境只显示 stdout。对 auth login 追加 --json

lark-cli auth login --recommend --json

授权信息会在 stdout 以 JSON 输出。其它命令仍用 --format json,不要混用。

Q: QwenPaw 控制台里看不到飞书技能

  1. lark-bridge status 确认技能已启用
  2. 在 QwenPaw 控制台新开一个对话(不是旧的)
  3. 还没启用:lark-bridge fix
  4. 还不行:lark-bridge setup --force

Q: 网络慢 / npm 装不上

lark-bridge setup --cn

或手动设置后安装:

npm config set registry https://registry.npmmirror.com
lark-bridge setup

Q: pip install 装到了错误的 Python 版本(Windows 常见)

Windows 上可能有多个 Python。确认用的是 QwenPaw 对应的那个:

python --version          # 确认版本
python -m pip install lark-agent-bridge

python -m pip 而不是直接 pip,可以确保装到正确的 Python 环境。若需固定版本,可把 lark-agent-bridge 换成上一节「备选 A」里的 GitHub zip 地址。

Q: setup 报「工作区不存在」

QwenPaw 需要先初始化才会创建 ~/.qwenpaw/workspaces/default(兼容旧目录 ~/.copaw):

pip install qwenpaw
qwenpaw init

然后重新 lark-bridge setup

Q: 我有多个 QwenPaw Agent,想给某一个装

lark-bridge status --all-workspaces             # 查看所有工作区
lark-bridge setup --workspace my_agent_name     # 给指定工作区装
lark-bridge setup --all-workspaces              # 全部装

Q: 想彻底重来

lark-bridge uninstall        # 移除 QwenPaw 技能;可选卸全局 lark-cli
pip uninstall lark-agent-bridge
pip install lark-agent-bridge
lark-bridge setup

Q: fix 也修不好

lark-bridge doctor > report.txt

report.txt 发到 GitHub Issues


这是什么?

项目 说明
lark-agent-bridge Lark CLI 与 AI Agent 运行时的桥接工具
与上游关系 不修改 QwenPaw / lark-cli 的任何代码
当前支持 QwenPaw(兼容 CoPaw);OpenClaw 待上游稳定后适配
flowchart LR
    subgraph your["你的电脑"]
        CP["QwenPaw\nAI 助理"]
        B["lark-agent-bridge\n检查 + 安装 + 接线"]
        LC["lark-cli\n飞书官方命令行"]
    end

    B -->|部署技能| CP
    B -->|帮你装好| LC
    CP -.->|需要时调用| LC

许可证

MIT(见 LICENSE

开发者文档

贡献代码、了解架构细节请看 DEVELOPMENT.md

上游链接

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lark_agent_bridge-0.3.8.tar.gz (46.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lark_agent_bridge-0.3.8-py3-none-any.whl (42.3 kB view details)

Uploaded Python 3

File details

Details for the file lark_agent_bridge-0.3.8.tar.gz.

File metadata

  • Download URL: lark_agent_bridge-0.3.8.tar.gz
  • Upload date:
  • Size: 46.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for lark_agent_bridge-0.3.8.tar.gz
Algorithm Hash digest
SHA256 6e12e898b309fa43e5448cb7ecf877c7fc9157bf4de6be36f80d9b0a5947cf00
MD5 e231ae3eb98b7bd42fc760d172a70cf9
BLAKE2b-256 a0d9f88ba16b821cabbff888c85c1d674c51c6230b9d4d9250885ffe584c6b1f

See more details on using hashes here.

File details

Details for the file lark_agent_bridge-0.3.8-py3-none-any.whl.

File metadata

File hashes

Hashes for lark_agent_bridge-0.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 979ce555b591f17827acdda105f9f91973fe4d7d9b9f9ece727b507fe1e485c9
MD5 447e1d41a974b52f9513928ff7a3af4f
BLAKE2b-256 918b5804eb9d34b97be2fd4925f41584eb3240f887ec1622b0b9c7f7403f4ec8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page