Repolode
larksuite

larksuite/cli

Official command-line tool for Lark/Feishu, letting developers and AI Agents operate messages, docs, calendars, mail, tasks and more from the terminal.

Stars
17,747
Forks
1,356
Open issues
705
Last commit
24 hours ago

What is it?

lark-cli is the official command-line interface for Lark/Feishu, maintained by the larksuite team. It wraps the Lark Open Platform so that people and AI Agents can run operations on messages, documents, spreadsheets, calendars, mail, tasks, meetings and approvals from a shell.

Commands are organized in three layers: human-friendly shortcuts prefixed with `+`, API commands generated from platform metadata, and a raw API mode that can call any Open Platform endpoint. Output can be JSON, table, CSV or NDJSON, and write operations offer a dry-run preview. Login uses OAuth with per-scope selection, and credentials are stored in the OS-native keychain.

The project is distributed via npm (`npx @larksuite/cli`) or built from source with Go, and it ships a set of Agent Skills that let AI tools call Lark services with minimal setup.

Key features

  • 01Shortcut commands for calendar, messages, docs, sheets, tasks, mail and more
  • 02Auto-generated API commands plus raw access to Lark Open Platform endpoints
  • 03Multiple output formats including JSON, table, CSV and NDJSON
  • 04Dry-run preview for commands with side effects
  • 05OAuth login with scope selection and OS keychain credential storage
  • 06Pre-built Agent Skills for AI tools

Use cases

  • Letting an AI Agent send messages or update documents in Lark on a user's behalf
  • Scripting daily calendar, task or report workflows from the terminal
  • Exporting Sheets or Base data to CSV for analysis
  • Embedding Lark operations into an internal platform with a restricted command set

Quick start

  1. 1

    Install the CLI from npm

    npx @larksuite/cli@latest install
  2. 2

    Configure app credentials with the interactive setup

    lark-cli config init
  3. 3

    Log in with recommended scopes

    lark-cli auth login --recommend
  4. 4

    Run your first command, such as viewing your agenda

    lark-cli calendar +agenda

Things to know

  • Requires a Lark/Feishu app and user authorization via browser before most commands work.
  • Building from source needs Go 1.23+ and Python 3.

Topics

FAQ

What is cli?
Official command-line tool for Lark/Feishu, letting developers and AI Agents operate messages, docs, calendars, mail, tasks and more from the terminal. lark-cli is the official command-line interface for Lark/Feishu, maintained by the larksuite team. It wraps the Lark Open Platform so that people and AI Agents can run operations on messages, documents, spreadsheets, calendars, mail, tasks, meetings and approvals from a shell.
Is cli free to use? What license does it have?
cli is open source under the MIT license. Check the license terms before using it in commercial products.
Is cli still maintained?
Actively maintained. The last commit to cli was on Oct 20, 2026.
What can I use cli for?
Letting an AI Agent send messages or update documents in Lark on a user's behalf Scripting daily calendar, task or report workflows from the terminal Exporting Sheets or Base data to CSV for analysis Embedding Lark operations into an internal platform with a restricted command set
How do I install cli?
Install the CLI from npm: npx @larksuite/cli@latest install Configure app credentials with the interactive setup: lark-cli config init Log in with recommended scopes: lark-cli auth login --recommend Run your first command, such as viewing your agenda: lark-cli calendar +agenda
Where can I get cli?
The source code and installation instructions are on GitHub: https://github.com/larksuite/cli

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects