Metadata-Version: 2.4
Name: workflow-cli
Version: 0.1.0
Summary: 公司工作流 CLI 工具 —— 提升日常工作效率
Author-email: TODO <TODO@example.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/TODO/workflow-cli
Project-URL: Repository, https://github.com/TODO/workflow-cli
Project-URL: Issues, https://github.com/TODO/workflow-cli/issues
Keywords: cli,workflow,feishu,lark
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.0
Requires-Dist: rich>=13.0
Provides-Extra: toml
Requires-Dist: tomli>=2.0; extra == "toml"
Requires-Dist: tomli-w>=1.0; extra == "toml"
Dynamic: license-file

# wf-cli

公司工作流 CLI 工具 —— 提升日常工作效率的命令行助手。

## 功能

| 命令 | 说明 |
|------|------|
| `wf-cli workspace` | 管理工作空间（创建/下载/新增文档类型/更新模板） |
| `wf-cli doc` | 基于模板交互式生成文档 |
| `wf-cli sync` | 与飞书云盘双向同步文件 |
| `wf-cli config` | 查看和修改 CLI 配置 |
| `wf-cli info` | 显示版本和当前工作环境状态 |

## 安装

```bash
pip install workflow-cli
```

## 前置依赖

- **Python >= 3.10**
- **[lark-cli](https://www.npmjs.com/package/lark-cli)**（可选，飞书云盘集成需要）：`npm install -g lark-cli`

> 💡 即使没有安装 lark-cli，`wf-cli info` 等命令仍可正常运行，仅飞书相关操作会友好提示。

## 快速开始

```bash
# 查看帮助
wf-cli --help

# 查看当前状态
wf-cli info

# 查看默认配置
wf-cli config show

# 修改飞书根目录 token
wf-cli config set feishu.root_folder_token <your-token>

# 列出云盘上的工作空间
wf-cli workspace list

# 下载工作空间到本地
wf-cli workspace pull

# 生成文档
wf-cli doc generate
```

## 配置

配置文件位于 `~/.wfcli/config.toml`（TOML 格式），首次运行时自动生成默认配置。

可配置项：

| 配置项 | 说明 | 默认值 |
|--------|------|--------|
| `feishu.root_folder_token` | 飞书云盘工作空间根目录 token | 已预设 |
| `workspace.default_local_dir` | 默认本地下载路径 | `~/workspaces` |
| `update.enabled` | 是否启用自动更新 | `true` |
| `update.check_interval_days` | 更新检查间隔（天） | `1` |

## Python 3.10 用户注意

Python 3.10 不内置 `tomllib`，请安装时带上 `toml` 额外依赖：

```bash
pip install workflow-cli[toml]
```

Python 3.11+ 用户无需额外操作。

## 许可证

MIT
