# oa-cli

**Repository Path**: sd-sci/oa-cli

## Basic Information

- **Project Name**: oa-cli
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-14
- **Last Updated**: 2026-06-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# oa-cli

> 让 AI Agent 用自然语言操作 OA 系统——工作 / 项目 / 过程节点 / 任务 / 流程图画布。
> 跨 30+ agent 通用（Claude Code · Codex · Cursor · Gemini CLI · Cline · Continue · Aider · …）。

---

## 装一下

一条命令：装好 `oa` CLI，并把 skill 自动注册到本机**所有已安装的 AI agent**
（Claude Code / WorkBuddy / CodeBuddy / Cursor / Trae / Hermes / Codex / Qoder / opencode / Kimi / OpenClaw …，检测到哪个装哪个）。

**macOS / Linux**：
```bash
curl -sSL https://gitee.com/sd-sci/oa-cli/raw/master/install.sh | bash
```

**Windows**（用 PowerShell，不要用 CMD；需先装 Python 3 + git）：
```powershell
irm https://gitee.com/sd-sci/oa-cli/raw/master/install.ps1 | iex
```

> 也可以用统一的 skills 工具（跨平台，但目前**不覆盖 WorkBuddy / Hermes**）：
> `npx skills add https://gitee.com/sd-sci/oa-cli.git -g`

装完直接跟 agent 说话即可，它会自动检查 `oa` 命令并引导你登录。

---

## 用一下

装完直接跟 agent 说人话。它会自己判断该不该问你登录、该调什么命令、该怎么把结果讲给你听。

**初次使用**（agent 会主动引导登录）：

```
你：列出我负责的 OA 项目
agent：你还没登录 OA，方便告诉我你的手机号吗？
你：138xxxxxxxx
agent：（已发送验证码）收到的 6 位数字告诉我。
你：123456
agent：（登录成功）你负责的项目有：「张三的研究」「示例项目甲」……
```

**试试这些**：

- "我负责哪些 OA 项目？"
- "看一下「示例项目甲」这个工作的全景"
- "帮我把「示例项目甲」的拓扑图画给我看"
- "在「示例项目丙」下加一个过程节点叫『地震数据接入』"
- "把『需求分析』和『方案设计』两个节点连起来"
- "把『接口联调』这个任务的状态改成已验收"
- "把我这周（或这个月）的工作整理成一份 HTML 汇报页面"

最后一条会按当前登录用户，汇总「我负责 + 我参与」的项目与任务进度，生成一个自包含的 HTML 工作汇报（概览 / 各项目进度条 / 任务清单 / 逾期风险）并自动打开。

完整测试用例（L0–L8 分级，由简到难）见 [docs/test-prompts.md](docs/test-prompts.md)。

---

## 想直接敲 CLI / 写脚本

也行，全部命令 JSON 输出：

```bash
oa work list
oa project mine
oa work overview <work-id>
oa canvas diagram <work-id>
# ...
```

完整命令参考见 [skills/oa/SKILL.md](skills/oa/SKILL.md)；后端接口契约见 [docs/oa-cli-backend-api.md](docs/oa-cli-backend-api.md)。

---

## 其它

- **测试**：`pip install -e ".[dev]" && pytest`（mock 后端，无网络，18 用例）
- **单文件二进制**（沙箱零依赖）：`bash build-binary.sh` → `dist/bin/oa`
- **环境变量**：`OA_API_BASE` / `USER_API_BASE` / `OA_WEB_BASE` 整体覆盖
- **部门汇报（按所/按人）**：需要 `~/.oa_cli/dept_map.json`（真实姓名+OA用户ID，**不入公开仓库**）。内网安装时自动从 `OA_DEPT_MAP_URL`（默认内网地址）拉取；格式见 [dept_map.example.json](dept_map.example.json)。路径用 `OA_DEPT_MAP` 覆盖。**个人汇报（`--me`）不需要 map。**