Skip to content

Getting Started ​

lindris is the command-line interface for the Lindris platform. It wraps the public REST API, so you can script, pipe, and drive your Lindris account from your terminal — or from an AI agent.

Install ​

Install the latest release with one command:

bash
curl -sSL https://a.lindris.com/cli/install.sh | bash

This downloads the right build for your OS and architecture and installs the lindris binary to ~/.local/bin (or /usr/local/bin when it's writable). To pin a specific version, pass it through to the installer:

bash
curl -sSL https://a.lindris.com/cli/install.sh | bash -s -- v1.2.3

Verify the install:

bash
lindris version
lindris doctor

lindris doctor checks your config, authentication, and API reachability in one pass — run it first whenever something looks off.

Authenticate ​

Log in once and your API key is stored in your OS keyring (Keychain on macOS, secret-service on Linux, Credential Manager on Windows) — never written to disk in plaintext:

bash
lindris auth login

Working across multiple workspaces? Add a named profile per account and switch between them:

bash
lindris auth profile add work
lindris auth profile use work

In CI or headless environments where no keyring is available, set LINDRIS_API_KEY instead — lindris falls back to it automatically. lindris auth status shows which source resolved the active key.

Your first commands ​

List the people (contacts) in your account:

bash
lindris people list

Look someone up, then inspect their activity:

bash
lindris people get [email protected]
lindris people events [email protected]

Every command supports --help, and most read-only commands can emit JSON for piping into jq or another tool.

Where to next ​