Skip to content

Latest commit

 

History

History
1167 lines (871 loc) · 37.2 KB

File metadata and controls

1167 lines (871 loc) · 37.2 KB

treqs CLI reference

treqs

Usage: treqs [OPTIONS] COMMAND [ARGS]...

  TReqs command-line control plane.

Options:
  --version       Show the version and exit.
  --api-url TEXT  TReqs API base URL.  [env var: TREQS_API_URL]
  --json          Emit machine-readable JSON.
  --help          Show this message and exit.

Start Here:
  login   Authenticate with TReqs using browser/device login.
  whoami  Show the authenticated TReqs user and owner access summary.
  doctor  Validate project, Git source, workflow, and compute readiness.

Project Context:
  projects  List accessible TReqs projects.
  project   Manage repo-local TReqs project context.

Organizations:
  orgs  List TReqs organizations you belong to.

Training Requests:
  tr   Manage training requests for the current TReqs project.
  run  Create and launch a reproducible training request.

Compute:
  compute  Inspect compute resources for the current TReqs owner.

Jobs:
  jobs  Inspect jobs for the current TReqs project.

Account:
  logout  Clear local TReqs auth state and revoke the session when possible.

  Quick start:
    treqs login
    treqs projects list
    treqs project use <owner>/<project>
    treqs tr create --title "My run" --workflow-path .treqs/workflows/train.yaml
    treqs tr open <request-id> --compute-target <target>
    treqs tr queue <request-id>
    treqs jobs logs <job-id> --follow

  Owner scope:
    Owner-scoped commands accept --owner <org> and default to the repo's bound
    project owner, then your personal owner. Repo-bound commands (project, tr,
    jobs) always use the binding in .treqs/config.toml. Discover organizations
    with `treqs orgs list`.

  Authentication:
    `treqs login` uses a browser/device flow; `treqs login --token` stores a
    dashboard-issued API token instead. When TREQS_API_TOKEN is set it takes
    precedence over any stored login for API requests and is never persisted.

  Run `treqs COMMAND --help` for the options, arguments, and examples of each
  command.

treqs login

Usage: treqs login [OPTIONS]

  Authenticate with TReqs using browser/device login or an API token.

  Starts a device authorization flow: approve the printed URL and code in your
  browser and the CLI stores the session in the platform config directory
  (override with TREQS_CONFIG_HOME). With --token, the browser flow is skipped
  and a dashboard-issued API token is validated and stored instead. To use a
  token without storing it, set TREQS_API_TOKEN; it takes precedence over any
  stored login for API requests.

Options:
  --force       Replace an existing login without prompting.
  --no-browser  Do not try to open a browser automatically.
  --token TEXT  Log in with a TReqs API token from the dashboard instead of the
                browser flow. Pass '-' to read the token from stdin.
  --help        Show this message and exit.

  Examples:
    treqs login
    treqs login --no-browser
    treqs login --token treqs_pat_XXXXXXXX
    echo $TOKEN | treqs login --token -
    treqs --api-url http://localhost:3001 login

treqs whoami

Usage: treqs whoami [OPTIONS]

  Show the authenticated TReqs user and owner access summary.

  Lists every owner you can act as (yourself plus organizations) with your role
  and project count per owner.

Options:
  --help  Show this message and exit.

  Examples:
    treqs whoami
    treqs --json whoami

treqs doctor

Usage: treqs doctor [OPTIONS]

  Validate laptop, project, source, and compute readiness.

Options:
  --target TEXT         Compute target ID or name to validate.  [required]
  --workflow TEXT       Workflow path to validate at the selected commit.
  --source-commit TEXT  Git revision that will be submitted.  [default: HEAD]
  --help                Show this message and exit.

  Examples:
    treqs doctor --target gpu-box
    treqs doctor --target gpu-box --workflow .treqs/workflows/train.yaml \
        --source-commit <sha>

treqs projects

Usage: treqs projects [OPTIONS] COMMAND [ARGS]...

  List accessible TReqs projects.

Options:
  --help  Show this message and exit.

Commands:
  create  Create a project for a TReqs owner.
  list    List projects available to the authenticated user.

treqs projects create

