@zhoujinandrew/te-cli 1.0.0

package/README.md

@@ -0,0 +1,109 @@
+# te-cli
+
+CLI tool for ThinkingEngine (TE) analytics platform. Designed for both AI Agent and human use.
+
+## Installation
+
+```bash
+npm install -g @zhoujinandrew/te-cli
+```
+
+To update to the latest version:
+
+```bash
+npm update -g @zhoujinandrew/te-cli
+```
+
+## Quick Start
+
+```bash
+# First run — interactive host setup + auto-login
+te-cli config
+```
+
+The `config` command opens an interactive terminal UI:
+- First run: prompts you to add a TE host URL and label, then auto-authenticates
+- Subsequent runs: shows all configured hosts, lets you switch, edit, delete, or add new ones
+
+```
+TE Host Manager  (↑↓ select · Enter switch · e edit label · d delete · a add · q quit)
+
+❯ ● Production  https://ta.thinkingdata.cn  ✓
+  ○ Staging     https://ta-staging.example.com:8080  ✗
+  + Add new host...
+```
+
+After selecting a host, te-cli automatically checks if the token is valid. If not, it triggers `auth login` for you.
+
+## Usage
+
+```bash
+# List events
+te-cli meta +list-events --project-id 1
+
+# Execute SQL
+te-cli analysis +query-sql --project-id 1 --sql "SELECT * FROM ta.v_event_1 LIMIT 10"
+
+# Table output
+te-cli meta +list-events -p 1 --format table
+
+# Raw API call
+te-cli api GET /v1/ta/event/catalog/listEvent --params '{"projectId": 1}'
+```
+
+## Authentication
+
+Authentication is handled per-host. Each TE host URL maintains its own token.
+
+```bash
+# Auto-login for active host (macOS, extracts token from Chrome)
+te-cli auth login
+
+# Manually set token
+te-cli auth set-token <your-token>
+
+# Check status
+te-cli auth status
+
+# Logout
+te-cli auth logout
+```
+
+## Commands
+
+### Domains
+
+| Domain | Commands | Description |
+|--------|----------|-------------|
+| `meta` | 7 | Event catalog, properties, entities, metrics, tables |
+| `analysis` | 10 | Reports, dashboards, SQL queries, report data |
+| `audience` | 6 | Tags, clusters, audience events/properties |
+| `operation` | 11 | Tasks, flows, channels, space navigation |
+
+### Global Options
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `--host <url>` | Override active TE host URL | from config |
+| `--format <json\|table>` | Output format | json |
+| `--jq <expr>` | Filter expression | - |
+| `--dry-run` | Preview request | false |
+| `--yes` | Skip confirmation | false |
+
+## Development
+
+```bash
+git clone https://github.com/zjandrew/te-cli.git
+cd te-cli
+npm install
+npx tsx src/index.ts --help
+```
+
+## Skills
+
+AI Agent skill documentation is in the `skills/` directory:
+- `te-shared` — Authentication, configuration, global options
+- `te-meta` — Metadata queries
+- `te-analysis` — Analysis and reporting
+- `te-audience` — Audience management
+- `te-operation` — Operations management

package/bin/te-cli.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../dist/index.js';

package/dist/analysis-SFPXKD3E.js

