@rishiqing/cli 0.1.0

package/README.md

@@ -0,0 +1,164 @@
+# rishiqing-cli
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![npm version](https://img.shields.io/npm/v/@rishiqing/cli.svg)](https://www.npmjs.com/package/@rishiqing/cli)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D20-blue.svg)](https://nodejs.org/)
+
+面向 Agent 和开发者的日事清 CLI，由 `rishiqing.openapi.json` 驱动命令注册。它不是简单包一层 HTTP 请求，而是把“发现命令、理解参数、预览请求、执行调用”整理成一套稳定的终端接口，方便人和 AI Agent 直接操作日事清。
+
+[安装](#安装与快速开始) · [Agent 能力](#agent-能力) · [命令体系](#命令体系) · [进阶用法](#进阶用法) · [安全](#安全与约束) · [开发](#开发)
+
+## 功能
+
+当前共提供 **54** 个命令，覆盖 5 个业务域：
+
+| 类别 | 当前能力 |
+| --- | --- |
+| `workflow` | 流程应用、模板、步骤、表单、审核项、流程实例、运行中步骤流转 |
+| `project` | 项目、模块、卡片、项目成员 |
+| `task` | 创建、查询、更新、完成、删除任务，评论，执行人/负责人/参与人维护 |
+| `datasheet` | 数据表列表、字段、记录的查询/新增/更新/删除 |
+| `contacts` | 全员列表、按姓名解析 `userId` |
+
+## 安装与快速开始
+
+### 环境要求
+
+开始之前，请确保具备以下条件：
+
+- Node.js `>= 20`
+- 一个可用的 `X-Rsq-Api-key`（日事清->设置->开发者配置）
+
+### 快速开始
+
+#### 安装
+
+推荐直接从 npm 安装：
+
+```bash
+npm install -g @rishiqing/cli
+```
+
+# 安装 CLI SKILL（必需）
+```bash
+npx skills add rishiqing/cli -y -g
+```
+
+安装完成后确认命令可用：
+
+```bash
+rsq-cli --help
+```
+
+#### 配置
+
+先初始化用户级 API Key 配置：
+
+```bash
+rsq-cli config init
+```
+
+查看当前配置文件位置：
+
+```bash
+rsq-cli config path
+```
+
+## Agent 能力
+
+`rsq-cli` 既提供内建的 agent contract，也保留了仓库内可复用的 skill。
+
+| 能力 | 说明 |
+| --- | --- |
+| `describe` | 结构化输出全部命令、参数、请求体 schema、示例 |
+| `search` | 按自然语言意图检索命令 |
+| `describe-agent-contract` | 输出面向 Agent 的路由规则、领域关键词和全局约束 |
+| `skills/rishiqing` | 识别“日事清”领域请求并路由到对应模块 |
+| `skills/rsq-workflow-createFlowApplication` | 根据流程场景自动创建流程应用，优先匹配模板，匹配不到回退到标准模式 |
+
+## 命令体系
+
+CLI 当前按三层能力组织：
+
+### 1. 模块命令
+
+这是最直接的 API 调用层，按业务域分组：
+
+```bash
+rsq-cli datasheet --help
+rsq-cli workflow --help
+rsq-cli contacts --help
+rsq-cli project --help
+rsq-cli task --help
+```
+
+例如：
+
+```bash
+rsq-cli project create --body '{"name":"新项目"}' --json
+rsq-cli task get --task-id task_xxx --json
+rsq-cli workflow list-templates --json
+```
+
+### 2. 组合命令
+
+这类命令会在内部串联多个步骤，适合 Agent 直接调用：
+
+```bash
+rsq-cli contacts resolve-user --user-name 张三 --json
+rsq-cli task set-executor-by-name --task-id task_xxx --user-name 张三 --json
+rsq-cli project set-member-by-name --project-id proj_xxx --user-name 李四 --json
+rsq-cli workflow create-audit-by-names \
+  --flow-application-id flow_xxx \
+  --step-info-id step_xxx \
+  --audit-info-name 部门审批 \
+  --user-names 张三,李四 \
+  --json
+```
+
+### 3. 自省命令
+
+这是 Agent 场景最关键的一层：
+
+```bash
+rsq-cli describe --json
+rsq-cli describe workflow --json
+rsq-cli describe workflow createFlowApplication --json
+rsq-cli search "list workflow applications" --json
+rsq-cli describe-agent-contract
+```
+
+## 安全与约束
+
+本工具可被 AI Agent 调用执行真实的日事清写操作，因此请务必注意：
+
+- `X-Rsq-Api-key` 具备真实权限，不应出现在日志、截图或共享终端中
+- 生产环境与测试环境的 `baseUrl` 应严格区分
+
+## 开发
+
+### 安装依赖
+
+```bash
+npm install
+```
+
+### 类型检查
+
+```bash
+npm run check
+```
+
+### 构建
+
+```bash
+npm run build
+```
+
+### 本地调试
+
+```bash
+node dist/cli.js --help
+node dist/cli.js search "create task" --json
+node dist/cli.js describe --json
+```

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+
+export {  }