Skip to content

Commit

Permalink
data status: update remote flags (#4517)
Browse files Browse the repository at this point in the history
  • Loading branch information
Dave Berenbaum authored May 6, 2023
1 parent 5d9d300 commit 7854ea2
Showing 1 changed file with 30 additions and 8 deletions.
38 changes: 30 additions & 8 deletions content/docs/command-reference/data/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ For the status of <abbr>data pipelines</abbr>, see `dvc status`.
usage: dvc data status [-h] [-q | -v]
[--granular] [--unchanged]
[--untracked-files [{no,all}]]
[--json] [--remote-refresh]
[--json]
[--not-in-remote] [--no-remote-refresh]
```

## Description
Expand Down Expand Up @@ -63,8 +64,7 @@ DVC uncommitted changes:
- _Not in remote_ indicates that there are file hashes in `.dvc` or `dvc.lock`
files, but the corresponding <abbr>remote</abbr> files are missing. This may
happen after adding new files into dvc but before using `dvc push` to upload
the data; or after using `dvc gc -c`; or if index for remote is out-of-date,
in which case you should use `--remote-refresh` flag to refresh it.
the data; or after using `dvc gc -c`.

- _DVC committed changes_ are new, modified, or deleted tracked files or
directories that have been [committed to DVC]. These may be ready for
Expand Down Expand Up @@ -97,7 +97,10 @@ default but this can be enabled with the `--granular` flag.

- `--unchanged` - show unchanged DVC-tracked files.

- `--remote-refresh` - refresh remote index.
- `--not-in-remote` - show files that are missing from the <abbr>remote</abbr>.

- `--no-remote-refresh` - use cached <abbr>remote</abbr> index (don't check
remote). Only has an effect along with `--not-in-remote`.

- `--json` - prints the command's output in easily parsable JSON format, instead
of a human-readable output.
Expand Down Expand Up @@ -142,10 +145,6 @@ Not in cache:
(use "dvc fetch <file>..." to download files)
data/data.xml
Not in remote:
(use "dvc push <file>..." to upload files)
data/data.xml
DVC committed changes:
(git commit the corresponding dvc files to update the repo)
modified: data/features/
Expand Down Expand Up @@ -198,3 +197,26 @@ DVC uncommitted changes:
Now there's more information in _DVC committed changes_ regarding the changes in
`data/features`. From the output, it shows that there is a new file added to
`data/features`: `data/features/foo`.

## Example: Remote status

```cli
$ dvc data status --not-in-remote
Not in cache:
(use "dvc fetch <file>..." to download files)
data/data.xml
Not in remote:
(use "dvc push <file>..." to upload files)
data/data.xml
DVC committed changes:
(git commit the corresponding dvc files to update the repo)
modified: data/features/
DVC uncommitted changes:
(use "dvc commit <file>..." to track changes)
(use "dvc checkout <file>..." to discard changes)
deleted: model.pkl
(there are other changes not tracked by dvc, use "git status" to see)
```

0 comments on commit 7854ea2

Please sign in to comment.