Skip to main content

Lark CLI

The Lark CLI (@lark-sh/cli) gives you full control over your projects, databases, security rules, and data from the terminal. Anything you can do in the dashboard, you can do from the command line, plus data operations like export, import, and real-time streaming.

Installation

Or run commands directly without installing:

Getting started

Log in

This opens your browser to the Lark dashboard. Authorize the CLI, and you’re in. Your session is stored in ~/.lark/config.json.

Set a default project

Most commands need a project ID. Set a default so you don’t have to pass --project every time:
You can always override it per-command with --project <id>.

Common workflows

Create a project and database

Read and write data

Pipe data from stdin

Use - as the value to read from stdin. This is useful for large payloads or scripting:

Watch for real-time changes

Stream live changes to your terminal:
Events print as they happen:
Press Ctrl+C to stop.

Export and import data

Manage security rules

Check metrics

JSON output for scripting

Every command supports --json for machine-readable output:

What’s next

Command reference

Full reference for every CLI command, flag, and option.

REST API

The HTTP API that powers the CLI’s data operations.