guild_merge_cli {guildai} | R Documentation |
guild_merge_cli Copy run files to a project directory.
Description
By default, Guild copies run files into the current directory. To
copy files to a different directory, use target_dir DIR
.
Usage
guild_merge_cli(
...,
filter = NULL,
operation = NULL,
label = NULL,
unlabeled = NA,
tag = NULL,
comment = NULL,
marked = NA,
unmarked = NA,
started = NULL,
digest = NULL,
running = NA,
completed = NA,
error = NA,
terminated = NA,
pending = NA,
staged = NA,
target_dir = NULL,
sourcecode = NA,
all = NA,
skip_sourcecode = NA,
skip_deps = NA,
exclude = NULL,
no_summary = NA,
summary_name = NULL,
preview = NA,
replace = NA,
no_replace = NA
)
Arguments
... |
passed on to the |
filter |
Filter runs using a filter expression. See Filter by Expression above for details. |
operation |
Filter runs with operations matching |
label |
Filter runs with labels matching VAL. To show unlabeled runs, use |
unlabeled |
(bool) Filter runs without labels. |
tag |
Filter runs with TAG. |
comment |
Filter runs with comments matching VAL. |
marked |
(bool) Filter marked runs. |
unmarked |
(bool) Filter unmarked runs. |
started |
Filter runs started within RANGE. See above for valid time ranges. |
digest |
Filter runs with a matching source code digest. |
running |
(bool) Filter runs that are still running. |
completed |
(bool) Filter completed runs. |
error |
(bool) Filter runs that exited with an error. |
terminated |
(bool) Filter runs terminated by the user. |
pending |
(bool) Filter pending runs. |
staged |
(bool) Filter staged runs. |
target_dir |
Directory to merge run files to (required if project directory cannot be determined for the run). |
sourcecode |
(bool) Only copy run source code. Implies use of |
all |
(bool) Copy all run files. May be used with |
skip_sourcecode |
(bool) Don't copy run source code. |
skip_deps |
(bool) Don't copy project-local dependencies. |
exclude |
Exclude a file or pattern (may be used multiple times). |
no_summary |
(bool) Don't generate a run summary. |
summary_name |
Name used for the run summary. Use '$run_id' in the name to include the run ID. |
preview |
(bool) Show what would happen on a merge. |
replace |
(bool) Allow replacement of existing files. Cannot be used with |
no_replace |
(bool) Fail if any target file would be replaced, even if that file is committed to the project VCS. Cannot be used with |
Details
Guild checks that the run originated from the current directory
before copying files. If the run is associated with a project from
a different directory, or is from a package, Guild exits with an
error message. In this case, use target_dir
to override the
check with an explicit path.
The command fails if any file would be replaced, unless a) the
replace
option is specified or b) the replaced file is
committed to the project VCS and unchanged. To prevent replacement
even when a file is committed to VCS and unchanged, specify
no_replace
.