@@ -0,0 +1,218 @@
+// src/commands/analysis/list-reports.ts
+var listReports = {
+  service: "analysis",
+  command: "+list-reports",
+  description: "List all analysis reports for a project",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" }
+  ],
+  risk: "read",
+  execute: async (ctx) => {
+    return ctx.api("POST", "/v1/ta/event/listAll", {
+      projectId: ctx.num("project-id")
+    });
+  }
+};
+
+// src/commands/analysis/get-report.ts
+var getReport = {
+  service: "analysis",
+  command: "+get-report",
+  description: "Get full report definition by ID",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" },
+    { name: "report-id", type: "number", required: true, desc: "Report ID" }
+  ],
+  risk: "read",
+  execute: async (ctx) => {
+    return ctx.api("GET", "/v1/ta/event/reportsearch", {
+      projectId: ctx.num("project-id"),
+      reportId: ctx.num("report-id")
+    });
+  }
+};
+
+// src/commands/analysis/save-report.ts
+var saveReport = {
+  service: "analysis",
+  command: "+save-report",
+  description: "Save (create/update) an analysis report",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" },
+    { name: "report-name", type: "string", required: true, desc: "Report name" },
+    { name: "report-model", type: "number", required: true, desc: "0=Event, 1=Retention, 2=Funnel, 10=Distribution" },
+    { name: "events", type: "json", required: true, desc: "Events configuration array" },
+    { name: "event-view", type: "json", required: true, desc: "Event view configuration" }
+  ],
+  risk: "write",
+  execute: async (ctx) => {
+    return ctx.api("POST", "/v1/ta/event/reportsave", {
+      projectId: ctx.num("project-id")
+    }, {
+      reportName: ctx.str("report-name"),
+      reportModel: ctx.num("report-model"),
+      events: ctx.json("events"),
+      eventView: ctx.json("event-view")
+    });
+  }
+};
+
+// src/commands/analysis/list-dashboards.ts
+var listDashboards = {
+  service: "analysis",
+  command: "+list-dashboards",
+  description: "List all dashboards for a project",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" }
+  ],
+  risk: "read",
+  execute: async (ctx) => {
+    return ctx.api("GET", "/v1/ta/dashboard/all-dashboards", {
+      projectId: ctx.num("project-id")
+    });
+  }
+};
+
+// src/commands/analysis/get-dashboard.ts
+var getDashboard = {
+  service: "analysis",
+  command: "+get-dashboard",
+  description: "Get dashboard details by ID",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" },
+    { name: "dashboard-id", type: "number", required: true, desc: "Dashboard ID" }
+  ],
+  risk: "read",
+  execute: async (ctx) => {
+    return ctx.api("POST", "/v1/ta/dashboard/search-dashboard", {
+      projectId: ctx.num("project-id")
+    }, {
+      dashbordId: ctx.num("dashboard-id")
+    });
+  }
+};
+
+// src/commands/analysis/create-dashboard.ts
+var createDashboard = {
+  service: "analysis",
+  command: "+create-dashboard",
+  description: "Create a new dashboard",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" },
+    { name: "dashboard-name", type: "string", required: true, desc: "Dashboard name" }
+  ],
+  risk: "write",
+  execute: async (ctx) => {
+    return ctx.api("POST", "/v1/ta/dashboard/create-dashboard", {
+      projectId: ctx.num("project-id")
+    }, {
+      dashboardName: ctx.str("dashboard-name")
+    });
+  }
+};
+
+// src/commands/analysis/update-dashboard.ts
+var updateDashboard = {
+  service: "analysis",
+  command: "+update-dashboard",
+  description: "Update dashboard report layout",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" },
+    { name: "dashboard-id", type: "number", required: true, desc: "Dashboard ID" },
+    { name: "reports", type: "json", required: true, desc: "[{reportId, reportWidth?, indexOrder}]" }
+  ],
+  risk: "write",
+  execute: async (ctx) => {
+    return ctx.api("POST", "/v1/ta/dashboard/update-dashboard", {
+      projectId: ctx.num("project-id")
+    }, {
+      dashbordId: ctx.num("dashboard-id"),
+      reports: ctx.json("reports")
+    });
+  }
+};
+
+// src/commands/analysis/list-dashboard-reports.ts
+var listDashboardReports = {
+  service: "analysis",
+  command: "+list-dashboard-reports",
+  description: "List reports within a dashboard",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" },
+    { name: "dashboard-id", type: "number", required: true, desc: "Dashboard ID" }
+  ],
+  risk: "read",
+  execute: async (ctx) => {
+    const result = await ctx.api("POST", "/v1/ta/dashboard/search-dashboard", {
+      projectId: ctx.num("project-id")
+    }, {
+      dashbordId: ctx.num("dashboard-id")
+    });
+    return result?.eventReportList ?? result;
+  }
+};
+
+// src/commands/analysis/query-report-data.ts
+var queryReportData = {
+  service: "analysis",
+  command: "+query-report-data",
+  description: "Query report data by report ID",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" },
+    { name: "report-id", type: "number", required: true, desc: "Report ID" },
+    { name: "dashboard-id", type: "number", desc: "Dashboard ID (optional)" },
+    { name: "start-time", type: "string", desc: "Start time (YYYY-MM-DD HH:mm:ss)" },
+    { name: "end-time", type: "string", desc: "End time (YYYY-MM-DD HH:mm:ss)" }
+  ],
+  risk: "read",
+  execute: async (ctx) => {
+    const projectId = ctx.num("project-id");
+    const reportId = ctx.num("report-id");
+    const report = await ctx.api("GET", "/v1/ta/event/reportsearch", {
+      projectId,
+      reportId
+    });
+    const qp = {
+      events: report.events,
+      eventView: report.eventView
+    };
+    const startTime = ctx.str("start-time");
+    const endTime = ctx.str("end-time");
+    if (startTime) qp.eventView = { ...qp.eventView, startTime };
+    if (endTime) qp.eventView = { ...qp.eventView, endTime };
+    return ctx.queryReportData(projectId, reportId, qp, report.reportModel || 0);
+  }
+};
+
+// src/commands/analysis/query-sql.ts
+var querySql = {
+  service: "analysis",
+  command: "+query-sql",
+  description: "Execute a SQL query against the project",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" },
+    { name: "sql", type: "string", required: true, desc: "SQL query string" }
+  ],
+  risk: "read",
+  execute: async (ctx) => {
+    return ctx.querySql(ctx.num("project-id"), ctx.str("sql"));
+  }
+};
+
+// src/commands/analysis/index.ts
+var commands = [
+  listReports,
+  getReport,
+  saveReport,
+  listDashboards,
+  getDashboard,
+  createDashboard,
+  updateDashboard,
+  listDashboardReports,
+  queryReportData,
+  querySql
+];
+var analysis_default = commands;
+export {
+  analysis_default as default
+};

