ref: example for `list .` (local repo as target)

[BurnzZ]

The current examples in https://dvc.org/doc/command-reference/list only show how to view the contents of a tracked Git repository.

I think it's also worth denoting examples of how to view remote storages, like:

$ ls *.dvc
data.dvc

$ dvc list . data/some/dirs
data_1.csv
data_2.csv
data_3.csv

[efiop]

@BurnzZ Just a note that this is not really viewing remote storage. The fact that .dir cache file might be on remote storage is an implementation detail. data.dvc is local, so we are viewing local project, which that data dir is a mere part of.

[jorgeorpinel]

Yep. Since remote storage doesn't play in dvc list, I'm changing the title of this issue for now.

@BurnzZ can you confirm that what you suggest is an example of dvc list . (listing something in the local project)?

I guess that could be useful to show as a short example, although it's kind of an edge case (most of the times you just use ls locally and see both Git-tracked and DVC-tracked files/dirs). Thanks

[jorgeorpinel]

For now I've mentioned . as a local path url example in the description of list, get, and import (see #1982).

[BurnzZ]

Hi @jorgeorpinel ,

can you confirm that what you suggest is an example of dvc list . (listing something in the local project)?

Yes it is, for viewing the local project.

[jorgeorpinel]

Reopening per #1982 (comment). Ideas for the example:

Before you do a partial pull for example. Or listing a specific revision