yeuimu
5fa843df05
A self-built CLI and companion agent skill for operating a deployed
inkreach-teable instance — configuring tables, fields, records, views, and
the project's OWN automation engine.
Why not the official 'teable' CLI:
inkreach-teable's automation is self-built with a different contract:
- conditions (not filter), fieldIds (not watchFieldIds)
- recordCondition (not recordMatchesConditions)
- webhook route /api/webhook/{baseId}/{wfId} (not the /base//workflow/ form)
- scheduledTime backend honors only timing.type + timing.interval
The official CLI targets the upstream contract and 404s/misconfigures here.
Table/field/record/view APIs ARE upstream-compatible, but automation is not.
inkreach CLI (packages/inkreach-cli/):
- Node.js + commander, zero extra runtime deps
- Uses node:http (NOT fetch — Node 24 fetch drops Authorization header)
- Commands: auth (login/status/token), base/table/field/record/view,
workflow (list/get/create/update/delete/activate/deactivate/test),
trigger set (8 types, builds correct config keys), action add/update/delete
(6 types), secret, runs (list/get/rerun), fire (button-click/webhook), sql
- --json mode for agent parsing; GET->modify->PUT whole-graph for node edits
- Verified end-to-end: create workflow -> set webhook trigger -> add script
action -> activate -> fire webhook -> runs list (succeeded)
inkreach-teable-ops skill (.agents/skills/inkreach-teable-ops/):
- SKILL.md entry: module map, routing rules, 11 key constraints (the real
contract keys), execution rules, error recovery
- guides/: cli-reference, automation-guide, tables-fields, instance-access,
development (build/restart, known gotchas)
- api-reference/: trigger-types (8 triggers, exact config), action-types
(6 actions, sandbox globals), field-types (21 types incl. Button)
- metadata.json + install.sh
73 lines
2.5 KiB
JavaScript
73 lines
2.5 KiB
JavaScript
"use strict";
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
exports.requireBaseId = exports.run = exports.makeCtx = void 0;
|
|
const config_1 = require("./config");
|
|
const client_1 = require("./client");
|
|
const request_1 = require("./request");
|
|
/**
|
|
* Build a Ctx. `command` is the subcommand being executed (so .opts() returns
|
|
* its local options); `program` is the top-level program (for global options).
|
|
*/
|
|
function makeCtx(program, command) {
|
|
const g = program.opts();
|
|
const cfg = (0, config_1.resolveConfig)({
|
|
endpoint: g.endpoint,
|
|
token: g.token,
|
|
baseId: g.baseId,
|
|
});
|
|
return {
|
|
client: new client_1.Client(cfg),
|
|
json: !!g.json,
|
|
baseId: cfg.baseId,
|
|
command,
|
|
program,
|
|
};
|
|
}
|
|
exports.makeCtx = makeCtx;
|
|
/**
|
|
* Wrap an async command action with normalized error handling.
|
|
*
|
|
* The wrapped fn receives (ctx, positionalArgs[], options). commander passes
|
|
* positional args before the trailing Command; we detect the trailing Command
|
|
* and forward everything else as positional, plus parsed options.
|
|
*/
|
|
function run(fn) {
|
|
return async function (...cmdArgs) {
|
|
// commander convention: last arg is the Command instance (the subcommand).
|
|
const command = cmdArgs[cmdArgs.length - 1];
|
|
const program = command?.parent ? findRoot(command) : command;
|
|
const positional = cmdArgs.slice(0, -1);
|
|
const options = (command?.opts() || {});
|
|
const ctx = makeCtx(program, command);
|
|
try {
|
|
await fn(ctx, positional, options);
|
|
}
|
|
catch (err) {
|
|
const { status, code, message } = (0, request_1.describeError)(err);
|
|
if (ctx.json) {
|
|
process.stdout.write(JSON.stringify({ error: { status, code, message } }) + '\n');
|
|
}
|
|
else {
|
|
process.stderr.write(`✗ ${code}${status ? ` (${status})` : ''}: ${message}\n`);
|
|
}
|
|
process.exitCode = 1;
|
|
}
|
|
};
|
|
}
|
|
exports.run = run;
|
|
function findRoot(cmd) {
|
|
let c = cmd;
|
|
while (c.parent)
|
|
c = c.parent;
|
|
return c;
|
|
}
|
|
/** Require a baseId: from flag, else ctx default, else throw with guidance. */
|
|
function requireBaseId(ctx, flagVal) {
|
|
const baseId = flagVal || ctx.baseId;
|
|
if (!baseId) {
|
|
throw new client_1.ApiError(0, 'MISSING_BASE_ID', 'No base id. Pass --base-id <id>, set a default with `inkreach auth login --base-id <id>`, or export INKREACH_BASE_ID.');
|
|
}
|
|
return baseId;
|
|
}
|
|
exports.requireBaseId = requireBaseId;
|