ToloMEO CLI¶
tlm-cli is the command-line interface for the ToloMEO Manager platform. It provides access
to all platform modules — administration, manufacturing, and fleet management — directly from
the terminal.
- Repository: gitlab.com/.../tlm-cli
- Full documentation: tlm-cli.docs.tolomeo.io
Capabilities¶
| Sub-command | Area | Description |
|---|---|---|
tlm-cli admin |
Administration | Manage customers, users, IAM roles and policies, and trial tenants |
tlm-cli pms |
Manufacturing | Devices, parts and sub-parts, events, models and firmwares, and device provisioning |
tlm-cli fm |
Fleet | Monitor and manage deployed devices |
tlm-cli cs |
Cybersecurity | Manage cybersecurity projects and upload SBOM and VEX files |
Run any command with --help to see its full set of sub-commands and options.
Installation¶
With uv (recommended):
git clone git@gitlab.com:DAVEEmbeddedSystems/public/tolomeo-public-projects/tools/tlm-cli.git
cd tlm-cli
uv sync
uv pip install -e .
With pip:
pip install tlm-cli \
--extra-index-url https://gitlab.com/api/v4/projects/81184835/packages/pypi/simple
Configuration¶
Create ~/.config/tlm-cli/.config.toml with your instance credentials:
[application]
instance = "your-instance.example.com"
[auth]
username = "you@example.com"
password = "your-password"
Restrict permissions to protect credentials:
The CLI searches for the config file in order: current directory, ~/.config/tlm-cli/,
/etc/tlm-cli/.
Global options¶
A few options apply to every command:
| Option | Description |
|---|---|
--config, -c |
Use a specific config file instead of the search order above |
--plain |
Emit machine-readable JSON and disable interactive prompts and progress bars. Also settable with the TLM_CLI_PLAIN environment variable, and enabled automatically when output is piped rather than shown in a terminal |
In plain (piped) mode the interactive displays are replaced by JSON, and commands that change
or delete data require an explicit confirmation flag (--yes, -y) since they cannot prompt.
Quick start¶
# Explore available commands
tlm-cli --help
tlm-cli pms --help
tlm-cli fm --help
# List manufacturing devices
tlm-cli pms devices list
# List fleet devices
tlm-cli fm devices list
In an interactive terminal, list commands use a paginated display. Press Enter to advance,
D to toggle detail view, Q to quit. When piped or run with --plain, they emit JSON
instead.
PMS vs Fleet Manager¶
The CLI distinguishes between two device registries:
PMS (tlm-cli pms) |
Fleet Manager (tlm-cli fm) |
|
|---|---|---|
| Purpose | Manufacturing record | Operational fleet registry |
| Tracks | Parts, serial numbers, production data, events, provisioning | Claimed devices, live status |
| Lifecycle stage | Design through provisioning | Post-deployment and monitoring |
See the PMS Setup flow to define parts and customers before manufacturing, and the Device Provisioning flow for the end-to-end manufacturing and registration walkthrough.