wf-cli
公司工作流 CLI 工具 —— 提升日常工作效率的命令行助手。
功能
| 命令 | 说明 |
|---|---|
wf-cli workspace |
管理工作空间(创建/下载/新增文档类型/更新模板) |
wf-cli doc |
基于模板交互式生成文档 |
wf-cli sync |
与飞书云盘双向同步文件 |
wf-cli config |
查看和修改 CLI 配置 |
wf-cli info |
显示版本和当前工作环境状态 |
环境要求
- Python >= 3.10(未安装请参考下方指引)
- Node.js(lark-cli 依赖 npm 安装)
Python 安装指引
检查是否已安装:
python3 --version
# 或 Windows 上:
python --version
如果未安装或版本低于 3.10:
| 平台 | 安装方式 |
|---|---|
| macOS | brew install python@3.13(推荐)或从 python.org 下载安装包 |
| Windows | 从 python.org 下载安装包,安装时勾选「Add Python to PATH」 |
| Linux | sudo apt install python3.13(Ubuntu/Debian)或 sudo dnf install python3.13(Fedora) |
💡 推荐安装 Python 3.11+,可直接使用内置的
tomllib,无需额外依赖。
第一步:安装 workflow-cli
macOS(推荐 pipx)
# 安装 pipx(如果没有)
brew install pipx
pipx ensurepath
# 安装或升级 workflow-cli(已安装则升级到最新版)
pipx install workflow-cli || pipx upgrade workflow-cli
Windows
# 方式一:安装或升级(已安装则升级到最新版)
pip install --upgrade workflow-cli
# 如果提示 wf-cli 命令找不到,将以下路径加入系统 PATH:
# C:\Users\用户名\AppData\Roaming\Python\Python3xx\Scripts
Linux(推荐 pipx)
# 安装 pipx(如果没有)
sudo apt install pipx
pipx ensurepath
# 安装或升级 workflow-cli(已安装则升级到最新版)
pipx install workflow-cli || pipx upgrade workflow-cli
通用方式(虚拟环境)
pip install workflow-cli
其他常用命令
| 操作 | pipx | pip |
|---|---|---|
| 安装 | pipx install workflow-cli |
pip install workflow-cli |
| 升级 | pipx upgrade workflow-cli |
pip install --upgrade workflow-cli |
| 卸载 | pipx uninstall workflow-cli |
pip uninstall workflow-cli |
| 查看信息 | pipx list |
pip show workflow-cli |
💡 MCP 依赖现已默认包含,
pip install workflow-cli即可,无需额外[mcp]。安装后会自动生成~/.wfcli/config.toml。
⚠️ 第二步:安装并配置飞书 CLI
workflow-cli 的飞书云盘功能依赖 lark-cli,没有它 workspace/sync 等命令无法使用。
2.1 安装 lark-cli
npm install -g lark-cli
详细安装指南:https://open.feishu.cn/document/no_class/mcp-archive/feishu-cli-installation-guide.md
2.2 配置并授权(只需一次)
先运行
wf-cli config show确认~/.wfcli/config.toml已生成。
Step 1 — 初始化 lark-cli(创建飞书应用):
lark-cli config init --new
该命令会输出一个验证 URL,复制在浏览器中打开完成飞书登录,配置自动完成。
Step 2 — 授权云盘权限:
lark-cli auth login --domain drive
浏览器中确认云盘权限即可。需要的权限范围见 ~/.wfcli/config.toml 的 [feishu.scopes] 段。
2.3 验证
lark-cli auth status
lark-cli auth scopes
第三步:同步云盘工作空间到本地
lark-cli 授权成功后,将飞书云盘上的工作空间下载到本地:
wf-cli workspace pull
💡 下载完成后就可以开始写文档了:
wf-cli doc generate
AI 应用 MCP 集成
安装后,wf-cli 可以作为一个 MCP Server 被 AI 应用(Claude Desktop、WorkBuddy 等)调用,让 AI 直接操作飞书工作空间和文档。
安装
| 平台 | 命令 |
|---|---|
| macOS (pipx) | pipx install workflow-cli |
| Windows (pip) | pip install workflow-cli |
获取 wf-cli-mcp 路径
AI 应用配置需要知道 wf-cli-mcp 命令的完整路径。
macOS (pipx):
# 查找路径
which wf-cli-mcp
# 通常是: /Users/<用户名>/.local/bin/wf-cli-mcp
macOS (pip/venv):
# 在虚拟环境中
which wf-cli-mcp
# 通常在: <venv目录>/bin/wf-cli-mcp
Windows (pip):
where wf-cli-mcp
# 通常是: C:\Users\<用户名>\AppData\Roaming\Python\Python3xx\Scripts\wf-cli-mcp.exe
配置 AI 应用
将以下 JSON 添加到对应应用的 MCP 配置中(注意替换路径):
Claude Desktop
打开 Claude Desktop → Settings → Developer → Edit Config,添加:
{
"mcpServers": {
"workflow-cli": {
"command": "/Users/<用户名>/.local/bin/wf-cli-mcp",
"args": []
}
}
}
Windows 用户注意:路径用 \\ 或单个 /:
{
"mcpServers": {
"workflow-cli": {
"command": "C:/Users/<用户名>/AppData/Roaming/Python/Python314/Scripts/wf-cli-mcp.exe",
"args": []
}
}
}
WorkBuddy
与 Claude Desktop 格式相同,填入 WorkBuddy 的 MCP 配置面板。
Cursor / VS Code
在项目根目录创建 .cursor/mcp.json 或 .vscode/mcp.json:
{
"mcpServers": {
"workflow-cli": {
"command": "/Users/<用户名>/.local/bin/wf-cli-mcp",
"args": []
}
}
}
可用 MCP Tools
配置成功后,AI 应用可以使用以下工具:
| Tool | 功能 |
|---|---|
workspace_list |
列出云盘所有工作空间 |
workspace_create |
创建新工作空间(含目录和模板) |
workspace_pull |
下载工作空间到本地 |
doc_list_types |
列出工作空间可用的文档类型 |
doc_get_template |
获取模板结构、AI 执行指令和自检清单 |
doc_generate |
将 AI 生成的文档保存到工作空间 |
sync_push |
提交本地文件到云盘 |
sync_pull |
从云盘同步更新到本地 |
sync_status |
查看本地与云盘的同步差异 |
config_show |
查看当前配置 |
get_info |
显示版本、Python 环境和 lark-cli 状态 |
验证 MCP 是否正常
# 查看版本
wf-cli-mcp --version
# 用 MCP Inspector 测试(需要 Node.js)
npx @modelcontextprotocol/inspector wf-cli-mcp
快速开始
基础命令
| 操作 | macOS/Linux | Windows |
|---|---|---|
| 查看帮助 | wf-cli --help |
wf-cli --help |
| 查看版本 | wf-cli --version |
wf-cli --version |
| 查看状态 | wf-cli info |
wf-cli info |
配置
| 操作 | macOS/Linux | Windows |
|---|---|---|
| 查看配置 | wf-cli config show |
wf-cli config show |
| 修改飞书 token | wf-cli config set feishu.root_folder_token <token> |
wf-cli config set feishu.root_folder_token <token> |
工作空间
| 操作 | macOS/Linux | Windows |
|---|---|---|
| 列出云盘工作空间 | wf-cli workspace list |
wf-cli workspace list |
| 下载到本地 | wf-cli workspace pull |
wf-cli workspace pull |
| 创建工作空间 | wf-cli workspace create <名称> |
wf-cli workspace create <名称> |
文档
| 操作 | macOS/Linux | Windows |
|---|---|---|
| 生成文档 | wf-cli doc generate |
wf-cli doc generate |
| 查看可用类型 | wf-cli doc list |
wf-cli doc list |
同步
| 操作 | macOS/Linux | Windows |
|---|---|---|
| 提交到云盘 | wf-cli sync push <文件> |
wf-cli sync push <文件> |
| 从云盘更新 | wf-cli sync pull |
wf-cli sync pull |
| 查看同步状态 | wf-cli sync status |
wf-cli sync status |
配置
配置文件位于 ~/.wfcli/config.toml(TOML 格式),首次运行时自动生成默认配置。
可配置项:
| 配置项 | 说明 | 默认值 |
|---|---|---|
feishu.root_folder_token |
飞书云盘工作空间根目录 token | 已预设 |
workspace.default_local_dir |
默认本地下载路径 | ~/workspaces |
update.check_interval_hours |
更新检查间隔(小时) | 1 |
自定义云盘根目录
如果你有多个飞书云盘空间,可以通过修改 root_folder_token 切换:
方式一:命令行
# 从飞书云盘 URL 中提取 token,例如:
# https://xxx.feishu.cn/drive/folder/LqpXf26yzlWGlVda3MmcnnqDnDg
# ↑ 这段就是 token
wf-cli config set feishu.root_folder_token <你的token>
方式二:直接编辑配置文件
# 编辑 ~/.wfcli/config.toml
[feishu]
root_folder_token = "LqpXf26yzlWGlVda3MmcnnqDnDg"
Python 3.10 用户注意
Python 3.10 不内置 tomllib,请安装时带上 toml 额外依赖:
pip install workflow-cli[toml]
Python 3.11+ 用户无需额外操作。
许可证
MIT
Metadata
Release files for workflow-cli 0.6.41
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| workflow_cli-0.6.41.tar.gz | 42.4 kB | Without provenance | Details for workflow_cli-0.6.41.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| workflow_cli-0.6.41-py3-none-any.whl | Python 3 | none | any | Details for workflow_cli-0.6.41-py3-none-any.whl |
Total release size: 93.8 kB
Release files / workflow_cli-0.6.41.tar.gz
| Download URL | workflow_cli-0.6.41.tar.gz |
|---|---|
| Size | 42.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
74cab57c7d868d34eb5636b752e2301d6c3d436a057b8c922b5e1c4aa94d25f4
|
|
BLAKE2b-256 checksum How to use checksums |
9947b748fea075f00a3f89cb3ef25f8f31e1d049f5a3136f191f884c5d0d3a5e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.3
|
Release files / workflow_cli-0.6.41-py3-none-any.whl
| Download URL | workflow_cli-0.6.41-py3-none-any.whl |
|---|---|
| Size | 51.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a5a2fad38083dc742698908299029d858c5d6e1e8e1988928b69e95994f765d7
|
|
BLAKE2b-256 checksum How to use checksums |
a3371a74a4482cd007b3178669be44c07c56ca9f2f01512e13e10195186257be
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.3
|
Security for workflow-cli 0.6.41
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.