Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/siketyan/ghr

🚀 Yet another repository management with auto-attaching profiles.
https://github.com/siketyan/ghr

cli git repository-management rust

Last synced: 5 days ago
JSON representation

🚀 Yet another repository management with auto-attaching profiles.

Awesome Lists containing this project

README 

        
# 🚀 ghr



[![crates.io](https://img.shields.io/crates/v/ghr.svg)](https://crates.io/crates/ghr)

[![Rust](https://github.com/siketyan/ghr/actions/workflows/rust.yml/badge.svg)](https://github.com/siketyan/ghr/actions/workflows/rust.yml)



Yet another repository management with auto-attaching profiles.



## 🔥 Motivation



[ghq](https://github.com/x-motemen/ghq) is the most famous solution to resolve stress of our repository management

currently.

However, I wanted to customise the git configuration by some rules, such as using my company email in their

repositories.



To achieve that, ghq was not enough for me.

So I have rewritten them as simple, in Rust, the robust and modern language today.



## 📦 Installation



### macOS / Using Homebrew (easy)



```shell

brew install s6n-jp/tap/ghr

```



To upgrade:



```shell

brew upgrade s6n-jp/tap/ghr

```



### Windows / Using scoop (easy)



```shell

scoop bucket add siketyan https://github.com/siketyan/scoop-bucket.git

scoop install ghr

```



To upgrade:



```shell

scoop update ghr

```



### Any OS / Using cargo (classic)



If you have not installed Rust environment, follow the instruction of [rustup](https://rustup.rs/).



```shell

cargo install ghr

```



For upgrading, we recommend to use [cargo-update](https://github.com/nabijaczleweli/cargo-update).



```shell

cargo install-update ghr

```



### 🔧 Installing the shell extension



To extend ghr features to maximum, it is recommended to install the shell extension.

Add the line below to your shell configuration script to enable it.



#### Bash



```shell

source <(ghr shell bash)

```



To enable completions, add the line into `~/.bash_completion`.



```shell

source <(ghr shell bash --completion)

```



#### Fish



```shell

ghr shell fish | source

```



To enable completions, add the line into `~/.config/fish/completions/ghr.fish`.



```shell

ghr shell fish --completion | source

```



## 💚 Usages



```

Usage: ghr 



Commands:

  cd       Change directory to one of the managed repositories (Shell extension required)

  clone    Clones a Git repository to local

  delete   Deletes a repository from local

  init     Initialises a Git repository in local

  list     Lists all managed repositories

  open     Opens a repository in an application

  browse   Browse a repository on web

  path     Prints the path to root, owner, or a repository

  profile  Manages profiles to use in repositories

  search   Perform a fuzzy search on the repositories list

  shell    Writes a shell script to extend ghr features

  sync     Sync repositories between your devices

  version  Prints the version of this application

  help     Print this message or the help of the given subcommand(s)



Options:

  -q, --quiet    Operates quietly. Errors will be reported even if this option is enabled

  -v, --verbose  Operates verbosely. Traces, debug logs will be reported

  -h, --help     Print help

```



### Cloning a repository



ghr supports many patterns or URLs of the repository to clone:



```shell

ghr clone /

ghr clone github.com:/

ghr clone https://github.com//.git

ghr clone ssh://[email protected]//.git

ghr clone [email protected]:/.git

```



If you have installed the shell extension, you can change directory to the cloned repository:



```shell

ghr clone  --cd

```



If you often use repositories of a specific owner, you can set the default owner to be resolved.



```toml

[defaults]

owner = "siketyan"

```



```shell

ghr clone 

```



### Changing directory



You can change directory to one of the managed repositories on the shell.

It requires installing the shell extension.



```shell

ghr cd 

```



### Attaching profiles



Create `~/.ghr/ghr.toml` and edit as you like:



```toml

[profiles.default]

user.name = "Your Name"

user.email = "[email protected]"



[profiles.company]

user.name = "Your Name (ACME Inc.)"

user.email = "[email protected]"



[[rules]]

profile.name = "company"

owner = "acme" # Applies company profiles to all repositories in `acme` org



[[rules]]

profile.name = "default"

```



### Configuring applications to open repos in



Edit `~/.ghr/ghr.toml` and add entries as you like:



```toml

[applications.vscode]

cmd = "code"

args = ["%p"]

```



> [!NOTE]

> `%p` will be replaced by the repository path.



### Finding path of the repository



```shell

ghr path # Root directory

ghr path / # Repository directory

ghr path  # Repository directory resolved by URL

ghr path github.com// # Repository directory of the specified host

ghr path --owner= # Owner root

ghr path --host=github.com # Host root

ghr path --host=github.com --owner= # Owner root of the specified host

```



### Syncing repositories and their state



> [!WARNING]

> This feature is experimental.



ghr supports dumping and restoring the current branch and remotes of managed repositories.



```shell

ghr sync dump > repositories.toml

ghr sync restore < repositories.toml

```



## 🛠 Customising



You can change the root of repositories managed by ghr by setting environment variable `GHR_ROOT` in your shell profile.



```shell

ghr path # ~/.ghr

GHR_ROOT=/path/to/root ghr path # /path/to/root

```