Skip to main content

treqs-cli

treqs-cli is the command-line control plane for TReqs. The current slice covers authentication, identity, project discovery, repo-local project context, training request lifecycle commands, compute target discovery, and project job inspection.

Installation

Install treqs-cli in an isolated tool environment (Python 3.10+):

uv tool install treqs-cli
# or
pipx install treqs-cli

To install it in an existing environment instead:

uv pip install treqs-cli
# or
pip install treqs-cli

Verify the console script after installation:

treqs --version
treqs --help

Development

python -m venv .venv
. .venv/bin/activate
pip install -e ".[dev]"
pytest
ruff check .
mypy src/treqs_cli

Local E2E

tests/e2e/ is a local-only harness and is intentionally ignored by git. It targets the PM2-managed local treqs-api e2e service and database.

Run it explicitly:

TREQS_CLI_E2E=1 pytest tests/e2e -q

Useful overrides:

TREQS_E2E_API_URL=http://127.0.0.1:3202
TREQS_E2E_DEV_EMAIL=jon+test1@treqs.ai
TREQS_E2E_PROJECT_PREFIX=treqs-cli-e2e

Default pytest remains fast and deterministic; local e2e tests are skipped unless TREQS_CLI_E2E=1 is set.

Commands

treqs login
treqs whoami
treqs projects list
treqs project use <owner>/<project>
treqs project status
treqs tr list
treqs tr create --title "Train MNIST" --workflow-snapshot-id <snapshot-id>
treqs tr show <request-id>
treqs tr update <request-id> --title "Train Fashion MNIST"
treqs tr update <request-id> --clear-workflow-path --clear-compute-target
treqs tr open <request-id> --workflow-path ".treqs/workflows/train.yaml" --compute-target <target>
treqs tr queue <request-id>
treqs compute targets list --owner <owner>
treqs jobs list --status QUEUED
treqs jobs show <job-id>

The CLI stores global auth state under the platform config directory, or TREQS_CONFIG_HOME when set. Repo context is written to .treqs/config.toml.

Metadata

Release files for treqs-cli 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for treqs-cli 0.1.0
File Size Uploaded
treqs_cli-0.1.0.tar.gz 41.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for treqs-cli 0.1.0
File Interpreter ABI Platform
treqs_cli-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 80.9 kB

Release files / treqs_cli-0.1.0.tar.gz

Download URL treqs_cli-0.1.0.tar.gz
Size 41.9 kB
Tags Source
SHA-256 checksum
How to use checksums
f90b6a6d199b4e2f9c4d1891f754d3c11ecc14273cab8910581d3d2bc9e7d208
BLAKE2b-256 checksum
How to use checksums
36463d86925bf8557fee7284e62da972a85666bc37fbb6dab6448cf1cddd6034
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release files / treqs_cli-0.1.0-py3-none-any.whl

Download URL treqs_cli-0.1.0-py3-none-any.whl
Size 39.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
473efa2b6a9ce31da370032b875cd41353404482f12c1a33f1562910a3bf2f53
BLAKE2b-256 checksum
How to use checksums
9797eda4a6e1c1cfc0864d38061f03c9193d2fef43b893111504ecc557f218b6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release history Release notifications | RSS feed

0.2.0

2 release files

This release

0.1.0 This release

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page