Usage: treqs projects create [OPTIONS] NAME

  Create a project for a TReqs owner.

  NAME is the human-readable project name; the project slug defaults to a
  slugified NAME unless --slug is given. Use --owner to create the project under
  an organization from `treqs orgs list`.

Options:
  --slug TEXT                     Project slug. Defaults to a slugified name.
  --visibility [public|private]   Project visibility.  [default: private]
  --description TEXT              Project description.
  --code-config TEXT              Repository code config, for example
                                  github:https://github.com/owner/repo.
  --code-access-mode [public|github_app]
                                  GitHub access mode for --code-config.
                                  [default: public]
  --default-branch TEXT           Default git branch for --code-config (workflow
                                  discovery + clone).  [default: main]
  --owner TEXT                    Owner username or organization. Defaults to
                                  the repo's bound project owner, then your
                                  personal owner.
  --help                          Show this message and exit.

  Examples:
    treqs projects create "MNIST Digits"
    treqs projects create "MNIST Digits" --slug mnist --visibility public
    treqs projects create "Team Model" --owner acme
    treqs projects create Vision --code-config github:https://github.com/acme/vision

treqs projects list

Usage: treqs projects list [OPTIONS]

  List projects available to the authenticated user.

  Shows projects across every owner you can access, personal and organization-
  owned. The SCOPE column is <owner>/<project> and is valid input for `treqs
  project use`.

Options:
  --help  Show this message and exit.

  Examples:
    treqs projects list
    treqs --json projects list

treqs project

Usage: treqs project [OPTIONS] COMMAND [ARGS]...

  Manage repo-local TReqs project context.

Options:
  --help  Show this message and exit.

Commands:
  clear   Clear the repo-local TReqs project context.
  init    Create or bind a project from the current Git repository.
  status  Show the repo-local TReqs project context.
  use     Set this repo's TReqs project context.

treqs project clear

Usage: treqs project clear [OPTIONS]

  Clear the repo-local TReqs project context.

Options:
  --help  Show this message and exit.

  Examples:
    treqs project clear

treqs project init

Usage: treqs project init [OPTIONS]

  Create or bind a project from the current Git repository.

  Discovers the GitHub repository from the `origin` remote and creates a TReqs
  project for it (or binds an existing one), then writes the repo-local project
  context unless --no-use is given. Use --owner to place the project under an
  organization from `treqs orgs list`.

Options:
  --from-git / --no-from-git      Discover the GitHub repository from the origin
                                  remote.  [default: from-git]
  --name TEXT                     Project name. Defaults to the repository name.
  --slug TEXT                     Project slug. Defaults to a slugified project
                                  name.
  --visibility [public|private]   [default: private]
  --description TEXT              Project description.
  --code-access-mode [public|github_app]
                                  [default: github_app]
  --default-branch TEXT           Repository default branch. Discovered when
                                  omitted.
  --owner TEXT                    Owner username or organization. Defaults to
                                  the repo's bound project owner, then your
                                  personal owner.
  --use / --no-use                Bind this checkout.  [default: use]
  --help                          Show this message and exit.

  Examples:
    treqs project init
    treqs project init --owner acme --visibility public
    treqs project init --name "MNIST" --slug mnist

treqs project status

Usage: treqs project status [OPTIONS]

  Show the repo-local TReqs project context.

Options:
  --help  Show this message and exit.

  Examples:
    treqs project status
    treqs --json project status

treqs project use

Usage: treqs project use [OPTIONS] SELECTION

  Set this repo's TReqs project context.

  SELECTION is <owner>/<project> (see `treqs projects list` for valid scopes),
  or a bare project slug, name, or ID when it is unambiguous across your owners.
  The owner may be your username or an organization. Read-only projects are
  rejected. The context is saved to .treqs/config.toml and drives repo-bound
  commands (tr, jobs) plus the default owner scope of owner-scoped commands.

Options:
  --help  Show this message and exit.

  Examples:
    treqs project use trevor/mnist
    treqs project use acme/mnist
    treqs project use mnist

treqs orgs

Usage: treqs orgs [OPTIONS] COMMAND [ARGS]...

  List TReqs organizations you belong to.

Options:
  --help  Show this message and exit.

