cli

(★ 16,641)

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

Showing a partial file list — download the zip above to see everything.

  • .codecov.yml
  • .gitignore
  • .gitleaks.toml
  • .golangci.yml
  • .goreleaser.yml
  • .licenserc.yaml
  • AGENTS.md
  • build.sh
  • CHANGELOG.md
  • content_embed.go
  • content_embed_affordance_test.go
  • go.mod
  • go.sum
  • lark_suite_assets_test.go
  • LICENSE
  • main.go
  • main_authsidecar.go
  • main_noauthsidecar.go
  • main_noauthsidecar_test.go
  • Makefile
  • package-lock.json
  • package.json
  • README.md
  • README.zh.md

🚀 Installation Guide

1. Get the code
git clone https://github.com/larksuite/cli

Downloads the entire project code from GitHub to your computer.

cd cli

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

3. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

If the build finishes without errors, it worked. If you used go run ., check the terminal output.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make install

Compiles the code based on the generated build configuration to produce an executable.

If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation