TM1-CLI

TM1-CLI is a command-line interface (CLI) tool to interact with TM1 servers using TM1py.

Features

• Easily execute TM1 functions via the command line.
• Manage multiple connection settings with databases.yaml file.
• Built with Python, powered by Typer for intuitive CLI design.

Installation

Using pip

Install the package directly from PyPI:

pip install tm1cli

Develop locally on linux

Clone the repository and install using Poetry

git clone https://github.com/onefloid/tm1cli.git
cd tm1cli
python -m venv .venv
source .source .venv/bin/activate
poetry install

Usage

Commands

Connect to a TM1 server and print its version:

tm1cli tm1-version
tm1cli threads
tm1cli whoami

tm1cli process list
tm1cli process exists <process_name>
tm1cli process clone --from <source_db> --to <target_db>
tm1cli process dump <name> --folder <path> --format <json|yaml>
tm1cli process load <name> --folder <path> --format <json|yaml>

tm1cli cube list
tm1cli cube exists <cube_name> --watch

tm1cli dimension list
tm1cli dimension exists <dimension_name> -w

tm1cli view list <cube_name>
tm1cli view exists <cube_name> <view_name>

tm1cli subset list <dimension_name>
tm1cli subset exists <dimension_name> <subset_name>

All Available Commands

Run the following to see all available commands:

tm1cli --help

Output formatting

By default, exists commands print a human-readable result, e.g. ✅ Cube exists!. Pass the global --output-raw flag before the command to get the raw True/False value instead, e.g. for scripting:

tm1cli --output-raw cube exists <cube_name>

Configuration

Connection settings are stored in a databases.yaml file. Here's an example:

databases:
  - name: mydb
    address: localhost
    port: 10001
    ssl: false
    user: admin
    password: ""

  - name: myremotedb
    address: tm1.example.com
    port: 20000
    ssl: false
    user: admin
    password: apple

If no databases.yaml file is found, tm1cli will look for environment variables starting with TM1_ and use them as the default database configuration.

For example, if you set the following environment variables, tm1cli will use them and will work just like in the configuration file example above:

  export TM1_ADDRESS=localhost
  export TM1_PORT=10001
  export TM1_SSL=false
  export TM1_USER=admin
  export TM1_PASSWORD=""

Notice: The clone command and the --database option are only supported with a databases.yaml file.