Commands:
  list  List organizations you belong to.

treqs orgs list

Usage: treqs orgs list [OPTIONS]

  List organizations you belong to.

  Every USERNAME listed here is a valid value for --owner on owner-scoped
  commands and for <owner>/<project> selections in `treqs project use`.

Options:
  --help  Show this message and exit.

  Examples:
    treqs orgs list
    treqs --json orgs list

treqs tr

Usage: treqs tr [OPTIONS] COMMAND [ARGS]...

  Manage training requests for the current TReqs project.

  All tr commands are repo-bound: run them inside a git repo bound to a project
  with `treqs project use`. Typical lifecycle: create a draft, open it with a
  compute target, then queue it as a job.

Options:
  --help  Show this message and exit.

Commands:
  cancel   Cancel a training request.
  comment  Post a comment on a training request.
  create   Create a training request in the repo-local project context.
  list     List training requests for the repo-local project context.
  open     Open a draft training request for review.
  queue    Queue an open training request as a job.
  review   Approve or reject an open training request.
  show     Show one training request from the repo-local project context.
  update   Update a training request in the repo-local project context.

treqs tr cancel

Usage: treqs tr cancel [OPTIONS] REQUEST_ID

  Cancel a training request.

  REQUEST_ID is the training request ID shown by `treqs tr list`. A cancelled
  request can be re-opened with `treqs tr open`.

Options:
  --help  Show this message and exit.

  Examples:
    treqs tr cancel <request-id>

treqs tr comment

Usage: treqs tr comment [OPTIONS] REQUEST_ID CONTENT

  Post a comment on a training request.

  REQUEST_ID is the training request ID shown by `treqs tr list`. CONTENT is the
  comment text (quote it if it contains spaces). See existing comments with
  `treqs tr show <request-id> --comments`.

Options:
  --help  Show this message and exit.

  Examples:
    treqs tr comment <request-id> "Looks good, approving."

treqs tr create

Usage: treqs tr create [OPTIONS]

  Create a training request in the repo-local project context.

Options:
  --title TEXT                    Training request title.  [required]
  --description TEXT              Training request description.
  --status [draft|open|closed|queued|completed]
                                  Initial training request status.  [default:
                                  draft]
  --workflow-path TEXT            Workflow path, for example
                                  .treqs/workflows/train.yaml.
  --workflow-snapshot-id TEXT     Workflow snapshot ID for queue-time launch.
  --compute-target TEXT           Compute target ID or name for this request.
  --source-branch TEXT            Git branch the workflow and repo are cloned
                                  from (defaults to the current git branch).
  --source-commit TEXT            Full immutable Git commit for the workflow and
                                  repository checkout.
  --lineage-mode [private|public|public_anonymous]
                                  Publish lineage natively for this fresh
                                  workflow: compiles a lineage snapshot so the
                                  run publishes to GLaaS (private = linked to
                                  the project). Requires --workflow-path.
                                  public/public_anonymous need confirmation
                                  (interactively, or pass --yes).
  --reviewer TEXT                 Reviewer to assign (member username or user
                                  ID). Repeat for multiple reviewers.
  -y, --yes                       Skip the public-lineage confirmation prompt
                                  (for non-interactive use).
  --help                          Show this message and exit.

  Examples:
    treqs tr create --title "Baseline run"
    treqs tr create --title "Train v2" --workflow-path .treqs/workflows/train.yaml
    treqs tr create --title "GPU run" --compute-target gpu-box --status open
    treqs tr create --title "Needs review" --reviewer <user> --reviewer <user>

treqs tr list

Usage: treqs tr list [OPTIONS]

  List training requests for the repo-local project context.

Options:
  --status [draft|open|closed|queued|completed]
                                  Filter by status. Repeat to include multiple
                                  statuses.
  --limit INTEGER RANGE           [default: 20; 1<=x<=100]
  --offset INTEGER RANGE          [default: 0; x>=0]
  --help                          Show this message and exit.

  Examples:
    treqs tr list
    treqs tr list --status draft --status open
    treqs --json tr list --limit 50

treqs tr open

