Command: ls

guildai · July 30, 2020, 7:29pm

Usage

guild ls [OPTIONS] [RUN]

List run files.

--path may be specified as a relative path pattern to limit results within the run directory to matching files.

--source limits the results to run source files. If --path is specified with --source, the path pattern limits results within the source directory rather than the run directory.

Specify a Run

You may specify a run using a run ID, a run ID prefix, or a one-based index corresponding to a run returned by the list command.

If RUN isn’t specified, the latest run is selected.

Filter by Operation or Label

Runs may be filtered by operation using --operation. A run is only included if any part of its full operation name, including the package and model name, matches the value.

Use --label to only include runs with labels matching a specified value.

--operation and --label may be used multiple times to expand the runs that are included.

Use --unlabeled to only include runs without labels. This option may not be used with --label.

Use --marked to only include marked runs.

Filter by Run Status

Runs may also be filtered by specifying one or more status filters: --running, --completed, --error, and --terminated. These may be used together to include runs that match any of the filters. For example to only include runs that were either terminated or exited with an error, use --terminated --error, or the short form -ET.

Status filters are applied before RUN indexes are resolved. For example, a run index of 1 is the latest run that matches the status filters.

Filter by Run Start Time

Use --started to limit runs to those that have started within a specified time range.

IMPORTANT: You must quote RANGE values that contain spaces. For example, to filter runs started within the last hour, use the option:

--selected 'last hour'

You can specify a time range using several different forms:

DATETIME may be specified as a date in the format YY-MM-DD (the leading YY- may be omitted) or as a time in the format HH:MM (24 hour clock). A date and time may be specified together as DATE TIME.

When using between DATETIME and DATETIME, values for DATETIME may be specified in either order.

When specifying values like minutes and hours the training s may be omitted to improve readability. You may also use min instead of minutes and hr instead of hours.

Examples:

after 7-1
after 9:00
between 1-1 and 4-30
between 10:00 and 15:00
last 30 min
last 6 hours
today
this week
last month
3 weeks ago

Filter by Source Code Digest

To show runs for a specific source code digest, use -g or --digest with a complete or partial digest value.

Remote Runs

Use --remote to list files for a remote run.

REMOTE is the name of a configured remote. Use guild remotes to list available remotes.

For information on configuring remotes, see guild remotes.

Options


`-p, --path PATH`	Path to list.
`-s, --sourcecode`	List source code files.
`-a, --all`	Show all files including Guild files.
`-f, --full-path`	Show full path for files.
`-L, --follow-links`	Follow links.
`-n, --no-format`	Show files without additional formatting.
`-o, --operation VAL`	Filter runs with operations matching `VAL`.
`-l, --label VAL`	Filter runs with labels matching `VAL`.
`-U, --unlabeled`	Filter only runs without labels.
`-M, --marked`	Filter only marked runs.
`-N, --unmarked`	Filter only unmarked runs.
`-R, --running`	Filter only runs that are still running.
`-C, --completed`	Filter only completed runs.
`-E, --error`	Filter only runs that exited with an error.
`-T, --terminated`	Filter only runs terminated by the user.
`-P, --pending`	Filter only pending runs.
`-G, --staged`	Filter only staged runs.
`-S, --started RANGE`	Filter only runs started within RANGE. See above for valid time ranges.
`-D, --digest VAL`	Filter only runs with a matching source code digest.
`-r, --remote REMOTE`	List files for for remote run.
`--help`	Show this message and exit.

Guild AI version 0.7.0.post1