Compare commits

...

2 Commits

Author SHA1 Message Date
Thom Dickson 789b5fb6b9
Update help message 2021-12-21 13:10:17 -05:00
Thom Dickson bc68bba7fb
Update README.md 2021-12-21 13:09:58 -05:00
2 changed files with 28 additions and 1 deletions

View File

@ -7,3 +7,29 @@ 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](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
```

View File

@ -235,6 +235,7 @@ General
Manage Repositories
add Add another git repo to keep track of
fetch Update currently tracked repos"
fetch Update currently tracked repos
list list out the currently tracked repos"
)
}