Usage: treqs tr open [OPTIONS] REQUEST_ID

  Open a draft training request for review.

  REQUEST_ID is the training request ID shown by `treqs tr list`. Opening
  requires a compute target; once open the request can be queued. An open
  request needs at least one assigned reviewer before `treqs tr review
  approve/reject` will accept a decision from them.

Options:
  --workflow-path TEXT   Workflow path, for example .treqs/workflows/train.yaml.
  --compute-target TEXT  Compute target ID or name.  [required]
  --reviewer TEXT        Reviewer to assign (member username or user ID). Repeat
                         for multiple reviewers. Adds to any reviewers already
                         on the request.
  --help                 Show this message and exit.

  Examples:
    treqs tr open <request-id> --compute-target gpu-box
    treqs tr open <request-id> --compute-target gpu-box \
        --workflow-path .treqs/workflows/train.yaml
    treqs tr open <request-id> --compute-target gpu-box --reviewer <user>

treqs tr queue

Usage: treqs tr queue [OPTIONS] REQUEST_ID

  Queue an open training request as a job.

  REQUEST_ID is the training request ID shown by `treqs tr list`. Prints the
  created job ID; follow it with `treqs jobs logs <job-id> --follow`.

Options:
  --help  Show this message and exit.

  Examples:
    treqs tr queue <request-id>

treqs tr review

Usage: treqs tr review [OPTIONS] COMMAND [ARGS]...

  Approve or reject an open training request.

Options:
  --help  Show this message and exit.

Commands:
  approve  Approve an open training request.
  reject   Reject an open training request.

treqs tr review approve

Usage: treqs tr review approve [OPTIONS] REQUEST_ID

  Approve an open training request.

  REQUEST_ID is the training request ID shown by `treqs tr list`. An approved
  request can be queued with `treqs tr queue`.

Options:
  --comment TEXT  Optional review comment.
  --help          Show this message and exit.

  Examples:
    treqs tr review approve <request-id>
    treqs tr review approve <request-id> --comment "LGTM"

treqs tr review reject

Usage: treqs tr review reject [OPTIONS] REQUEST_ID

  Reject an open training request.

  REQUEST_ID is the training request ID shown by `treqs tr list`.

Options:
  --comment TEXT  Reason the request must be changed.  [required]
  --help          Show this message and exit.

  Examples:
    treqs tr review reject <request-id> --comment "needs a smaller dataset"

treqs tr show

Usage: treqs tr show [OPTIONS] REQUEST_ID

  Show one training request from the repo-local project context.

  REQUEST_ID is the training request ID shown by `treqs tr list`.

Options:
  --comments  Show only the comment thread instead of the request details.
  --help      Show this message and exit.

  Examples:
    treqs tr show <request-id>
    treqs --json tr show <request-id>
    treqs tr show <request-id> --comments
    treqs --json tr show <request-id> --comments

treqs tr update

Usage: treqs tr update [OPTIONS] REQUEST_ID

  Update a training request in the repo-local project context.

  REQUEST_ID is the training request ID shown by `treqs tr list`. Provide at
  least one update or --clear-* option.

Options:
  --title TEXT                    Training request title.
  --description TEXT              Training request description.
  --status [draft|open|closed|queued|completed]
                                  Training request status.
  --workflow-path TEXT            Workflow path, for example
                                  .treqs/workflows/train.yaml.
  --workflow-snapshot-id TEXT     Workflow snapshot ID for queue-time launch.
  --compute-target TEXT           Compute target ID or name for this request.
  --source-branch TEXT            Git branch the workflow and repo are cloned
                                  from (unchanged if omitted).
  --lineage-mode [private|public|public_anonymous]
                                  Publish lineage natively (compiles a lineage
                                  snapshot if the request doesn't already have
                                  one; needs a workflow path, either already
                                  stored or passed here).
                                  public/public_anonymous need confirmation
                                  (interactively, or pass --yes).
  --add-reviewer TEXT             Reviewer to add (member username or user ID).
                                  Repeat for multiple reviewers.
  --remove-reviewer TEXT          Reviewer to remove (member username or user
                                  ID). Repeat for multiple reviewers.
  --clear-reviewers               Remove all assigned reviewers.
  --clear-description             Clear the request description.
  --clear-workflow-path           Clear the workflow path.
  --clear-compute-target          Clear the compute target selection.
  --clear-workflow-snapshot       Clear the workflow snapshot selection.
  --clear-lineage-mode            Clear the lineage publication mode.
  -y, --yes                       Skip the public-lineage confirmation prompt
                                  (for non-interactive use).
  --help                          Show this message and exit.

  Examples:
    treqs tr update <request-id> --title "New title"
    treqs tr update <request-id> --compute-target gpu-box
    treqs tr update <request-id> --clear-workflow-path
    treqs tr update <request-id> --add-reviewer <user>
    treqs tr update <request-id> --remove-reviewer <user>

