chore: standalone repo bootstrap after split from inkreach-teable monorepo
- untrack dist/, add .gitignore, add pnpm-lock.yaml - inline tsconfig.base.json options (no monorepo extends) - install.sh: CLI now at repo root; install skill to ~/.zcode/skills (user scope) - fix stale paths in skill docs; 7 actions in help text; README
This commit is contained in:
@@ -0,0 +1,50 @@
|
||||
# inkreach-teable-cli
|
||||
|
||||
操作 [inkreach-teable](ssh://git@gitea.inkreach.cc:2222/inkreachhub/inkreach-teable.git)
|
||||
实例(Teable fork + 自建自动化引擎)的独立工具项目,包含两部分:
|
||||
|
||||
| 内容 | 位置 | 说明 |
|
||||
|---|---|---|
|
||||
| **CLI**(命令 `inkreach-teable`) | 仓库根(`src/`,包即仓库) | 表、字段、记录、视图、自动化(8 触发器 + 7 动作)、密钥、执行历史、插件、订阅等全部 REST API 封装 |
|
||||
| **Agent Skill** | `.agents/skills/inkreach-teable/` | ZCode/Claude 技能:模块地图、路由规则、API 参考、实例运维指南 |
|
||||
|
||||
设计文档见 [`docs/cli-skill-design.md`](docs/cli-skill-design.md)。
|
||||
|
||||
> ⚠️ 官方 `teable` CLI 与本实例的自动化契约不兼容(`conditions` 而非 `filter`、
|
||||
> `fieldIds` 而非 `watchFieldIds` 等),务必使用 `inkreach-teable`。
|
||||
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
git clone ssh://git@gitea.inkreach.cc:2222/inkreachhub/inkreach-teable-cli.git
|
||||
cd inkreach-teable-cli
|
||||
bash .agents/skills/inkreach-teable/scripts/install.sh
|
||||
```
|
||||
|
||||
安装脚本会:构建 CLI → 全局链接 `inkreach-teable` 命令 → 把 skill 安装到
|
||||
`~/.zcode/skills/inkreach-teable`(用户级,任意工作区可用)。更新后重跑一次即可。
|
||||
|
||||
## 配置
|
||||
|
||||
```bash
|
||||
inkreach-teable auth login --endpoint http://localhost:3003 --token <PAT> --base-id bseXXX
|
||||
inkreach-teable auth status
|
||||
```
|
||||
|
||||
PAT 从 Web UI(Settings → Personal Access Tokens)或 `auth token create` 获取。
|
||||
|
||||
## 开发
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
pnpm build # tsc → dist/
|
||||
pnpm test # vitest 单测(field-normalize / field-display / resources)
|
||||
pnpm typecheck
|
||||
```
|
||||
|
||||
## 来源
|
||||
|
||||
2026-09-23 从 inkreach-teable monorepo 拆分独立(原路径 `packages/inkreach-cli/` +
|
||||
`.agents/skills/inkreach-teable/`),git 历史完整保留。应用本体的开发/部署文档见
|
||||
skill 内 [development.md](.agents/skills/inkreach-teable/guides/development.md)(描述的是
|
||||
inkreach-teable 应用仓库,不是本仓库)。
|
||||
Reference in New Issue
Block a user