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>

tm1cli cube list
tm1cli cube exists <cube_name>

tm1cli dimension list
tm1cli dimension exists <dimension_name>

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

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.5.tar.gz (5.5 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.5-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tm1cli-0.1.5.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for tm1cli-0.1.5.tar.gz
Algorithm Hash digest
SHA256 a26880dbfaad4d72e7a6f12aa0d0d8aea978abe68823e078da936b28be4939c0
MD5 8e958033932d263343eec3f2390bc32c
BLAKE2b-256 f1f92de6e7f0dabfbeceb41d7197e4ce4eca982fe14b9a2bb398c3fda713337f

See more details on using hashes here.

Provenance

The following attestation bundles were made for tm1cli-0.1.5.tar.gz:

Publisher: pypi-publish.yml on onefloid/tm1cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: tm1cli-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for tm1cli-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6495d1f3d94cbe7ac37a8e3bd386630aba8184905d584ab1ba3f0a97efa496bc
MD5 15c08816bb7bbbbff516b42a5ccdd812
BLAKE2b-256 3ae6b8f3c938cbf9d74c789c1f91edf8da56dcdf9eda8445706382ebab3a36ae

See more details on using hashes here.

Provenance

The following attestation bundles were made for tm1cli-0.1.5-py3-none-any.whl:

Publisher: pypi-publish.yml on onefloid/tm1cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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