Go to file
Thom Dickson 13b5d679e6
Update README and help message
2021-12-21 20:41:39 -05:00
src Update README and help message 2021-12-21 20:41:39 -05:00
.gitignore Add basic command line boilerplate and arg parsing 2021-12-16 03:13:59 -05:00
Cargo.lock Add basic command line boilerplate and arg parsing 2021-12-16 03:13:59 -05:00
Cargo.toml Add basic command line boilerplate and arg parsing 2021-12-16 03:13:59 -05:00
README.md Update README and help message 2021-12-21 20:41:39 -05:00

README.md

Shepherd

Shepherd is a git repository manager. This arises out of the personal need to work with a collection of ever-changing git repositories, on more than one machine.

The goal is to have a single "repositories" file that can be synced across devices. Shepherd would take this file, allow for syncing repository configurations and bulk operations (fetch, unified log, etc).

Building

  1. Grab the source from git.nixnet.services/boots/shepherd.
  2. Build using cargo build --release

Basic Usage

The help message can be displayed by running shepherd --help.

The default path to the configuration file is ~/config/shepherd/config.toml; however, a different location can be specified with the --config flag.

If a category is specified when adding a repository, it will show up in a folder under your root source_dir folder, which can be set in your config.toml.

To add a repository to shepherd:

shepherd add [--category | -c <category>] <name> <git-url>

To list out currently tracked repositories:

shepherd list

To clone and update all tracked repositories:

shepherd fetch