This commit is contained in:
abs3nt 2024-10-07 19:38:28 -07:00
parent dce423f5fd
commit cb936d00f0
Signed by: abs3nt
GPG Key ID: A7BD96A8BAB04C09

79
readme.md Normal file
View File

@ -0,0 +1,79 @@
# repo-manager
## installation
- Sheldon
```
sheldon add repo-manager --github abs3ntdev/repo-manager
```
- zinit
```
zinit light abs3ntdev/repo-manager
```
## usage
```
Usage: repo <command> <repository>
Commands:
get Clone a repository to the repos directory
open Open the current repository in the browser
aur Clone an AUR repository
list List all repositories
go|goto Navigate to a repository
new|create Create a new repository
help Show this help message
Examples:
repo get github.com/user/repo
repo open
```
## configuration
### hooks
hooks are configured by overriding the functions provided in the plugin in hooks.zsh
the default hooks are:
```
post_repo_clone() {
cd "$1"
}
post_repo_goto() {
cd "$1"
}
post_repo_new() {
cd "$1"
}
```
you can override these in your .zshrc or in a file sourced by your .zshrc to do whatever you want. example:
```
post_repo_clone() {
code "$1"
}
post_repo_goto() {
nvim "$1"
}
post_repo_new() {
some_script "$1"
}
```
### base directory
the base directory is set via ENV. the default is $HOME/repos you can change this by adding the following to your .zshrc
```
export REPO_BASE_DIR="whatever/you/want"
```