Skip to content

TLDR for DVC [https://github.com/tldr-pages/tldr] #4194

@PuneethaPai

Description

@PuneethaPai

Can we think of creating TLDR for dvc and all it's sub commands??

TLDR cmd:
Given a command tldr gives list of it's comman usage pattern to get started quick.

For example: GIT which is closest to dvc:

~ tldr git

git

Distributed version control system.
More information: <https://git-scm.com/>.

- Check the Git version:
    git --version

- Call general help:
    git --help

- Call help on a command:
    git help command

- Execute Git command:
    git command
 ~ tldr git pull

git pull

Fetch branch from a remote repository and merge it to local repository.
More information: <https://git-scm.com/docs/git-pull>.

- Download changes from default remote repository and merge it:
    git pull

- Download changes from default remote repository and use fast forward:
    git pull --rebase

- Download changes from given remote repository and branch, then merge them into HEAD:
    git pull remote_name branch
~ tldr git add

git add

Adds changed files to the index.
More information: <https://git-scm.com/docs/git-add>.

- Add a file to the index:
    git add path/to/file

- Add all files (tracked and untracked):
    git add -A

- Only add already tracked files:
    git add -u

- Also add ignored files:
    git add -f

- Interactively stage parts of files:
    git add -p

- Interactively stage parts of a given file:
    git add -p path/to/file

- Interactively stage a file:
    git add -i

Metadata

Metadata

Assignees

No one assigned

    Labels

    feature requestRequesting a new featurep3-nice-to-haveIt should be done this or next sprint

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions