0.1.0 • Published 11h agoCLI

redsea-cli

Licence

UNLICENSED

Version

0.1.0

Deps

Size

35 kB

Vulns

Weekly

Summary Dependency Versions

redsea-cli

红海云企业数据与接口统一 CLI:安装在 Claude Code、Codex、OpenClaw 等 AI 编程工具中,统一查询企业内部数据(日报/周报/考勤/人员/工单/流程),并作为接口知识库帮助 AI 了解和对接公司接口。

使用者三步上手

# 1. 安装(公司 npm 私服)
npm install -g redsea-cli

# 2. 登录(浏览器完成 SSO,凭证存入系统钥匙串)
redsea auth login

# 3. 给 AI 工具安装 redsea 技能(全局一次,所有项目可用)
#    写入 ~/.agents/skills、~/.claude/skills、~/.codex/skills 三处
redsea skill install

升级 CLI 后重新执行 redsea skill install 即可更新技能说明;只想装到当前项目时用 --target claude --project 或 --target codex --project。

常用命令:

redsea report daily --json           # 查询日报
redsea api search "查询员工考勤"       # 搜索公司接口
redsea api show hr.staff.search      # 查看接口详细说明
redsea --help                        # 全部命令

文档

docs/00-总体方案.md — 产品定位、架构、功能规划、落地步骤
docs/01-统一鉴权规范.md — JWT 格式、认证中心端点、业务系统验签要求(各业务系统接入必读)
docs/02-业务系统接入规范.md — 数据契约、接入 checklist、接口目录元数据模板

开发

npm install
npm run build        # 编译到 dist/
node dist/index.js --help

# 本地全局联调
npm link             # 之后可直接使用 redsea 命令

本地端到端体验(无需真实服务端)

demo/auth-server.mjs 在本机模拟了认证中心 + 日报系统 + 接口目录,可完整走一遍扫码授权登录 → 数据查询 → 接口目录的流程,见 demo/README.md。

本地调试可用 REDSEA_CONFIG 指向测试配置文件覆盖默认服务地址:

REDSEA_CONFIG=./config.local.json node dist/index.js report daily

配置文件格式(默认读取 ~/.config/redsea/config.json):

{
  "auth": { "issuer": "https://sso.redsea.internal", "clientId": "redsea-cli" },
  "services": { "report": "https://report.redsea.internal" }
}

目录结构

src/
  index.ts            # 入口与命令注册
  config.ts           # 认证中心与业务系统路由表
  credentials.ts      # 凭证存取(macOS 钥匙串 / 0600 文件)
  http.ts             # 统一 HTTP 客户端(Bearer token、错误处理)
  output.ts           # 表格 / JSON 输出、退出码约定
  skill-template.ts   # 安装给 AI 工具的使用说明模板
  commands/           # 各业务域命令(auth / report / api / skill)
docs/                 # 方案与接入规范

新增业务域的方式:在 src/commands/ 下新建模块(参照 report.ts),在 config.ts 的路由表登记服务地址,在 index.ts 注册,并同步更新 skill-template.ts。