This commit is contained in:
parent
30c65042dd
commit
d291489247
39
README.md
39
README.md
@ -8,6 +8,36 @@ and shortcuts.
|
|||||||
|
|
||||||
This supports GitHub, GitLab, and Gitea remotes.
|
This supports GitHub, GitLab, and Gitea remotes.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Install git-project-manager using `go`:
|
||||||
|
`go install -v gitea.libretechconsulting.com/rmcguire/git-project-manager@latest`
|
||||||
|
|
||||||
|
OR Download a pre-built binary:
|
||||||
|
[https://gitea.libretechconsulting.com/rmcguire/-/packages/generic/git-project-manager](https://gitea.libretechconsulting.com/rmcguire/-/packages/generic/git-project-manager)
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
**Generate a new config file:**
|
||||||
|
`git-project-manager config generate --write`
|
||||||
|
|
||||||
|
**For handy aliases and shell helpers:**
|
||||||
|
- Download `https://gitea.libretechconsulting.com/rmcguire/git-project-manager/raw/branch/main/contrib/gpm_func_omz.zsh`
|
||||||
|
- Implement however you like (e.g. copy to ~/.oh-my-zsh/custom/)
|
||||||
|
|
||||||
|
For just completion only, source completions from git-project-manager (e.g. for zsh, `source <(git-project-manager completion zsh)`)
|
||||||
|
|
||||||
|
_The following commands assume you've loaded the gpm alias and help funcs._
|
||||||
|
|
||||||
|
**Index your git repos**
|
||||||
|
`gpm cache load`
|
||||||
|
|
||||||
|
**Add your first project**
|
||||||
|
`padd` (gpm project add)
|
||||||
|
|
||||||
|
**Go to your project, fuzzily**
|
||||||
|
`pgo`
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
[Full documentation is available in docs/](./docs/git-project-manager.md)
|
[Full documentation is available in docs/](./docs/git-project-manager.md)
|
||||||
@ -40,15 +70,6 @@ The basic workflow looks like this:
|
|||||||
1. **List** -- get a list of your configured projects any time with `plist`
|
1. **List** -- get a list of your configured projects any time with `plist`
|
||||||
1. **Reward** -- buy the author a beer, because this thing is a time saver
|
1. **Reward** -- buy the author a beer, because this thing is a time saver
|
||||||
|
|
||||||
## Installing
|
|
||||||
|
|
||||||
1. Install into your go path by running `go install .`
|
|
||||||
1. Copy `contrib/gpm_func_omz.zsh` into your `~/.oh-my-zsh/custom/` path, or just source from your bashrc/zshrc
|
|
||||||
1. Generate config file: `gpm config gen --write`
|
|
||||||
1. You can run this any time to update settings
|
|
||||||
1. It will only add one Git remote, so update the file for multiple
|
|
||||||
1. Run `gpm cache load` (if aliases is in-place, otherwise `git-project-manager cache load`)
|
|
||||||
|
|
||||||
### Config Sample
|
### Config Sample
|
||||||
```yaml
|
```yaml
|
||||||
remotes:
|
remotes:
|
||||||
|
Loading…
Reference in New Issue
Block a user