treqs run

Usage: treqs run [OPTIONS]

  Create, open, queue, and optionally follow a training request.

Options:
  --title TEXT                    Training request title.  [required]
  --description TEXT              Training request description.
  --workflow TEXT                 Committed .treqs workflow path.  [required]
  --target TEXT                   Compute target ID or name.  [required]
  --source-commit TEXT            Immutable Git revision to submit.  [default:
                                  HEAD]
  --lineage [private|public|public_anonymous]
                                  [default: private]
  --follow                        Follow logs and wait for completion.
  --timeout FLOAT RANGE           Maximum seconds to wait when --follow is used.
                                  [default: 7200.0; x>=1.0]
  --yes                           Confirm the compute launch non-interactively.
  --help                          Show this message and exit.

  Examples:
    treqs run --title "Train v2" --workflow .treqs/workflows/train.yaml \
        --compute-target gpu-box
    treqs run --title "Smoke" --workflow .treqs/workflows/train.yaml \
        --compute-target gpu-box --lineage private --follow --yes

treqs compute

Usage: treqs compute [OPTIONS] COMMAND [ARGS]...

  Inspect compute resources for the current TReqs owner.

Options:
  --help  Show this message and exit.

Commands:
  secrets  Manage compute target secrets for the current TReqs owner.
  targets  Inspect compute targets for the current TReqs owner.

treqs compute secrets

Usage: treqs compute secrets [OPTIONS] COMMAND [ARGS]...

  Manage compute target secrets for the current TReqs owner.

Options:
  --help  Show this message and exit.

Commands:
  delete  Delete a secret from a compute target.
  list    List secret names (and metadata) set on a compute target.
  set     Set one or more KEY=VALUE secrets on a compute target.

treqs compute secrets delete

Usage: treqs compute secrets delete [OPTIONS] NAME

  Delete a secret from a compute target.

  NAME is the secret's name, as shown by `treqs compute secrets list`. Any job
  dispatched to this target after deletion will no longer receive this secret as
  an environment variable.

Options:
  --target TEXT  Compute target ID or name.  [required]
  --owner TEXT   Owner username or organization. Defaults to the repo's bound
                 project owner, then your personal owner.
  -y, --yes      Skip the delete confirmation prompt (for non-interactive use).
  --help         Show this message and exit.

  Examples:
    treqs compute secrets delete --target gpu-box HF_TOKEN
    treqs compute secrets delete --target gpu-box --yes HF_TOKEN

treqs compute secrets list

Usage: treqs compute secrets list [OPTIONS]

  List secret names (and metadata) set on a compute target.

  Secret values are never returned by the API and are not shown here.

Options:
  --target TEXT  Compute target ID or name.  [required]
  --owner TEXT   Owner username or organization. Defaults to the repo's bound
                 project owner, then your personal owner.
  --help         Show this message and exit.

  Examples:
    treqs compute secrets list --target gpu-box
    treqs --json compute secrets list --target gpu-box --owner acme

treqs compute secrets set

Usage: treqs compute secrets set [OPTIONS] ASSIGNMENTS...

  Set one or more KEY=VALUE secrets on a compute target.

  ASSIGNMENTS are KEY=VALUE pairs, separated by spaces. --target accepts a
  compute target ID, a unique name, or a unique ID prefix from `treqs compute
  targets list`.

Options:
  --target TEXT  Compute target ID or name.  [required]
  --owner TEXT   Owner username or organization. Defaults to the repo's bound
                 project owner, then your personal owner.
  --help         Show this message and exit.

  Examples:
    treqs compute secrets set --target gpu-box WANDB_API_KEY=abc123
    treqs compute secrets set --target gpu-box --owner acme HF_TOKEN=hf_x REGION=us

