Skip to main content
The tm CLI ships in the same Python distribution as the SDK. Depending on how a release is published, install either from PyPI or from the GitHub release artifacts. Prerequisite: Python 3.12 or newer.

Install From PyPI

If your release is published to PyPI, this is the shortest install path: Create an isolated environment, install the package, then verify the CLI:
python3 -m venv .venv
./.venv/bin/pip install tensormesh
./.venv/bin/tm version
If you upgrade later, upgrade the same environment in place:
./.venv/bin/pip install --upgrade tensormesh
./.venv/bin/tm version

Install From A Release Artifact

If PyPI is not enabled for your release, or you are working from a release artifact directly, install either the wheel or source distribution:
python3 -m venv .venv
./.venv/bin/pip install /path/to/tensormesh-VERSION-py3-none-any.whl
./.venv/bin/tm version
Or:
python3 -m venv .venv
./.venv/bin/pip install /path/to/tensormesh-VERSION.tar.gz
./.venv/bin/tm version

Install For Local Development

If you are working in this repo as a contributor, use the bootstrap flow instead of a release artifact:
npm run bootstrap
./.venv/bin/tm version

Verify The Installed CLI

Use the explicit version command rather than relying only on the root --version flag. If you did not activate the virtual environment, keep using the explicit binary path:
./.venv/bin/tm version
./.venv/bin/tm --output json version
The JSON form is useful in automation when you want to assert the installed CLI version before running workflow scripts.

Current Packaging Notes

  • GitHub releases publish one verified dist/python artifact set containing the wheel, source distribution, SHA256SUMS, and RELEASE-MANIFEST.json.
  • RELEASE-MANIFEST.json records version, Python requirement, changelog/policy references, and install metadata for the published release artifacts.
  • Release CI smoke-tests both the wheel and the source distribution before publishing.
  • PyPI publishing is optional per release; GitHub release artifacts are the guaranteed install surface from this repo.