Skip to content
Get packs

Guide · Open source

How to use lark-cli: install, log in and run commands

Updated · written with AI from the project's own documentation and checked against our catalogue data

lark-cli is the official command-line tool from the larksuite team for the Lark/Feishu workplace platform. It lets you work with Messenger, Docs, Sheets, Calendar, Mail, Tasks, Meetings and other Lark areas from a terminal. This guide shows you how to install it, connect it to your Lark account and run your first command.

lark-clilarksuite/cli · ★ 17.9k · MIT

Quick start

  1. 1Check the requirements. Confirm you have Node.js, and a Lark/Feishu account with app credentials.
  2. 2Install lark-cli. Run npx @larksuite/cli@latest install to install from npm.
  3. 3Configure app credentials. Run lark-cli config init and follow the guided setup.
  4. 4Log in. Run lark-cli auth login --recommend to authorise commonly used scopes.
  5. 5Run a command. Try lark-cli calendar +agenda to read your calendar agenda.
  6. 6Verify your session. Run lark-cli auth status to confirm you are logged in.

What you need before you install lark-cli

You need a Lark/Feishu account and app credentials, because setup requires them. The README lists the following requirements.

  • Node.js (npm/npx)
  • Go v1.23+ and Python 3, only if you build from source

Install lark-cli with npm

The README recommends installing from npm. Run the command below to start the installer.

npx @larksuite/cli@latest install

Build lark-cli from source (optional)

If you prefer to build from source, you need Go v1.23+ and Python 3. Clone the repository, enter the folder and run make install. The README then asks you to install the CLI Skill with npx skills add.

git clone https://github.com/larksuite/cli.git cd cli make install npx skills add larksuite/cli -y -g

Configure app credentials and log in

Run config init once to set up your app credentials through an interactive guided setup. Then run auth login. The --recommend flag auto-selects commonly used scopes, so you do not have to pick them one by one.

lark-cli config init lark-cli auth login --recommend

Run your first command

Once you are logged in, you can run commands. The README's example reads your agenda from the calendar. Check your login state with auth status if a command fails.

lark-cli calendar +agenda lark-cli auth status

Understand the three command layers

The README describes three layers. Shortcuts are designed for humans and AI agents. API Commands follow the platform and stay synced with it. Raw API gives full coverage when you need an endpoint that has no shortcut. Pick the layer that matches the granularity you need.

  • Shortcuts (human and AI friendly)
  • API Commands (platform-synced)
  • Raw API (full coverage)

What people use it for

  • Read your calendar agenda from a terminal with calendar +agenda.
  • Script Lark/Feishu tasks as part of a build or ops workflow.
  • Let an AI agent operate Lark through the bundled agent Skills.
  • Automate calendar, messaging or document workflows for a team.
  • Embed the CLI in an enterprise agent platform, as the README describes.

Frequently asked questions

Is lark-cli free to use?

lark-cli is released under the MIT licence, which is an open-source licence. The README describes it as open source and ready to use. Check the repository's LICENSE file for the full terms.

What do I need to install lark-cli?

For the recommended npm install, you need Node.js with npm or npx. Building from source also requires Go v1.23 or newer and Python 3. You also need a Lark/Feishu account and app credentials for setup.

Do I need a Lark account to use lark-cli?

Yes. The tool is for the Lark/Feishu platform, and setup requires app credentials. If you only need the Lark web or mobile app, this terminal tool is not necessary.

How do I fix a login problem with lark-cli?

Run lark-cli auth status to see whether you are logged in. If not, run lark-cli auth login --recommend again. If configuration is missing, run lark-cli config init first.

Can an AI agent use lark-cli?

Yes. The README says the tool is built for AI Agents and ships with 26 AI Agent Skills. Its Quick Start for AI Agents covers install, config, login and verification steps.

How does lark-cli compare to other Lark tools?

The README lists meegle-cli and lark-mcp as comparable projects. meegle-cli is a separate tool for Meegle project management, which lark-cli links to but does not include. Choose based on whether you need a CLI or an MCP-style integration.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

lark-cli suits developers and teams who want to script Lark/Feishu tasks, or let an AI agent run structured commands against Lark. It is a poor fit if you only use the Lark app, or if you have no Lark account and app credentials to set up.

Install options & downloads