Skip to content

User Guide

Set up and check your connection

Install the CLI, then initialize its configuration. Use doctor to check your configuration, Datatrail server health, CANFAR certificate, and authentication to Minoc and Luskan before working with files. The config reference covers inspecting and editing configuration values.

Find and inspect datasets

Start with Recursive discovery for a walkthrough of --match, --expand, and --recursive, followed by a resumable inventory and download.

  • list / ls: Browse scopes and datasets. Use --match to narrow a search, --expand to see one level of children, and --recursive to follow descendants to terminal datasets.
  • ps: Inspect a dataset's files and storage locations, including per-storage-element common paths in JSON output.
  • inventory: Save recursive discovery and file replica URIs in a JSON manifest that can be resumed after an interruption.

Download and check files

For a large collection, use inventory to save the discovered files, then pass that manifest to pull-manifest to download them with resumable progress.

  • pull: Download the files in a dataset.
  • pull-manifest: Download Minoc files from an inventory with saved transfer progress and bounded concurrency.
  • verify: Compare registered Minoc files with Minoc and Luskan metadata to identify missing files, size or checksum mismatches, and unavailable metadata.
  • clear: Remove a dataset's local or CANFAR files.

Investigate registration problems

  • scout: Compare registered and observed file counts and review discrepancies before confirming repairs.
  • unregistered: Summarize registration failures or inspect records for a specific event, with optional scope and partial-name filters.

Use results in scripts

list, ps, doctor, verify, and unregistered search support --json. Their guides explain each output format. inventory writes a JSON manifest, while pull-manifest saves a separate JSON transfer-state file. Consult the relevant command's guide for exit status and error handling.

The command overview links to every command, including version. The CLI reference lists all arguments and options.