Open Source · MIT License · v1.0.0

The Official Feishu CLI
for AI Agents & Developers

Feishu CLI (Lark CLI) is the official open-source command-line tool from the Lark Open Platform by ByteDance. Access 200+ commands across 11 business domains with 19 built-in AI Agent Skills — messaging, documents, spreadsheets, calendar, email, tasks, meetings, and beyond.

Get Started View on GitHub
# Install Feishu CLI globally via npm
$ npm install -g @larksuite/cli
$ npx skills add larksuite/cli -y -g
200+
CLI Commands
11
Business Domains
19
AI Agent Skills
2,500+
API Endpoints
Core Capabilities

Why Feishu CLI

Feishu CLI bridges the gap between AI Agents and enterprise productivity. Every command is tested with real agents, designed with concise parameters, smart defaults, and structured output formats to maximize automation success rates.

Agent-Native Design

Built from the ground up for AI Agents like Claude Code, Cursor, Codex, and OpenCode. 19 structured Skills enable natural language control over the entire Lark platform without writing any code.

Three-Layer Architecture

Shortcuts for quick actions, API commands for precise control, and raw API access for the full 2,500+ endpoint surface. Choose the right abstraction level for each task.

Structured Output

Output in JSON, NDJSON, table, CSV, or pretty-print format. Built-in pagination with --page-all, configurable page limits, and binary file output support.

🔒

Enterprise Security

OS-native keychain credential storage, input injection protection, terminal output sanitization, and --dry-run previews for all destructive operations.

Flexible Authentication

OAuth 2.0 Device Flow with user and bot identity switching. Scope-based permissions with --recommend for least-privilege access. Interactive TUI and headless Agent mode.

Cross-Platform Support

Runs on macOS, Linux, and Windows across x64 and arm64 architectures. Built in Go, distributed via npm with automatic platform-specific binary installation.

Architecture

Three-Layer Command System

Feishu CLI organizes its commands into three progressive layers, allowing humans and AI Agents to operate at the right abstraction level.

1

Shortcuts (Recommended)

Human and AI-friendly commands prefixed with +. Smart defaults, table output, and dry-run previews built in.

lark-cli calendar +agenda   lark-cli im +messages-send --text "Hello"

2

API Commands

100+ curated commands auto-generated from Lark OAPI metadata. 1:1 mapping to platform endpoints for precise control.

lark-cli calendar events instance_view --params '{...}'

3

Raw API Access

Direct HTTP calls to any of 2,500+ Lark Open Platform API endpoints. Full flexibility when shortcuts and API commands don't cover your needs.

lark-cli api GET /open-apis/calendar/v4/calendars

Coverage

11 Business Domains

Feishu CLI (Lark CLI) provides comprehensive coverage across all major Lark platform capabilities, from daily messaging to complex multi-dimensional table operations.

💬

Messenger

10 shortcuts — send, reply, search, group management

📄

Documents

7 shortcuts — create, read, update with Markdown

📊

Base / Bitable

60 shortcuts — tables, records, fields, views, dashboards

📅

Calendar

4 shortcuts — agenda, events, free/busy, time suggestions

📧

Mail

11 shortcuts — send, reply, forward, triage, watch

Tasks

11 shortcuts — create, assign, complete, reminders

📁

Drive

3 shortcuts — upload, download, comments

📊

Sheets

7 shortcuts — read, write, append, find, export

📖

Wiki

Knowledge spaces and document nodes

🎥

Meetings

2 shortcuts — search records, query minutes

👤

Contacts

2 shortcuts — search users, get profiles

AI Integration

19 Built-in AI Agent Skills

Feishu CLI ships with 19 structured Skill definitions that integrate natively with Claude Code, Cursor, Codex, OpenCode, and other AI coding assistants. Each Skill teaches AI Agents exactly how to use the CLI for a specific domain.

