boots
/
shepherd
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Thom Dickson 2021-12-21 13:09:58 -05:00
parent 9da42c44c3
commit bc68bba7fb
Signed by: boots
GPG Key ID: 40BE2AF8EBF8D2BB
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -7,3 +7,29 @@ machine.
The goal is to have a _single_ "repositories" file that can be synced The goal is to have a _single_ "repositories" file that can be synced
across devices. Shepherd would take this file, allow for syncing repository across devices. Shepherd would take this file, allow for syncing repository
configurations and bulk operations (fetch, unified log, etc). configurations and bulk operations (fetch, unified log, etc).
## Building
1. Grab the source from [git.nixnet.services/boots/shepherd](https://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.
To add a repository to shepherd:
```
shepherd add <name> <git-url>
```
To list out currently tracked repositories:
```
shepherd list
```
To clone and update all tracked repositories:
```
shepherd fetch
```