Skip to content

Getting Started

This tutorial walks you through installing tlm-cli, creating your configuration file, and running your first commands against a ToloMEO Manager instance.

What you will do

  1. Install the CLI
  2. Create your configuration file
  3. Explore what the CLI can do

Prerequisites

  • Python 3.11 or newer
  • Credentials for a ToloMEO Manager instance (username + password)

Step 1 — Install the CLI

Clone the repository and install in editable mode:

git clone git@gitlab.com:DAVEEmbeddedSystems/public/tolomeo-public-projects/tools/tlm-cli.git
cd tlm-cli
uv sync
uv pip install -e .

Verify the installation:

uv run tlm-cli --help

With pip

Install directly from the ToloMEO package registry:

pip install tlm-cli --extra-index-url https://gitlab.com/api/v4/projects/81184835/packages/pypi/simple

Verify the installation:

tlm-cli --help

Step 2 — Create the configuration file

tlm-cli reads its configuration from a .config.toml file. Create it at ~/.config/tlm-cli/.config.toml and fill in your instance details:

[application]
instance = "your-instance.example.com"   # hostname only, no https://

[auth]
username = "you@example.com"
password = "your-password"

Restrict the file permissions so your credentials are not readable by other users:

chmod 600 ~/.config/tlm-cli/.config.toml

The CLI searches for the config file in this order:

  1. Current working directory (./)
  2. ~/.config/tlm-cli/
  3. /etc/tlm-cli/

See the Configuration File Reference for the full set of options.

Step 3 — Explore what the CLI can do

tlm-cli is split into sub-applications. Run any command with --help to see its options:

tlm-cli --help
tlm-cli admin --help
tlm-cli pms --help
tlm-cli fm --help

Try listing manufacturing devices:

tlm-cli pms devices list

Try listing fleet devices:

tlm-cli fm devices list

Both tlm-cli pms devices list and tlm-cli fm devices list use an interactive paginated display — results are shown 25 at a time. Press Enter to advance to the next page, D to toggle the detail view, and Esc or Q to quit.

Next steps