Skill Category Description
lark-shared Core Foundation skill auto-loaded by all others. App configuration, authentication, identity switching, scope management, and security rules.
lark-im Messaging Send and reply to messages, manage group chats, search message history, upload and download media, emoji reactions, and thread replies.
lark-doc Docs Create, read, update, and search cloud documents using Markdown syntax. Supports media insertion, download, and whiteboard operations.
lark-base Data Full CRUD for multi-dimensional tables, fields, records, and views. Data aggregation queries, dashboards, workflows, roles, and forms.
lark-sheets Data Create, read, write, append, find, and export spreadsheet data. Supports value rendering options and async file export.
lark-calendar Productivity Calendar event management including agenda view, event creation with attendees, free/busy queries, and optimal time suggestions.
lark-mail Communication Browse, search, read, send, reply, and forward emails. Draft management, attachments, folder labels, and real-time WebSocket mail monitoring. Includes anti-prompt-injection security rules.
lark-task Productivity Create, update, complete, and reopen tasks. Subtasks, task lists, member assignment, followers, comments, and configurable reminders.
lark-drive Storage Upload and download files, manage permissions, and add document comments with wiki URL resolution support.
lark-contact Directory Search users by name, email, or phone number. Retrieve detailed user profiles from the organization directory.
lark-wiki Knowledge Manage knowledge spaces and document nodes. Resolve wiki tokens to actual document tokens for cross-module operations.
lark-event Platform Real-time event subscriptions via WebSocket long connections. NDJSON output with regex routing and agent-friendly compact format.
lark-vc Meetings Search historical meeting records and query AI-generated meeting minutes, including summaries, to-dos, transcripts, and chapters.
lark-whiteboard Visual Render whiteboards and charts via DSL or Mermaid syntax. Supports architecture diagrams, flowcharts, org charts, bar and line charts, funnels, mind maps, and more. Outputs to PNG.
lark-minutes Meetings Retrieve meeting minutes metadata and AI artifacts including title, duration, AI-generated summary, action items, and chapter breakdown.
lark-openapi-explorer Platform API discovery tool that guides agents to explore Lark's official OpenAPI documentation layer by layer when existing skills don't cover a specific need.
lark-skill-maker Platform Custom skill creation framework. Provides templates and best practices for packaging CLI operations into reusable SKILL.md files.
lark-workflow-meeting-summary Workflow Orchestrated workflow that collects meeting notes over a time range and generates structured summary reports using vc +search and vc +notes.
lark-workflow-standup-report Workflow Orchestrated workflow that combines calendar agenda and task lists to generate a comprehensive daily standup or status report.
Quick Start

Install Feishu CLI in 3 Steps

Get up and running with Lark CLI in under five minutes. Requires Node.js 16 or later on macOS, Linux, or Windows.

Step 1: Install CLI and AI Skills

# Install the Feishu CLI binary globally
$ npm install -g @larksuite/cli

# Install all 19 AI Agent Skills
$ npx skills add larksuite/cli -y -g

Step 2: Configure and Authenticate

# Initialize app credentials (interactive setup)
$ lark-cli config init

# Login with recommended least-privilege scopes
$ lark-cli auth login --recommend

# Verify everything is working
$ lark-cli auth status
$ lark-cli doctor

Step 3: Start Using

# View today's calendar agenda
$ lark-cli calendar +agenda

# Send a message to a group chat
$ lark-cli im +messages-send --chat-id "oc_xxx" --text "Hello from Feishu CLI"

# Create a new document with Markdown
$ lark-cli docs +create --title "Weekly Report" --markdown "# Progress\n- Completed feature X"

# List my tasks
$ lark-cli task +get-my-tasks

# Explore any API's parameters and permissions
$ lark-cli schema im.messages.create
Real-World Applications

What You Can Build with Feishu CLI

Teams use Feishu CLI (Lark CLI) to automate workflows, streamline communication, and build AI-powered office assistants that operate across all Lark platform services.

Bulk Personalized Messaging

Send customized messages to all team members in under a minute. AI agents compose unique content per recipient and dispatch through the IM module automatically.

Multi-Dimensional Data Auditing

Scan Bitable records for missing fields, data inconsistencies, and formatting issues. Automatically notify responsible team members to fix identified problems.

Meeting Workflow Automation

Extract action items from meeting minutes, create follow-up documents, assign tasks to team members, and send notification messages in one automated pipeline.

Cross-Timezone Scheduling

Query multiple team members' calendar availability across time zones and recommend optimal meeting times using the free/busy and suggestion APIs.

Daily Briefing Generation

Aggregate monitoring data, news feeds, or internal reports and deliver structured daily briefings to designated Lark groups each morning.

Email Resume Processing

Watch incoming mail for resume attachments, extract key information, organize candidates into structured Bitable records, and send acknowledgment emails.

Under the Hood

Technology Stack

Feishu CLI is built with proven, production-grade open-source technologies. Written in Go for performance and distributed via npm for accessibility.

Language Go 1.23+ for performance and cross-compilation
CLI Framework spf13/cobra v1.10.2 for command routing
Terminal UI Charmbracelet (bubbletea, lipgloss, huh)
Lark SDK larksuite/oapi-sdk-go v3.5.3 (official)
Credentials OS-native keychain via go-keyring
Real-time WebSocket via gorilla/websocket
Distribution npm package wrapping Go binary via GoReleaser
Platforms macOS, Linux, Windows (x64 + arm64)
Trust & Safety

