🚀 ghr

Yet another repository management with auto-attaching profiles.

🔥 Motivation

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

shell cargo install 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 eval "$(ghr shell bash)"

Fish

shell eval "$(ghr shell fish)"

💚 Usages

``` Usage: ghr

Commands: cd Changes directory into a repository (Shell extension required) clone Clones a Git repository to local delete Deletes a repository from local init Initialises a Git repository in local path Prints the path to root, owner, or a repository profile Manages profiles to use in repositories shell Writes a shell script to extend ghr features help Print this message or the help of the given subcommand(s)

Options: -h, --help Print help information ```

Cloning a repository

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

shell ghr clone <owner>/<repo> ghr clone github.com:<owner>/<repo> ghr clone https://github.com/<owner>/<repo>.git ghr clone ssh://git@github.com/<owner>/<repo>.git ghr clone git@github.com:<owner>/<repo>.git

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

shell ghr clone <url_or_pattern> --cd

Changing directory

You can change directory into a repository on the shell. It requires installing the shell extension.

shell ghr cd <url_or_pattern>

Attaching profiles

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

```toml [profiles.default] user.name = "Your Name" user.email = "your_name@personal.example.com"

[profiles.company] user.name = "Your Name (ACME Inc.)" user.email = "your_name@company.example.com"

[[rules]] profile.name = "company" owner = "acme" # Applies company profiles to all repositories in acme org

[[rules]] profile.name = "default" ```

Finding path of the repository

shell ghr path # Root directory ghr path <owner> # Owner root ghr path <owner> <repo> # Repository directory ghr path --host=github.com # Host root ghr path --host=github.com <owner> # Owner root of the specified host ghr path --host=github.com <owner> <repo> # Repository directory of the specified host

🛠 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