package/dist/audience-AZ72TU5F.js

@@ -0,0 +1,119 @@
+// src/commands/audience/list-tags.ts
+var listTags = {
+  service: "audience",
+  command: "+list-tags",
+  description: "List user tags for a project",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" }
+  ],
+  risk: "read",
+  execute: async (ctx) => {
+    return ctx.api("POST", "/v1/ta/user/tag/list", {
+      projectId: ctx.num("project-id")
+    }, {});
+  }
+};
+
+// src/commands/audience/get-tag.ts
+var getTag = {
+  service: "audience",
+  command: "+get-tag",
+  description: "Get details for a specific user tag",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" },
+    { name: "tag-id", type: "number", required: true, desc: "Tag ID" }
+  ],
+  risk: "read",
+  execute: async (ctx) => {
+    return ctx.api("GET", "/v1/ta/user/tag/query", {
+      projectId: ctx.num("project-id"),
+      tagId: ctx.num("tag-id")
+    });
+  }
+};
+
+// src/commands/audience/list-clusters.ts
+var listClusters = {
+  service: "audience",
+  command: "+list-clusters",
+  description: "List clusters for a project",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" }
+  ],
+  risk: "read",
+  execute: async (ctx) => {
+    return ctx.api("GET", "/v1/ta/cluster/console/listProjectClusters", {
+      projectId: ctx.num("project-id")
+    });
+  }
+};
+
+// src/commands/audience/predict-cluster-count.ts
+var predictClusterCount = {
+  service: "audience",
+  command: "+predict-cluster-count",
+  description: "Predict entity count for a cluster with given conditions",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" },
+    { name: "conditions", type: "json", required: true, desc: "Cluster conditions object" }
+  ],
+  risk: "read",
+  execute: async (ctx) => {
+    return ctx.api("POST", "/v1/hermes/cluster/predictEntityCount", {}, {
+      projectId: ctx.num("project-id"),
+      ...ctx.json("conditions")
+    });
+  }
+};
+
+// src/commands/audience/list-audience-events.ts
+var listAudienceEvents = {
+  service: "audience",
+  command: "+list-audience-events",
+  description: "List supported events for audience analysis",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" }
+  ],
+  risk: "read",
+  execute: async (ctx) => {
+    return ctx.api("POST", "/v1/hermes/common/support/meta/listEvent", {}, {
+      projectId: ctx.num("project-id")
+    });
+  }
+};
+
+// src/commands/audience/load-audience-props.ts
+var loadAudienceProps = {
+  service: "audience",
+  command: "+load-audience-props",
+  description: "Load filterable props, prop quotas, and entity props in parallel",
+  flags: [
+    { name: "project-id", type: "number", required: true, alias: "p", desc: "Project ID" },
+    { name: "events", type: "json", desc: "[{eventName}]" }
+  ],
+  risk: "read",
+  execute: async (ctx) => {
+    const projectId = ctx.num("project-id");
+    const events = ctx.json("events") || [];
+    const [filtProps, quotaProps, entityProps] = await Promise.all([
+      ctx.api("POST", "/v1/hermes/common/support/meta/loadFiltProps", {}, { projectId, events }),
+      ctx.api("POST", "/v1/hermes/common/support/meta/loadPropQuotas", {}, { projectId, events }),
+      ctx.api("GET", "/v1/hermes/common/support/entity/props/list", { projectId })
+    ]);
+    return { filtProps, quotaProps, entityProps };
+  }
+};
+
+// src/commands/audience/index.ts
+var commands = [
+  listTags,
+  getTag,
+  listClusters,
+  predictClusterCount,
+  listAudienceEvents,
+  loadAudienceProps
+];
+var audience_default = commands;
+export {
+  audience_default as default
+};