Security by Design

Feishu CLI implements multiple layers of security protection to safeguard your data when used by both human operators and AI Agents.

OS-Native Keychain Storage

Credentials are stored in macOS Keychain, Windows Credential Manager, or Linux Secret Service. Never saved in plain text.

Input Injection Protection

All inputs are validated and sanitized to prevent command injection attacks and prompt injection in AI Agent contexts.

Dry-Run Previews

Use --dry-run on any write operation to preview the exact API request before execution. Essential for AI Agent safety.

Least-Privilege Scopes

The --recommend flag during login automatically selects only the minimum required permissions for common operations.

Terminal Output Sanitization

All terminal output is sanitized to prevent ANSI escape sequence injection and other terminal-based attacks.

Email Anti-Injection Rules

The mail skill treats all email content as untrusted input, with specific rules to prevent prompt injection through email bodies.

In-Depth Guides

Explore Feishu CLI by Topic

Dive deeper into specific Feishu CLI capabilities with our detailed guides covering installation, AI integration, and each business domain.

Installation & Setup Guide

Step-by-step instructions for installing Feishu CLI, configuring credentials, OAuth authentication, and troubleshooting with lark-cli doctor.

AI Agent Skills Reference

Complete guide to all 19 AI Agent Skills. Integrate with Claude Code, Cursor, and Codex for natural language office automation.

Messaging & Group Chat

Send messages, manage group chats, search conversations, reply to threads, and download media with 10 IM shortcuts.

Calendar & Scheduling

View agenda, create events, check free/busy status, and get AI-powered meeting time suggestions via the calendar module.

Document Operations

Create, read, and update cloud documents with Markdown. Insert media, manage whiteboards, and search across all content types.

Bitable & Multi-Dimensional Tables

60 shortcuts for tables, records, fields, views, dashboards, workflows, forms, and advanced permissions in Lark Bitable.

Email Management

Compose, send, reply, forward emails. Manage drafts, triage inbox, and monitor incoming mail with WebSocket watch.

Task Management

Create and assign tasks, set reminders, manage subtasks and task lists. Track progress and collaborate with your team.

FAQ

Frequently Asked Questions

What is Feishu CLI?

Feishu CLI (also known as Lark CLI) is the official open-source command-line tool from the Lark Open Platform by ByteDance. It provides 200+ commands across 11 business domains including messaging, documents, calendar, email, tasks, and more. The CLI binary is named lark-cli and the npm package is @larksuite/cli. It is designed for both human developers and AI Agents, released under the MIT license.

What is the difference between Feishu CLI and Lark CLI?

Feishu and Lark are the same product by ByteDance. Feishu is the Chinese brand name, while Lark is the international brand. Feishu CLI and Lark CLI refer to the same tool — the lark-cli binary. It works with both Feishu (feishu.cn) and Lark (larksuite.com) platform accounts.

Does Feishu CLI work with Claude Code and Cursor?

Yes. Feishu CLI ships with 19 AI Agent Skills that integrate natively with Claude Code, Cursor, Codex, OpenCode, and other AI coding assistants. After installing the Skills via npx skills add larksuite/cli -y -g, AI agents can operate the entire Lark platform through natural language commands. Remember to restart your AI tool after installation.

What platforms and systems does Feishu CLI support?

Feishu CLI runs on macOS, Linux, and Windows across both x64 and arm64 architectures. It requires Node.js 16 or later for npm installation. The CLI is built in Go and distributed as a platform-specific binary through npm.

How does Feishu CLI handle authentication?

Feishu CLI uses OAuth 2.0 Device Flow for authentication. During login, it provides a URL for browser-based authorization. Credentials are stored securely in your operating system's native keychain. The tool supports both user and bot identities, switchable with the --as flag.

Is Feishu CLI free to use?

Yes. Feishu CLI is open source under the MIT license with no usage fees. You need a Lark or Feishu account and a self-built application on the Lark Open Platform to generate the required App ID and App Secret credentials. The Lark Open Platform itself offers free tier access for most APIs.

How does the three-layer command architecture work?

Layer 1 (Shortcuts) provides human and AI-friendly commands prefixed with +, offering smart defaults and structured output. Layer 2 (API Commands) maps 1:1 to 100+ curated platform endpoints. Layer 3 (Raw API) enables direct HTTP calls to any of 2,500+ Lark Open Platform API endpoints via lark-cli api.