treqs compute targets

Usage: treqs compute targets [OPTIONS] COMMAND [ARGS]...

  Inspect compute targets for the current TReqs owner.

Options:
  --help  Show this message and exit.

Commands:
  archive            Archive a compute target.
  create             Create a compute target (dedicated, or on-demand for a...
  instances          List on-demand instances launched for a compute target.
  list               List compute targets for a TReqs owner (or all your...
  registration-code  Manage agent registration codes for compute targets.

treqs compute targets archive

Usage: treqs compute targets archive [OPTIONS] TARGET

  Archive a compute target.

  TARGET is a compute target ID, a unique name, or a unique ID prefix from
  `treqs compute targets list`. Archiving is permanent and cannot be undone: the
  target keeps its existing links and stats, but can no longer be used for new
  runs or have its operational settings changed. Archiving is blocked while the
  target has queued or running jobs.

Options:
  --owner TEXT  Owner username or organization. Defaults to the repo's bound
                project owner, then your personal owner.
  -y, --yes     Skip the archive confirmation prompt (for non-interactive use).
  --help        Show this message and exit.

  Examples:
    treqs compute targets archive gpu-box
    treqs compute targets archive gpu-box --yes

treqs compute targets create

Usage: treqs compute targets create [OPTIONS]

  Create a compute target (dedicated, or on-demand for a provider).

Options:
  --kind [dedicated|on-demand]  Compute target kind.  [default: dedicated]
  --name TEXT                   Compute target name.  [required]
  --type TEXT                   Provider for on-demand targets (runpod, lambda,
                                aws, gcp, azure).
  --instance-type TEXT          Instance type / flavor for on-demand targets
                                (e.g. cpu3c).
  --region TEXT                 Region (or 'any') for on-demand targets.
                                [default: any]
  --ami-id TEXT                 AWS AMI ID (--type aws only; required for AWS
                                launches). Omit in an interactive session with a
                                concrete --region to pick one from a live list.
  --subnet-id TEXT              AWS subnet ID (--type aws only; repeatable). The
                                first is the primary subnet; additional ones are
                                fallback candidates tried on a per-AZ capacity
                                error. Optional - AWS uses the account/VPC
                                default if unset.
  --security-group-id TEXT      AWS security group ID (--type aws only;
                                repeatable, optional).
  --agent-channel TEXT          Agent release channel hosts on this target
                                follow (default: prod). Use 'dev' to run a build
                                before it is promoted.
  --ssh-key-name TEXT           AWS EC2 key pair name to attach to the instance
                                (--type aws only, optional).
  --install-roar                Install roar on the instance at startup via the
                                managed bootstrap (on-demand).
  --roar-ref TEXT               Pin roar to a git ref (branch/tag) built from
                                source instead of the PyPI release (on-demand;
                                requires --install-roar).
  --userdata-script TEXT        Extra shell run at instance startup (on-demand).
  --auto-shutdown               Auto-shut down the instance when idle (on-
                                demand).
  --idle-timeout INTEGER        Idle minutes before auto-shutdown (on-demand).
  --description TEXT            Compute target description.
  --owner TEXT                  Owner username or organization. Defaults to the
                                repo's bound project owner, then your personal
                                owner.
  --help                        Show this message and exit.

  Examples:
    treqs compute targets create --name gpu-box
    treqs compute targets create --name team-gpu --owner acme
    treqs compute targets create --kind on-demand --name burst --type runpod \
        --instance-type cpu3c

treqs compute targets instances

Usage: treqs compute targets instances [OPTIONS] TARGET

  List on-demand instances launched for a compute target.

  TARGET is a compute target ID or name from `treqs compute targets list`.

  DETAIL carries why a launch failed, or why a running instance stopped. A
  failed instance with no detail means the provider gave no reason.

Options:
  --owner TEXT  Owner username or organization. Defaults to the repo's bound
                project owner, then your personal owner.
  --help        Show this message and exit.

  Examples:
    treqs compute targets instances <target>
    treqs --json compute targets instances <target>

treqs compute targets list

Usage: treqs compute targets list [OPTIONS]

  List compute targets for a TReqs owner (or all your owners with --all).

Options:
  --include-agent  Include registered agent details.
  --show-archived  Include archived compute targets (hidden by default).
  --owner TEXT     Owner username or organization. Defaults to the repo's bound
                   project owner, then your personal owner.
  --all            List compute targets across every owner available to you.
  --help           Show this message and exit.

  Examples:
    treqs compute targets list
    treqs compute targets list --owner acme
    treqs compute targets list --all
    treqs compute targets list --show-archived
    treqs --json compute targets list --include-agent

treqs compute targets registration-code

Usage: treqs compute targets registration-code [OPTIONS] COMMAND [ARGS]...

  Manage agent registration codes for compute targets.

Options:
  --help  Show this message and exit.

Commands:
  create  Create an agent registration code for a compute target.

treqs compute targets registration-code create

Usage: treqs compute targets registration-code create [OPTIONS]

  Create an agent registration code for a compute target.

  Prints a one-time code used to register a treqs-agent on the target machine.
  --target accepts a compute target ID, a unique name, or a unique ID prefix
  from `treqs compute targets list`.

Options:
  --target TEXT  Compute target ID or name.  [required]
  --owner TEXT   Owner username or organization. Defaults to the repo's bound
                 project owner, then your personal owner.
  --help         Show this message and exit.

  Examples:
    treqs compute targets registration-code create --target gpu-box
    treqs compute targets registration-code create --target gpu-box --owner acme

treqs jobs

Usage: treqs jobs [OPTIONS] COMMAND [ARGS]...

  Inspect jobs for the current TReqs project.

  All jobs commands are repo-bound: run them inside a git repo bound to a
  project with `treqs project use`. Jobs are created by queueing training
  requests (`treqs tr queue`).

Options:
  --help  Show this message and exit.

Commands:
  list               List jobs for the repo-local project context.
  logs               Print logs for a job, optionally following until...
  republish-lineage  Re-publish a job's stored lineage package to GLaaS.
  show               Show one job from the repo-local project context.
  stop               Stop a queued or running job.
  tasks              Show each task of a job with its status and exit code.
  wait               Wait for a job to complete, fail, or be cancelled.
  watch              Stream lifecycle status and workload logs until a job...

treqs jobs cancel

Usage: treqs jobs cancel [OPTIONS] JOB_ID

  Deprecated alias for `treqs jobs stop`.

  JOB_ID is the job ID shown by `treqs jobs list` or printed by `treqs tr
  queue`.

Options:
  --target TEXT  Compute target ID or name. Defaults to the job's target.
  --help         Show this message and exit.

  Examples:
    treqs jobs cancel <job-id>
    treqs jobs cancel <job-id> --target gpu-box

treqs jobs list

Usage: treqs jobs list [OPTIONS]

  List jobs for the repo-local project context.

Options:
  --status [QUEUED|ASSIGNED|ACQUIRED|IN_PROGRESS|COMPLETED|FAILED|CANCELLED]
                                  Filter by status. Repeat to include multiple
                                  statuses.
  --limit INTEGER RANGE           [default: 20; 1<=x<=100]
  --help                          Show this message and exit.

  Examples:
    treqs jobs list
    treqs jobs list --status RUNNING --status QUEUED
    treqs --json jobs list --limit 50

treqs jobs logs

Usage: treqs jobs logs [OPTIONS] JOB_ID

  Print logs for a job, optionally following until complete.

  JOB_ID is the job ID shown by `treqs jobs list` or printed by `treqs tr
  queue`.

  A job's log has more than one producer. By default this prints the workload's
  own output. `--agent` prints what the agent recorded about the job instead,
  which is where a task that fails before its command runs explains itself.
  `--task` narrows the workload output to one step.

Options:
  --target TEXT                   Compute target ID or name. Defaults to the
                                  job's target.
  --follow                        Keep polling until the job's logs are
                                  complete.
  --agent                         Show the agent's own log instead of the
                                  workload's output.
  --task TEXT                     Show only the output of one task. Takes a task
                                  ID from `treqs jobs tasks`.
  --poll-timeout-ms INTEGER RANGE
                                  Server-side long-poll timeout per request, in
                                  milliseconds.  [default: 30000;
                                  1000<=x<=60000]
  --help                          Show this message and exit.

  Examples:
    treqs jobs logs <job-id>
    treqs jobs logs <job-id> --follow
    treqs jobs logs <job-id> --agent
    treqs jobs logs <job-id> --task <task-id>

treqs jobs republish-lineage

Usage: treqs jobs republish-lineage [OPTIONS] JOB_ID

  Re-publish a job's stored lineage package to GLaaS.

  JOB_ID is the job ID shown by `treqs jobs list`. Recovers a lineage
  publication that failed transiently (for example a GLaaS outage) from the
  package stored at upload time — no need to re-run training.

Options:
  --help  Show this message and exit.

  Examples:
    treqs jobs republish-lineage <job-id>

treqs jobs show

Usage: treqs jobs show [OPTIONS] JOB_ID

  Show one job from the repo-local project context.

  JOB_ID is the job ID shown by `treqs jobs list` or printed by `treqs tr
  queue`.

Options:
  --help  Show this message and exit.

  Examples:
    treqs jobs show <job-id>
    treqs --json jobs show <job-id>

treqs jobs stop

Usage: treqs jobs stop [OPTIONS] JOB_ID

  Stop a queued or running job.

  JOB_ID is the job ID shown by `treqs jobs list` or printed by `treqs tr
  queue`. Only QUEUED/ASSIGNED/ACQUIRED/IN_PROGRESS jobs can be stopped;
  stopping an already-stopped job is a no-op.

Options:
  --target TEXT  Compute target ID or name. Defaults to the job's target.
  --help         Show this message and exit.

  Examples:
    treqs jobs stop <job-id>
    treqs jobs stop <job-id> --target gpu-box

treqs jobs tasks

Usage: treqs jobs tasks [OPTIONS] JOB_ID

  Show each task of a job with its status and exit code.

  JOB_ID is the job ID shown by `treqs jobs list` or printed by `treqs tr
  queue`.

  An empty EXIT column means no exit code was recorded, which is different from
  exit 0 — most often a task that never launched.

Options:
  --target TEXT  Compute target ID or name. Defaults to the job's target.
  --help         Show this message and exit.

  Examples:
    treqs jobs tasks <job-id>
    treqs jobs tasks <job-id> --target gpu-box
    treqs --json jobs tasks <job-id>

treqs jobs wait

Usage: treqs jobs wait [OPTIONS] JOB_ID

  Wait for a job to complete, fail, or be cancelled.

  JOB_ID is the job ID shown by `treqs jobs list` or printed by `treqs tr
  queue`. Exits non-zero unless the job reaches COMPLETED.

Options:
  --timeout FLOAT RANGE        Maximum seconds to wait for a terminal job state.
                               [default: 7200.0; x>=1.0]
  --poll-interval FLOAT RANGE  Seconds between job status requests.  [default:
                               5.0; x>=0.1]
  --help                       Show this message and exit.

  Examples:
    treqs jobs wait <job-id>
    treqs jobs wait <job-id> --timeout 3600

treqs jobs watch

Usage: treqs jobs watch [OPTIONS] JOB_ID

  Stream lifecycle status and workload logs until a job finishes.

  JOB_ID is the job ID shown by `treqs jobs list` or printed by `treqs tr
  queue`.

  Lifecycle updates are written to stderr. Workload logs remain on stdout.
  Ctrl-C detaches without cancelling the job.

Options:
  --timeout FLOAT RANGE           Maximum seconds to watch before detaching.
                                  [default: 7200.0; x>=1.0]
  --poll-timeout-ms INTEGER RANGE
                                  Server-side lifecycle long-poll timeout per
                                  request.  [default: 2000; 1000<=x<=30000]
  --help                          Show this message and exit.

  Examples:
    treqs jobs watch <job-id>
    treqs jobs watch <job-id> --timeout 3600
    treqs --json jobs watch <job-id>

treqs logout

Usage: treqs logout [OPTIONS]

  Clear local TReqs auth state and revoke the session when possible.

Options:
  --help  Show this message and exit.

  Examples:
    treqs logout