guild comment [OPTIONS] [RUN...]
Add or remove run comments.
By default Guild opens the default text editor to add a new comment to the specified runs.
To list runs, use
To add a comment without using an editor, use
To delete a comment, use
--delete with the comment index shown using
To delete all comments associated with specified runs, use
You may use one or more
RUN arguments to indicate which runs apply to the command.
RUN may be a run ID, a run ID prefix, or a one-based index corresponding to a run returned by the list command.
Indexes may also be specified in ranges in the form
START is the start index and
END is the end index. Either
END may be omitted. If
START is omitted, all runs up to
END are selected. If
END id omitted, all runs from
START on are selected. If both
END are omitted (i.e. the
: char is used by itself) all runs are selected.
RUN argument is not specified,
1 is assumed (the most recent run).
Filter by Operation
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.
--operation multiple times to include more runs.
Filter by Label
--label to only include runs with labels containing a specified value. To select runs that do not contain a label, specify a dash ‘-’ for
--label multiple times to include more runs.
Filter by Tag
--tag to only include runs with a specified tag. Tags must match completely and are case sensitive.
--tag multiple times to include more runs.
Filter by Marked and Unmarked
--marked to only include marked runs.
--unmarked to only include unmarked runs. This option may not be used with
Filter by Run Start Time
--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:
--started 'last hour'
You can specify a time range using several different forms:
between DATETIME and DATETIME
last N minutes|hours|days
N days|weeks|months|years ago
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
between DATETIME and DATETIME, values for
DATETIME may be specified in either order.
When specifying values like
hours the trailing
s may be omitted to improve readability. You may also use
min instead of
hr instead of
between 1-1 and 4-30
between 10:00 and 15:00
last 30 min
last 6 hours
3 weeks ago
Filter by Source Code Digest
To show runs for a specific source code digest, use
--digest with a complete or partial digest value.
Filter by Run Status
Runs may also be filtered by specifying one or more status filters:
--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
You may combine more than one status character with
-S to expand the filter. For example,
-Set shows only runs with terminated or error status.
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.
Comment Remote Runs
To apply the comment command to remote runs, use
--remote. When using
--remote you must explicitly provide comments when adding using
-a, --add. The
--edit option is not supported with
REMOTE is the name of a configured remote. Use
guild remotes to list available remotes.
For information on configuring remotes, see
||List comments for specified runs.|
||Add comment to specified runs.|
||Use an editor to type a comment. Enabled by default if COMMENT is not specified using --add.|
||Delete comment at INDEX from specified runs. Use
||Clear all comments associated with specified runs.|
||User associated with new comments. May include host as USER@HOST. By default the current user is used.|
||Filter runs with operations matching
||Filter runs with labels matching VAL.|
||Filter only runs without labels (deprecated - use ‘-Fl -’).|
||Filter runs with TAG.|
||Filter runs with comments matching VAL.|
||Filter only marked runs.|
||Filter only unmarked runs.|
||Filter only runs started within RANGE. See above for valid time ranges.|
||Filter only runs with a matching source code digest.|
||Filter only runs that are still running.|
||Filter only completed runs.|
||Filter only runs that exited with an error.|
||Filter only runs terminated by the user.|
||Filter only pending runs.|
||Filter only staged runs.|
||Apply comments to remote runs.|
||Do not prompt before modifying comments.|
||Show this message and exit.|
Guild AI version 0.7.3