Skip to main content

A command-line interface (CLI) tool for interacting with TM1 servers using TM1py.

Project description

TM1-CLI

PyPI - License PyPI - Version

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

Using Poetry

Clone the repository and install using Poetry

git clone https://github.com/onefloid/tm1cli.git
cd tm1cli
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>

All Available Commands

Run the following to see all available commands:

tm1cli --help

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tm1cli-0.1.3.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tm1cli-0.1.3-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file tm1cli-0.1.3.tar.gz.

File metadata

  • Download URL: tm1cli-0.1.3.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.7 Windows/10

File hashes

Hashes for tm1cli-0.1.3.tar.gz
Algorithm Hash digest
SHA256 72c57c0830bc9289786066f7617f290393c14232becc69d9adc7531bceacf337
MD5 c1547d8ace2db9c343c079c9122a9332
BLAKE2b-256 a5d6664b22c3b3a3b02334e12d3753a03c20656d7d4a631a87725cba81893dd9

See more details on using hashes here.

File details

Details for the file tm1cli-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: tm1cli-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.7 Windows/10

File hashes

Hashes for tm1cli-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8d8957c5c502cb44d08e943efff96af6399a2f1ae100569e42fa7806848b4bd7
MD5 da4d7027903cf7d6b14a3ec858646658
BLAKE2b-256 30826fbd14a2f360154284e0ed4a42619277e487b7bf40d45f64abee4c7e37fb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page