40 lines
1.3 KiB
Markdown
40 lines
1.3 KiB
Markdown
|
# Git repositories manager
|
||
|
|
|
||
|
|
Sync your repositories with single click
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Create a yaml file with the given structure
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
# Place where your repositories should be saved
|
||
|
|
workspace: ${HOME}/workspace
|
||
|
|
# List with repositories, that you want to manage with GRM
|
||
|
|
repositories:
|
||
|
|
- src: "git@github.com:Revalus/GitRepositoryManager.git"
|
||
|
|
name: GRM # Optional, Uniq - if no name is specified, the repository will be treated as a name
|
||
|
|
dest: manager # Optional, Uniq - if no value is specified, name will be taken as destination
|
||
|
|
```
|
||
|
|
|
||
|
|
### Note
|
||
|
|
|
||
|
|
By default, the config file is searched for in `[HOME_DIR]./config/grm/config.yaml`.
|
||
|
|
|
||
|
|
## Commands and arguments
|
||
|
|
|
||
|
|
### Global args
|
||
|
|
|
||
|
|
| argument | type | default | Description |
|
||
|
|
|-------------------|--------|--------------------------------------|----------------------------------------------------------------------|
|
||
|
|
| -c, --config-file | string | `[HOME_DIR]./config/grm/config.yaml` | Path to configuration file, where the repositories must be specified |
|
||
|
|
|
||
|
|
### Commands
|
||
|
|
|
||
|
|
| command | Description |
|
||
|
|
|---------|-------------|
|
||
|
|
| sync | Fetches changes from repositories or pulls a repository if one does not exist.
|
||
|
|
|
||
|
|
## Changelog
|
||
|
|
|
||
|
|
0.1 Add sync command - allow to fetch and clone repositories
|