cli

lark-cli

中文版 | English

The official Lark/Feishu CLI tool, maintained by the larksuite team — built for humans and AI Agents. Covers core business domains including Messenger, Docs, Base, Sheets, Slides, Calendar, Mail, Tasks, Meetings, Markdown, and more, with 200+ commands and 26 AI Agent Skills.

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

Why lark-cli?

• Agent-Native Design — 24 structured Skills out of the box, compatible with popular AI tools — Agents can operate Lark with zero extra setup
• Wide Coverage — 18 business domains, 200+ curated commands, 26 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

Personal or Enterprise?

You are... Recommended path An individual developer — using lark-cli in your terminal or with your own AI Agent Follow the Quick Start below Enterprise IT / ISV — embedding lark-cli into your own Agent or platform, with centralized credentials (database / Vault / config center), unified audit logging, and a restricted command surface Read Embed lark-cli in your Agent and the extension/ packages — extend via a wrapper main, no need to modify CLI source

💡 For AI Agents: append .md to any Open Platform doc URL to fetch it as raw Markdown, e.g. embed-feishu-cli-in-agent.md.

Features

Category Capabilities 📅 Calendar View, create and update events, invite attendees, find meeting rooms, RSVP to invitations, check free/busy & 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 📝 Markdown Create, fetch, patch, and overwrite Drive-native .md files 📊 Base Create and manage tables, fields, records, views, dashboards, workflows, forms, roles & permissions, data aggregation & analytics 📈 Sheets Create, read, write, append, find, and export spreadsheet data 🖼️ Slides Create and manage presentations, read presentation content, and add or remove slides ✅ 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 live and historical meetings, inspect participants and artifacts, analyze transcripts, manage Minutes, and assist in meetings 🕐 Attendance Query personal attendance check-in records ✍️ Approval Query approval tasks, approve/reject/transfer tasks, cancel and CC instances 🎯 OKR Query, create, update OKRs; manage objective & key results, alignments, indicators and progress. 📋 Project Meegle — manage work items, schedules, and data via the standalone meegle-cli (install separately) 🔗 Apps Create Spark/Miaoda apps, publish HTML/static sites, run cloud generation, and manage access scope

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):

npx @larksuite/cli@latest install

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

npx @larksuite/cli@latest install

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 Description lark-shared App config, auth login, identity switching, scope management, security rules (auto-loaded by all other skills) lark-calendar Calendar events (create/update), agenda view, free/busy queries, time suggestions, room finding, RSVP replies lark-im Send/reply messages, group chat management, message search, upload/download images & files, reactions lark-doc Create, read, update, search documents (Markdown-based) lark-drive Upload, download files, manage permissions & comments lark-markdown Create, fetch, patch, and overwrite Drive-native Markdown files lark-sheets Create, read, write, append, find, export spreadsheets lark-slides Create and manage presentations, read presentation content, and add or remove slides lark-base Tables, fields, records, views, dashboards, data aggregation & analytics lark-task Tasks, task lists, subtasks, reminders, member assignment lark-mail Browse, search, read emails, send, reply, forward, draft management, watch new mail lark-contact Search users by name/email/phone, get user profiles lark-wiki Knowledge spaces, nodes, documents lark-event Real-time event subscriptions (WebSocket), regex routing & agent-friendly format lark-meeting Search live or historical meetings, inspect participants and artifacts, analyze transcripts, manage Minutes, and assist in meetings lark-whiteboard Whiteboard/chart DSL rendering lark-openapi-explorer Explore underlying APIs from official docs lark-skill-maker Custom skill creation framework lark-attendance Query personal attendance check-in records lark-approval Query approval tasks, approve/reject/transfer tasks, cancel and CC instances lark-workflow-meeting-summary Workflow: meeting minutes aggregation & structured report lark-workflow-standup-report Workflow: agenda & todo summary lark-okr Query, create, update OKRs; manage objective & key results, alignments and indicators.

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

…

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 huma