lark-cli 飞书CLI

lark-cli: Your Command-Line Companion for Lark/Feishu Open Platform

lark-cli is a powerful and versatile command-line interface designed to streamline your interactions with the Lark/Feishu Open Platform. Built with both human developers and AI Agents in mind, it offers a comprehensive suite of tools to manage and automate tasks across various Lark/Feishu business domains. With over 200 commands and 19 specialized AI Agent Skills, lark-cli empowers you to harness the full potential of Lark/Feishu, from basic messaging and document management to complex data manipulation and workflow automation.

Why lark-cli?

In today's fast-paced digital environment, efficient and intelligent tools are crucial for productivity. lark-cli addresses this need by providing:

• Agent-Native Design: Featuring 19 structured AI Agent Skills, lark-cli is designed for seamless integration with popular AI tools. Agents can leverage these skills to operate Lark/Feishu with zero additional setup, making automation more accessible than ever.
• Wide Coverage: Spanning 11 core business domains including Messenger, Docs, Base, Sheets, Calendar, Mail, Tasks, Meetings, Wiki, Contact, and Drive, lark-cli offers extensive functionality. With over 200 curated commands and 19 AI Agent Skills, it covers a vast range of use cases.
• AI-Friendly & Optimized: Every command has been rigorously tested with real AI Agents. They are optimized with concise parameters, intelligent defaults, and structured output formats to maximize the success rate of AI agent calls, ensuring a smooth and reliable automation experience.
• Open Source, Zero Barriers: Released under the permissive MIT license, lark-cli is free to use and modify. Installation is straightforward via npm (npm install -g @larksuite/cli), making it readily available for all developers.
• Rapid Deployment: Get started in minutes with a streamlined installation process, interactive authentication, and a simple three-step workflow from installation to your first API call.
• Enhanced Security: Built with security as a priority, lark-cli incorporates input injection protection, terminal output sanitization, and secure credential storage using OS-native keychains. These features help mitigate risks associated with AI-driven automation.
• Flexible Three-Layer Architecture: lark-cli offers three distinct layers of interaction:
  1. Shortcuts: User-friendly commands prefixed with +, designed for both human ease-of-use and AI agent compatibility, featuring smart defaults, table output, and dry-run previews.
  2. API Commands: Directly mapped 1:1 to Lark Open Platform API endpoints, auto-generated from official metadata and refined through quality gates, providing comprehensive access to over 2500 APIs.
  3. Raw API Calls: For advanced users and specific needs, lark-cli allows direct calls to any Lark Open Platform endpoint, offering maximum flexibility.

Features Overview

lark-cli provides robust capabilities across numerous Lark/Feishu modules:

• 📅 Calendar: View agendas, create events, invite attendees, check free/busy status, and get time suggestions.
• 💬 Messenger: Send and reply to messages, manage group chats and threads, search message history, and download media.
• 📄 Docs: Create, read, update, and search documents, including Markdown-based content and rich media.
• 📁 Drive: Upload and download files, search documents and wikis, and manage comments.
• 📊 Base: Create and manage tables, fields, records, views, and dashboards, facilitating data aggregation and analytics.
• 📈 Sheets: Perform operations on spreadsheets, including creation, reading, writing, appending, finding, and exporting data.
• ✅ Tasks: Manage tasks, task lists, subtasks, reminders, and member assignments.
• 📚 Wiki: Create and manage knowledge spaces, nodes, and documents for organized information sharing.
• 👤 Contact: Search users by name, email, or phone, and retrieve user profiles.
• 📧 Mail: Browse, search, read, send, reply, forward emails, manage drafts, and monitor new mail notifications.
• 🎥 Meetings: Search meeting records and query meeting minutes, including summaries, todos, and transcripts.
• And many more: Including capabilities for Drive, Tasks, Mail, Contact, Wiki, Events, Whiteboards, Minutes, and OpenAPI exploration.

Installation and Quick Start

Requirements:

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

Installation Options:

1. From npm (Recommended):

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

   Copy

2. From Source:

   git clone https://github.com/larksuite/cli.git
   cd cli
   make install
    
   # Install CLI SKILL (required)
   npx skills add larksuite/cli -y -g

   Copy

Quick Start (Human Users):

1. Configure App Credentials: Run lark-cli config init for an interactive setup.
2. Log In: Execute lark-cli auth login --recommend for an easy login process.
3. Start Using: Begin with commands like lark-cli calendar +agenda.

Quick Start (AI Agent):

1. Install: Follow the npm or source installation steps above.
2. Configure App Credentials: Run lark-cli config init --new in the background. Extract the authorization URL provided and send it to the user for browser-based setup.
3. Log In: Run lark-cli auth login --recommend in the background, again extracting and providing the authorization URL to the user.
4. Verify: Use lark-cli auth status to confirm the setup.

Advanced Usage

• Output Formats: Control output with --format json, --format pretty, --format table, --format ndjson, or --format csv.
• Pagination: Manage large datasets with --page-all, --page-limit, and --page-delay flags.
• Dry Run: Preview actions before execution using the --dry-run flag for safety.
• Schema Introspection: Explore API details with lark-cli schema or lark-cli schema <service>.<method>.

Security & Risk Warnings

This tool is designed for AI Agent invocation and carries inherent risks, including potential hallucinations, unpredictable execution, and prompt injection. AI Agents operate under the user's identity within authorized scopes, which could lead to data leakage or unauthorized actions. While lark-cli includes layered security protections, users must exercise caution and understand that modifying default security settings can significantly increase risks. It is recommended to use the Lark/Feishu bot associated with this tool as a private assistant and avoid adding it to group chats to prevent misuse. By using lark-cli, you acknowledge and assume all associated risks and responsibilities.

Contributing

Community contributions are highly encouraged. Submit issues or pull requests for bugs or feature suggestions. For significant changes, please initiate a discussion via an issue first.

License

This project is licensed under the MIT License. Usage of Lark/Feishu Open Platform APIs requires adherence to their respective terms of service and privacy policies.