Skip to content

CLI

The lingo command-line tool lets you look up, add, list, and export terms from your terminal.


Installation

uv pip install -e .

This installs into the project virtualenv. Run commands via uv run lingo from the repo directory, or install globally with uv tool install . to get a bare lingo command anywhere in your shell.


Configuration

Point the CLI at your Lingo server:

export LINGO_APP_URL=http://localhost:8000

Authentication — choose one:

export LINGO_API_TOKEN=your-bearer-token

# Authenticate via email (no password needed in dev mode)
lingo login you@example.com
Alternatively, for non-interactive use:
export LINGO_DEV_USER_ID=00000000-0000-0000-0000-000000000001
Only works when the server has LINGO_DEV_MODE=true.


Commands

lingo define — look up a term

lingo define API

Performs an exact case-insensitive lookup. Prints the term name, full name, definition, category, status, and vote count.

lingo define "SLA"

lingo add — add a new term

lingo add "SLA" "Service Level Agreement"

Optional flags:

lingo add "SLA" "Service Level Agreement" \
  --full-name "Service Level Agreement" \
  --category ops
Flag Description
--full-name TEXT Expanded form of the acronym
--category TEXT Grouping label

New terms are created with pending status.


lingo list — list terms

lingo list

List all terms. Optional filters:

lingo list --status official
lingo list --category tech
lingo list --status community --category product
lingo list --limit 20
Flag Default Description
--status TEXT (all) Filter by status: suggested, pending, community, official
--category TEXT (all) Filter by category
--limit INT 50 Maximum number of results

lingo export — export as Markdown

lingo export

Exports official terms as a Markdown glossary to stdout. Redirect to a file:

lingo export > glossary.md

Optional flags:

lingo export --status community --output glossary.md
Flag Default Description
--status TEXT official Which terms to include
--output PATH (stdout) Write to a file instead of stdout

Help

lingo --help
lingo define --help
lingo add --help
lingo list --help
lingo export --help