package/dist/auth-2OVPSXHK.js

@@ -0,0 +1,19 @@
+import {
+  clearToken,
+  getAuthStatus,
+  getToken,
+  loadToken,
+  resolveHost,
+  saveToken,
+  setTokenManual
+} from "./chunk-C3VJLU5Y.js";
+import "./chunk-KAWQCMDL.js";
+export {
+  clearToken,
+  getAuthStatus,
+  getToken,
+  loadToken,
+  resolveHost,
+  saveToken,
+  setTokenManual
+};

package/dist/auth-6QCDAUYV.js

@@ -0,0 +1,67 @@
+import {
+  printError,
+  printOutput
+} from "./chunk-KM57HI5B.js";
+import {
+  clearToken,
+  getAuthStatus,
+  getToken,
+  resolveHost,
+  setTokenManual
+} from "./chunk-4YPCK7T5.js";
+import "./chunk-STTYG7WN.js";
+
+// src/commands/auth.ts
+function registerAuth(program) {
+  const auth = program.command("auth").description("Authentication management");
+  auth.command("login").description("Login to TE (auto-extract token from Chrome on macOS)").action(async () => {
+    const host = resolveHost(program.opts().host);
+    if (!host) {
+      printError("config", "No TE host configured.", "Run: te-cli config set-host");
+      process.exit(1);
+    }
+    try {
+      const token = await getToken(host);
+      process.stderr.write(`[te-cli] Authenticated to ${host}
+`);
+      printOutput({ authenticated: true, host, token: token.slice(0, 8) + "..." }, program.opts().format || "json");
+    } catch (err) {
+      printError("auth", err.message);
+      process.exit(1);
+    }
+  });
+  auth.command("set-token <token>").description("Manually set authentication token for active host").action((token) => {
+    const host = resolveHost(program.opts().host);
+    if (!host) {
+      printError("config", "No TE host configured.", "Run: te-cli config set-host");
+      process.exit(1);
+    }
+    setTokenManual(token, host);
+    process.stderr.write(`[te-cli] Token saved for ${host}
+`);
+    printOutput({ saved: true, host }, program.opts().format || "json");
+  });
+  auth.command("status").description("Show current authentication status").action(() => {
+    const host = resolveHost(program.opts().host);
+    if (!host) {
+      printOutput({ authenticated: false, host: "(none)", hint: "Run: te-cli config set-host" }, program.opts().format || "json");
+      return;
+    }
+    const status = getAuthStatus(host);
+    printOutput(status, program.opts().format || "json");
+  });
+  auth.command("logout").description("Clear stored token for active host").action(() => {
+    const host = resolveHost(program.opts().host);
+    if (!host) {
+      printError("config", "No TE host configured.", "Run: te-cli config set-host");
+      process.exit(1);
+    }
+    clearToken(host);
+    process.stderr.write(`[te-cli] Token cleared for ${host}
+`);
+    printOutput({ cleared: true, host }, program.opts().format || "json");
+  });
+}
+export {
+  registerAuth
+};

package/dist/auth-CFVQVVQN.js

