@lark-project/meegle

Meegle CLI

English | 简体中文

Command-line tool for Meegle (Lark Project). Manage work items, schedules, and data from your terminal — no browser needed.

Install · Quick Start · Agent Skill · Commands · Auth · Config · Security · Contributing

Why Meegle CLI?

• Agent-Native — The setup wizard installs the bundled AI Agent Skill for Trae, Claude Code, Cursor, Windsurf, Gemini CLI and other agents. Every CLI command is designed for both humans and agents, with structured JSON output, --dry-run previews, and --device-code flows for non-TTY environments
• Broad Coverage — 16 business domains (work items, workflow, subtasks, comments, work hours, relations, my-work, views, charts, team, user, project, attachments, deliverables, resource library, WBS plan tables) and 50+ commands mapping to Meegle's core capabilities
• Two-Layer Parameters — Ergonomic --flag-name for everyday use, fallback --params <json for complex payloads like fields[] — pick the right granularity per call
• Flexible Output — json / table / ndjson / raw, with --select dot-path projection for piping to other tools
• Secure by Default — OS keychain credential storage, ${VAR} env-var templating so secrets never land in config files, multi-profile switching for staging / prod

Features

| Category | Capabilities | | -------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | 📋 Work Items | Create, read, update, batch-read, query (MQL), list operation records, inspect metadata | | 🔀 Workflow | Transition nodes & states, update node fields, list available transitions and required fields | | ✅ Subtasks | Create, update, complete, rollback subtasks | | 💬 Comments | Add and list comments on work items | | ⏱️ Work Hours | List work hour records, view team-member schedules | | 🔗 Relations | List related work items, inspect relation-type definitions | | 📌 My Work | View this week / overdue / completed to-dos | | 👁️ Views | Create and update fixed views, search views by name | | 📊 Charts | List charts under a view, fetch chart details | | 👥 Team & User | List teams, team members, search users, view current login | | 🗂️ Projects | Search projects by keyword | | 📎 Attachments | Two-stage upload/download protocol — prepare- basic commands plus +upload / +download end-to-end shortcuts | | 📦 Deliverables | List deliverables with their root and source work items | | 🧩 Resource Library | Create resource templates, inspect resource library configuration | | 🗓️ WBS Plan Tables | List draft / published plan rows, create / edit / publish / reset drafts, query draft progress, list element templates | | 🔐 Auth & Config | OAuth login, device-code flow, multi-profile config, env-var injection | | 🔗 URL Parsing | Offline decode of Meegle / Feishu Project URLs into urlkind + structured fields | | 🤖 Agent Skill | Pre-built skill for Trae / Claude Code / Cursor / Windsurf / Gemini CLI / Copilot |

Installation

Requirements

• Node.js = 16 (ships with npm / npx)

Run the setup wizard:

npx @lark-project/meegle@latest install

The wizard installs or upgrades the CLI globally, installs the AI Agent Skill, configures the Meegle host, and starts login.

Quick Start (Human Users)

Note for AI assistants: if you are an AI Agent helping the user set this up, jump directly to Quick Start (AI Agent) — it contains the non-interactive command you need.

# 1. Install CLI + Skill, configure host, and log in
npx @lark-project/meegle@latest install

# 2. View this week's to-dos
meegle mywork todo --action this_week --page-num 1

# 3. View help
meegle --help
meegle workitem --help

# 4. Inspect command parameters
meegle inspect workitem.create

Quick Start (AI Agent / CI / Headless)