lark-cli

A command-line tool for Lark/Feishu Open Platform — built for humans and AI Agents. Covers core business domains including Messenger, Docs, Base, Sheets, Calendar, Mail, Tasks, Meetings, and more, with 200+ commands and 19 AI Agent Skills.

Install · AI Agent Skills · Auth · Commands · Advanced · Security · Contributing

Why lark-cli?

Agent-Native Design — 19 structured Skills out of the box, compatible with popular AI tools — Agents can operate Lark with zero extra setup
Wide Coverage — 11 business domains, 200+ curated commands, 19 AI Agent Skills
AI-Friendly & Optimized — Every command is tested with real Agents, featuring concise parameters, smart defaults, and structured output to maximize Agent call success rates
Open Source, Zero Barriers — MIT license, ready to use, just npm install
Up and Running in 3 Minutes — One-click app creation, interactive login, from install to first API call in just 3 steps
Secure & Controllable — Input injection protection, terminal output sanitization, OS-native keychain credential storage
Three-Layer Architecture — Shortcuts (human & AI friendly) → API Commands (platform-synced) → Raw API (full coverage), choose the right granularity

Features

| Category | Capabilities | | ------------- | ----------------------------------------------------------------------------------- | | 📅 Calendar | View agenda, create events, invite attendees, check free/busy status, time suggestions | | 💬 Messenger | Send/reply messages, create and manage group chats, view chat history & threads, search messages, download media | | 📄 Docs | Create, read, update, and search documents, read/write media & whiteboards | | 📁 Drive | Upload and download files, search docs & wiki, manage comments | | 📊 Base | Create and manage tables, fields, records, views, dashboards, data aggregation & analytics | | 📈 Sheets | Create, read, write, append, find, and export spreadsheet data | | ✅ Tasks | Create, query, update, and complete tasks; manage task lists, subtasks, comments & reminders | | 📚 Wiki | Create and manage knowledge spaces, nodes, and documents | | 👤 Contact | Search users by name/email/phone, get user profiles | | 📧 Mail | Browse, search, read emails, send, reply, forward, manage drafts, watch new mail | | 🎥 Meetings | Search meeting records, query meeting minutes & recordings |

Installation & Quick Start

Requirements

Before you start, make sure you have:

Node.js (npm/npx)
Go v1.23+ and Python 3 (only required for building from source)

Quick Start (Human Users)

Note for AI assistants: If you are an AI Agent helping the user with installation, jump directly to Quick Start (AI Agent), which contains all the steps you need to complete.

Install

Choose one of the following methods:

Option 1 — From npm (recommended):

# Install CLI
npm install -g @larksuite/cli

# Install CLI SKILL (required)
npx skills add larksuite/cli -y -g

Option 2 — From source:

Requires Go v1.23+ and Python 3.

git clone https://github.com/larksuite/cli.git
cd cli
make install

# Install CLI SKILL (required)
npx skills add larksuite/cli -y -g

Configure & Use

# 1. Configure app credentials (one-time, interactive guided setup)
lark-cli config init

# 2. Log in (--recommend auto-selects commonly used scopes)
lark-cli auth login --recommend

# 3. Start using
lark-cli calendar +agenda

Quick Start (AI Agent)

The following steps are for AI Agents. Some steps require the user to complete actions in a browser.

Step 1 — Install

# Install CLI
npm install -g @larksuite/cli

# Install CLI SKILL (required)
npx skills add larksuite/cli -y -g

Step 2 — Configure app credentials

Run this command in the background. It will output an authorization URL — extract it and send it to the user. The command exits automatically after the user completes the setup in the browser.

lark-cli config init --new

Step 3 — Login

Same as above: run in the background, extract the authorization URL and send it to the user.

lark-cli auth login --recommend

Step 4 — Verify

lark-cli auth status

Agent Skills

| Skill | ------------------------------- | lark-shared | lark-calendar | lark-im | lark-doc | lark-drive | lark-sheets | lark-base | lark-task | lark-mail | lark-contact | lark-wiki | lark-event | lark-vc | lark-whiteboard | lark-minutes | lark-openapi-explorer | lark-skill-maker | lark-workflow-meet | lark-workflow-stan | Description | | ------------------------------------------------------------------------------------- | | App config, auth login, identity switching, scope management, security rules (auto-loaded by all other skills) | | Calendar events, agenda view, free/busy queries, time suggestions | | Send/reply messages, group chat management, message search, upload/download images & files, reactions | | Create, read, update, search documents (Markdown-based) | | Upload, download files, manage permissions & comments | | Create, read, write, append, find, export spreadsheets | | Tables, fields, records, views, dashboards, data aggregation & analytics | | Tasks, task lists, subtasks, reminders, member assignment | | Browse, search, read emails, send, reply, forward, draft management, watch new mail | | Search users by name/email/phone, get user profiles | | Knowledge spaces, nodes, documents | | Real-time event subscriptions (WebSocket), regex routing & agent-friendly format | | Search meeting records, query meeting minutes (summary, todos, transcript) | | Whiteboard/chart DSL rendering | | Minutes metadata & AI artifacts (summary, todos, chapters) | | Explore underlying APIs from official docs | | Custom skill creation framework | ing-summary | Workflow: meeting minutes aggregation & structured report | dup-report | Workflow: agenda & todo summary |

Authentication

| Command | Description | | ------------- | -------------------------------------------------------------- | | auth login | OAuth login with interactive selection or CLI flags for scopes | | auth logout | Sign out and remove stored credentials | | auth status | Show current login status and granted scopes | | auth check | Verify a specific scope (exit 0 = ok, 1 = missing) | | auth scopes | List all available scopes for the app | | auth list | List all authenticated users |

# Interactive login (TUI guides domain and permission level selection)
lark-cli auth login

# Filter by domain
lark-cli auth login --domain calendar,task

# Recommended auto-approval scopes
lark-cli auth login --recommend

# Exact scope
lark-cli auth login --scope "calendar:calendar:readonly"

# Agent mode: return verification URL immediately, non-blocking
lark-cli auth login --domain calendar --no-wait
# Resume polling later
lark-cli auth login --device-code <DEVICE_CODE>

# Identity switching: execute commands as user or bot
lark-cli calendar +agenda --as user
lark-cli im +messages-send --as bot --chat-id "oc_xxx" --text "Hello"

Three-Layer Command System

The CLI provides three levels of granularity, covering everything from quick operations to fully custom API calls:

1. Shortcuts

Prefixed with +, designed to be friendly for both humans and AI, with smart defaults, table output, and dry-run previews.

lark-cli calendar +agenda
lark-cli im +messages-send --chat-id "oc_xxx" --text "Hello"
lark-cli docs +create --title "Weekly Report" --markdown "# Progress\n- Completed feature X"

Run lark-cli <service> --help to see all shortcut commands.

2. API Commands

Auto-generated from Lark OAPI metadata, curated through evaluation and quality gates — 100+ commands mapped 1:1 to platform endpoints.

lark-cli calendar calendars list
lark-cli calendar events instance_view --params '{"calendar_id":"primary","start_time":"1700000000","end_tim

Cli

Install / Use

README