api: add list command#967
Conversation
| @@ -0,0 +1,40 @@ | |||
| # list | |||
|
|
|||
| List file structure of a repo including <abbr>data artifacts</abbr> | |||
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
dvc list can list simple folder (without .git), shouldn't it be pointed
There was a problem hiding this comment.
I would mention it in the description - that's what it is for - to elaborate and expand
|
|
||
| ## Description | ||
|
|
||
| The command list files and <abbr>data artifacts</abbr> into pointed repo. |
There was a problem hiding this comment.
need to expand and elaborate here. No need to repeat just the same phrase we used to above. Even http://man7.org/linux/man-pages/man1/ls.1.html has something meaningful and non-repetitive here.
Would be great to expand on the fact that we show actual data behind DVC-files. That it can be used before dvc get to see that file name to path (which is not easy with Github), etc.
|
|
||
| - `--outputs-only` - Show only <abbr>data artifacts</abbr>. | ||
|
|
||
| - `-R`, `--recursive` - Recursively traverse the repo. |
There was a problem hiding this comment.
the repo -> the target? actually it's is the path (that's why I don't like the target name for the CLI argument)
There was a problem hiding this comment.
check the aws s3 ls and ls man pages. traverse is not the right verb here ... print, list, etc are better
There was a problem hiding this comment.
Agree. If target can only be a directory path, why not call it path or dir? (Also commenting in /pull/967)
shcheklein
left a comment
shcheklein
left a comment
There was a problem hiding this comment.
@JIoJIaJIu good stuff, see some comments please!
|
Please let us know when treeverse/dvc/pull/3246 is merged to check this doc vs the final behavior of the command 🙂 |
|
@shcheklein @jorgeorpinel Could you take a look please on the PR |
shcheklein
left a comment
shcheklein
left a comment
There was a problem hiding this comment.
looks good to me! I think we can take if from here @jorgeorpinel ?
|
|
||
| - `--outputs-only` - Show only <abbr>data artifacts</abbr>. | ||
|
|
||
| - `-R`, `--recursive` - Recursively traverse the repo. |
There was a problem hiding this comment.
Agree. If target can only be a directory path, why not call it path or dir? (Also commenting in /pull/967)
There was a problem hiding this comment.
Sure @shcheklein, let's.
Some first basic comments on this for now (above) ^
|
@JIoJIaJIu any chance you could move this to a regular branch in this repo though? If not, it's OK. Please check out https://github.com/iterative/dvc.org/wiki/2.-dvc.org-pull-requests-for-core-repo-changes for future ref. 🙂 |
I've create a new PR - #1021 and close this one
I suggest to apply my current PR and in the next iteration I will rename |
|
Thanks Guro!
Yep no rush, it's included in treeverse/dvc/issues/3381 actually so it should be addressed whenever someone takes that issue. |
4 participants
Relates:
❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.
🐛 Please make sure to mention
Fix #issue(if applicable) in the description of the PR. This enables GitHub to link the PR to the corresponding bug and close it automatically when PR is merged.Thank you for the contribution - we'll try to review and merge it as soon as possible. 🙏