Metadata-Version: 2.4
Name: workflow-cli
Version: 0.1.1
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` | 显示版本和当前工作环境状态 |

## 环境要求

- **Python >= 3.10**（未安装请参考下方指引）
- **[lark-cli](https://www.npmjs.com/package/lark-cli)**（可选，飞书云盘集成需要）

### Python 安装指引

**检查是否已安装：**

```bash
python3 --version
# 或 Windows 上：
python --version
```

**如果未安装或版本低于 3.10：**

| 平台 | 安装方式 |
|------|---------|
| **macOS** | `brew install python@3.13`（推荐）或从 [python.org](https://www.python.org/downloads/) 下载安装包 |
| **Windows** | 从 [python.org](https://www.python.org/downloads/) 下载安装包，**安装时勾选「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）

```bash
# 安装 pipx（如果没有）
brew install pipx
pipx ensurepath

# 安装 workflow-cli
pipx install workflow-cli
```

### Windows

```bash
# 方式一：直接 pip 安装
pip install workflow-cli

# 如果提示 wf-cli 命令找不到，将以下路径加入系统 PATH：
# C:\Users\<用户名>\AppData\Roaming\Python\Python3xx\Scripts
```

### Linux（推荐 pipx）

```bash
# 安装 pipx（如果没有）
sudo apt install pipx
pipx ensurepath

# 安装 workflow-cli
pipx install workflow-cli
```

### 通用方式（虚拟环境）

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

## 快速开始

### 基础命令

| 操作 | 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.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