@@ -0,0 +1,51 @@
+import {
+  printError,
+  printOutput
+} from "./chunk-KM57HI5B.js";
+import {
+  clearToken,
+  getAuthStatus,
+  getToken,
+  resolveHost,
+  setTokenManual
+} from "./chunk-C3VJLU5Y.js";
+import "./chunk-KAWQCMDL.js";
+
+// src/commands/auth.ts
+function registerAuth(program) {
+  const auth = program.command("auth").description("Authentication management");
+  auth.command("login").description("Login to TE (auto-extract token from Chrome on macOS)").action(async () => {
+    const host = resolveHost(program.opts().host);
+    try {
+      const token = await getToken(host);
+      process.stderr.write(`[te-cli] Authenticated to ${host}
+`);
+      printOutput({ authenticated: true, host, token: token.slice(0, 8) + "..." }, program.opts().format || "json");
+    } catch (err) {
+      printError("auth", err.message);
+      process.exit(1);
+    }
+  });
+  auth.command("set-token <token>").description("Manually set authentication token").action((token) => {
+    const host = resolveHost(program.opts().host);
+    setTokenManual(token, host);
+    process.stderr.write(`[te-cli] Token saved for ${host}
+`);
+    printOutput({ saved: true, host }, program.opts().format || "json");
+  });
+  auth.command("status").description("Show current authentication status").action(() => {
+    const host = resolveHost(program.opts().host);
+    const status = getAuthStatus(host);
+    printOutput(status, program.opts().format || "json");
+  });
+  auth.command("logout").description("Clear stored token").action(() => {
+    const host = resolveHost(program.opts().host);
+    clearToken(host);
+    process.stderr.write(`[te-cli] Token cleared for ${host}
+`);
+    printOutput({ cleared: true, host }, program.opts().format || "json");
+  });
+}
+export {
+  registerAuth
+};

package/dist/auth-QNSRS5ZR.js

@@ -0,0 +1,19 @@
+import {
+  clearToken,
+  getAuthStatus,
+  getToken,
+  loadToken,
+  resolveHost,
+  saveToken,
+  setTokenManual
+} from "./chunk-4YPCK7T5.js";
+import "./chunk-STTYG7WN.js";
+export {
+  clearToken,
+  getAuthStatus,
+  getToken,
+  loadToken,
+  resolveHost,
+  saveToken,
+  setTokenManual
+};

package/dist/auth-V4MDYFHU.js

@@ -0,0 +1,67 @@
+import {
+  printError,
+  printOutput
+} from "./chunk-KM57HI5B.js";
+import {
+  clearToken,
+  getAuthStatus,
+  getToken,
+  resolveHost,
+  setTokenManual
+} from "./chunk-P7NQZGSZ.js";
+import "./chunk-CFCHSAMQ.js";
+
+// src/commands/auth.ts
+function registerAuth(program) {
+  const auth = program.command("auth").description("Authentication management");
+  auth.command("login").description("Login to TE (auto-extract token from Chrome on macOS)").action(async () => {
+    const host = resolveHost(program.opts().host);
+    if (!host) {
+      printError("config", "No TE host configured.", "Run: te-cli config set-host");
+      process.exit(1);
+    }
+    try {
+      const token = await getToken(host);
+      process.stderr.write(`[te-cli] Authenticated to ${host}
+`);
+      printOutput({ authenticated: true, host, token: token.slice(0, 8) + "..." }, program.opts().format || "json");
+    } catch (err) {
+      printError("auth", err.message);
+      process.exit(1);
+    }
+  });
+  auth.command("set-token <token>").description("Manually set authentication token for active host").action((token) => {
+    const host = resolveHost(program.opts().host);
+    if (!host) {
+      printError("config", "No TE host configured.", "Run: te-cli config set-host");
+      process.exit(1);
+    }
+    setTokenManual(token, host);
+    process.stderr.write(`[te-cli] Token saved for ${host}
+`);
+    printOutput({ saved: true, host }, program.opts().format || "json");
+  });
+  auth.command("status").description("Show current authentication status").action(() => {
+    const host = resolveHost(program.opts().host);
+    if (!host) {
+      printOutput({ authenticated: false, host: "(none)", hint: "Run: te-cli config set-host" }, program.opts().format || "json");
+      return;
+    }
+    const status = getAuthStatus(host);
+    printOutput(status, program.opts().format || "json");
+  });
+  auth.command("logout").description("Clear stored token for active host").action(() => {
+    const host = resolveHost(program.opts().host);
+    if (!host) {
+      printError("config", "No TE host configured.", "Run: te-cli config set-host");
+      process.exit(1);
+    }
+    clearToken(host);
+    process.stderr.write(`[te-cli] Token cleared for ${host}
+`);
+    printOutput({ cleared: true, host }, program.opts().format || "json");
+  });
+}
+export {
+  registerAuth
+};

package/dist/auth-Z652VWDK.js

@@ -0,0 +1,19 @@
+import {
+  clearToken,
+  getAuthStatus,
+  getToken,
+  loadToken,
+  resolveHost,
+  saveToken,
+  setTokenManual
+} from "./chunk-P7NQZGSZ.js";
+import "./chunk-CFCHSAMQ.js";
+export {
+  clearToken,
+  getAuthStatus,
+  getToken,
+  loadToken,
+  resolveHost,
+  saveToken,
+  setTokenManual
+};