Yohohaha/te-cli

CLI tool for ThinkingEngine (TE) analytics platform

★ 0Forks 0GitHub ↗Compare

README

te-cli

CLI tool for ThinkingEngine (TE) analytics platform. Designed for both AI Agent and human use.

Installation

Step 1: Install te-cli

npm install -g @zhoujinandrew/te-cli

Step 2: Install AI Agent Skills

npx skills add zjandrew/te-cli -g -y

This installs 5 skill packages into your AI coding agent (Claude Code, Trae, Cursor, etc.), enabling the agent to understand and call te-cli commands.

To update:

npm cache clean --force && npm install -g @zhoujinandrew/te-cli@latest
npx skills add zjandrew/te-cli -g -y

Quick Start

# 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

# 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.

# 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

Skills

5 AI Agent skill packages are included in the skills/ directory:

Skill Description
te-shared Authentication, configuration, global options
te-meta Metadata: events, properties, entities, metrics, tables
te-analysis Reports, dashboards, SQL queries, report data
te-audience Tags, clusters, audience events/properties
te-operation Tasks, flows, channels, space navigation

Install them with:

npx skills add zjandrew/te-cli -g -y

Development

git clone https://github.com/zjandrew/te-cli.git
cd te-cli
npm install
npx tsx src/index.ts --help

Contributors

zjandrew

Issues