nomctl run

Run management commands

Usage: nomctl run <COMMAND>

Commands:
  list            List all runs
  search          Search runs by substring, label, and/or property. Multiple filters are AND-ed together
  get             Get a specific run by RID
  create          Create a new run
  add-dataset     Attach a dataset to a run under a ref name
  add-video       Attach a video to a run under a ref name
  add-connection  Attach a connection to a run under a ref name
  update          Update run metadata
  archive         Archive a run
  unarchive       Unarchive a run
  help            Print this message or the help of the given subcommand(s)

Options:
  -h, --help
          Print help

nomctl run list

List all runs

Usage: nomctl run list

Options:
  -h, --help
          Print help

nomctl run search

Search runs by substring, label, and/or property. Multiple filters are AND-ed together

Usage: nomctl run search [OPTIONS]

Options:
  -s, --substring <SUBSTR>
          Case-insensitive substring match against the run name. Repeatable

  -l, --label <LABEL>
          Filter by label. Repeatable

  -p, --property <KEY> <VALUE>
          Filter by property KEY VALUE pair. Repeatable

  -h, --help
          Print help

nomctl run get

Get a specific run by RID

Usage: nomctl run get <RID>

Arguments:
  <RID>
          The RID of the run to retrieve

Options:
  -h, --help
          Print help

nomctl run create

Create a new run

Usage: nomctl run create [OPTIONS] --name <NAME> --start <RFC3339>

Options:
  -n, --name <NAME>
          The run name

  -s, --start <RFC3339>
          RFC3339 timestamp when the run started

  -e, --end <RFC3339>
          RFC3339 timestamp when the run ended

  -d, --description <DESCRIPTION>
          Set the run description

  -l, --label <LABEL>
          Add labels. Repeatable

  -p, --property <KEY> <VALUE>
          Add properties as KEY VALUE pairs. Repeatable

  -a, --asset <RID>
          Associate the run with one or more assets by RID. Repeatable

  -h, --help
          Print help

nomctl run add-dataset

Attach a dataset to a run under a ref name

Usage: nomctl run add-dataset <RID> <NAME> <DATASET_RID>

Arguments:
  <RID>
          The RID of the run

  <NAME>
          Ref name for the dataset within the run

  <DATASET_RID>
          The RID of the dataset to attach

Options:
  -h, --help
          Print help

nomctl run add-video

Attach a video to a run under a ref name

Usage: nomctl run add-video <RID> <NAME> <VIDEO_RID>

Arguments:
  <RID>
          The RID of the run

  <NAME>
          Ref name for the video within the run

  <VIDEO_RID>
          The RID of the video to attach

Options:
  -h, --help
          Print help

nomctl run add-connection

Attach a connection to a run under a ref name

Usage: nomctl run add-connection <RID> <NAME> <CONNECTION_RID>

Arguments:
  <RID>
          The RID of the run

  <NAME>
          Ref name for the connection within the run

  <CONNECTION_RID>
          The RID of the connection to attach

Options:
  -h, --help
          Print help

nomctl run update

Update run metadata

Usage: nomctl run update [OPTIONS] <RID>

Arguments:
  <RID>
          The RID of the run to update

Options:
  -n, --name <NAME>
          Set the run name

  -d, --description <DESCRIPTION>
          Set the run description

  -l, --label <LABEL>
          Replace all labels. Repeatable. Omit to leave labels unchanged

      --clear-labels
          Clear all labels

  -p, --property <KEY> <VALUE>
          Replace all properties as KEY VALUE pairs. Repeatable. Omit to leave properties unchanged

      --clear-properties
          Clear all properties

  -h, --help
          Print help

nomctl run archive

Archive a run

Usage: nomctl run archive <RID>

Arguments:
  <RID>
          The RID of the run to archive

Options:
  -h, --help
          Print help

nomctl run unarchive

Unarchive a run

Usage: nomctl run unarchive <RID>

Arguments:
  <RID>
          The RID of the run to unarchive

Options:
  -h, --help
          Print help