Authors
Kevin T. Chu <kevin@velexi.com>
FastDS is a CLI tool that provides simple commands for several
common Git+DVC workflows. Using fds commands (instead of the equivalent Git
and DVC commands) reduces the likelihood of errors when managing code and data
versions (and saves typing).
Display status of the Git and DVC repositories.
$ fds status
Add files or folders to the Git and DVC repositories. FastDS automatically detects large files and ask whether they should be added to DVC.
$ fds add PATH
Note. To add small data files to DVC, you must use dvc instead of fds.
Otherwise, the small data files will be added to the Git repository, not the
DVC repository.
$ dvc add PATH/TO/SMALL/DATA
Commit staged changes to the Git and DVC repositories.
$ fds commit COMMIT_MESSAGE
where COMMIT_MESSAGE is the commit message to use when committing the
changes to Git.
Push commits to the remote Git and DVC repositories.
$ fds push
Add, commit, and push all project files in the current directory (including untracked files).
$ fds save COMMIT_MESSAGE
where COMMIT_MESSAGE is the commit message to use when committing the
changes to Git.
Note. fds save is equivalent to
$ fds add .
$ fds commit -m COMMIT_MESSAGE
$ fds push
Get the code and data for a project.
$ fds clone GIT_REPO_URL
where GIT_REPO_URL is the URL of the project’s remote Git repository.
Note. fds clone GIT_REPO_URL is equivalent to
$ git clone GIT_REPO_URL
$ cd PROJECT_DIR
$ dvc pull