@rishiqing/cli
v0.1.7
Published
Agent-oriented CLI for Rishiqing APIs
Downloads
54
Readme
rishiqing-cli
面向 Agent 和开发者的日事清 CLI,由 rishiqing.openapi.json 驱动命令注册。它不是简单包一层 HTTP 请求,而是把“发现命令、理解参数、预览请求、执行调用”整理成一套稳定的终端接口,方便人和 AI Agent 直接操作日事清。
安装 · Agent 能力 · 命令体系 · 进阶用法 · 安全
安装与快速开始
环境要求
开始之前,请确保具备以下条件:
- Node.js
>= 20 - 一个可用的
X-Rsq-Api-key(日事清->设置->开发者配置)
极速开始
npm install -g @rishiqing/cli
rsq-cli install
rsq-cli config init快速开始
安装
推荐直接从 npm 安装:
npm install -g @rishiqing/cli安装 CLI Skill
rsq-cli installrsq-cli install 会将项目内置的 skill 安装到已知智能体目录,目前默认包含:
Codex:~/.agents/skillsClaude Code:~/.claude/skillsOpenClaw:~/.openclaw/skills
也可以只安装到指定目标,或者追加自定义目录:
rsq-cli install --target codex
rsq-cli install --target codex,claude-code
rsq-cli install --dir ~/.my-agent/skills
rsq-cli install --dry-run --json配置
先初始化用户级 API Key 配置:
rsq-cli config init查看当前配置文件位置:
rsq-cli config path查看常用命令:
rsq-cli --helpAgent 能力
rsq-cli 既提供内建的 agent contract,也保留了仓库内可复用的 skill。
| 能力 | 说明 |
| --- | --- |
| describe | 结构化输出全部命令、参数、请求体 schema、示例 |
| search | 按自然语言意图检索命令 |
| describe-agent-contract | 输出面向 Agent 的路由规则、领域关键词和全局约束 |
| agent | 面向 Agent 的包装命令;收到内联 --body 时会自动落盘并转成 --body-file 执行 |
| skills/rishiqing | 识别“日事清”领域请求并路由到对应模块 |
| skills/rsq-workflow-createFlowApplication | 根据流程场景自动创建流程应用,优先匹配模板,匹配不到回退到标准模式 |
命令体系
CLI 当前按三层能力组织:
1. 模块命令
这是最直接的 API 调用层,按业务域分组:
rsq-cli datasheet --help
rsq-cli workflow --help
rsq-cli contacts --help
rsq-cli project --help
rsq-cli task --help例如:
echo '{"name":"新项目"}' > request.json
rsq-cli project create --body-file request.json --json
rsq-cli task get --task-id task_xxx --json
rsq-cli workflow list-templates --json2. 组合命令
这类命令会在内部串联多个步骤,适合 Agent 直接调用:
rsq-cli agent contacts resolve-user --user-name 张三 --json
rsq-cli agent task set-executor-by-name --task-id task_xxx --user-name 张三 --json
rsq-cli agent project set-member-by-name --project-id proj_xxx --user-name 李四 --json
rsq-cli agent workflow create-audit-by-names \
--flow-application-id flow_xxx \
--step-info-id step_xxx \
--audit-info-name 部门审批 \
--user-names 张三,李四 \
--json3. 自省命令
这是 Agent 场景最关键的一层:
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具备真实权限,不应出现在日志、截图或共享终端中
