Datatrail CLI

Install · Docs

🛠️ Installation

Python 3.10 or newer is required for the supported dependency versions.

Install from PYPI

pip install datatrail-cli

Clone the repository

git clone https://github.com/CHIMEFRB/datatrail-cli
cd datatrail-cli
pip install .

⚙️ Configuration

Local

# Create Datatrail config file
datatrail config init --site local

# Ensure valid CADC Certificate exists
cadc-get-cert -u [username]

CANFAR

The Configuration steps at CANFAR are similar to the local configuration. One notable exception is that after installation, the datatrail command may not be in the PATH. It is installed to ~/.local/bin, in which case you may need to add it to your PATH or prepend it to the follwing commands.

# Create Datatrail config file
datatrail config init --site canfar

# Ensure valid CADC Certificate exists
cadc-get-cert -u [username]

CHIME

# Create Datatrail config file
datatrail config init --site chime

# Ensure valid CADC Certificate exists
cadc-get-cert -u [username]

Building the documentation

From the repository root, install the locked documentation dependencies with uv, then build the standalone public site:

uv sync --locked --group docs
uv run --no-sync mkdocs build --strict --config-file mkdocs-site.yml

The site is written to site/. To preview it locally, run uv run --no-sync mkdocs serve --config-file mkdocs-site.yml. The installed checkout supplies the generated CLI reference. mkdocs-site.yml adds the public site's theme and rendering extensions while inheriting the navigation from mkdocs.yml, which remains the handbook configuration.