diff --git a/content/docs/command-reference/run.md b/content/docs/command-reference/run.md index 8eb6714f81..a4cdc5e0fb 100644 --- a/content/docs/command-reference/run.md +++ b/content/docs/command-reference/run.md @@ -5,6 +5,8 @@ command. ## Synopsis +# TODO logs + ```usage usage: dvc run [-h] [-q | -v] -n [-d ] [-o ] [-O ] [-p [:]] [-m ] @@ -221,6 +223,22 @@ $ dvc run -n my_stage './my_script.sh $MYENVVAR' up to the user to manage them separately. See also the difference between `-o` and `-O`. +- `--logs ` - specify a directory that will contain `dvclive` logs (#TODO + link) compatible structure: + + ``` + ├── history + │ ├── m1.tsv + │ └── m2.tsv + └── latest.json + ``` + + It is a convinience option that tells dvc that under `/history` are + plots, and under `/latest.json` are metrics logged by `dvclive`. + +- `logs-no-cache ` - the same as `--logs` except that DVC does not track + the files. + - `-w `, `--wdir ` - specifies a working directory for the `command` to run in (uses the `wdir` field in `dvc.yaml`). Dependency and output files (including metrics and plots) should be specified relative to this directory.