rhq 0.1.0

manages Git repositories
docs.rs failed to build rhq-0.1.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build: rhq-0.2.8

rhq

Build Status Build status

Manages your local repositories.

Overview

rhq is a simple CLI tool which provides a way to organize and access local repositories, cloned by Git and other VCSs.

$ rhq clone ubnt-intrepid/rhq
# Run `git clone https://github.com/ubnt-intrepid/rhq.git ~/.rhq/github.com/ubnt-intrepid/rhq`
$ rhq list
/home/username/.rhq/github.com/ubnt-intrepid/rhq
/home/username/.zplug/repos/zsh-users/zsh-autosuggestions
...

The development of this software is inspired by motemen's ghq, CLI tool for repository management written in Golang.

Installation

The Rust toolchain is required to install rhq. If you have already installed Rust toolchain:

$ cargo install rhq

Development version is available by using --git option as follows:

$ cargo install --git https://github.com/ubnt-intrepid/rhq.git

Usage

  • rhq clone [query] [-n | --dry-run] [--arg=<arg>]
    Clone remote reposities into the local directory.
    query is a string to determine the URL of repository. Available formats of query are:

    • (http|https|ssh|git)://github.com[:port]/username/repository.git
    • git@github.com:username/repository.git
    • github.com/username/repository
    • username/repository

    If you want to pass supplemental arguments to git command, use --arg="<arg>".

    rhq try to read standard input to get queries when query is omitted. This behaviour can use use like ghq import, as follows:

    cat list-of-queries.txt | rhq clone --arg="--recursive --depth 50"
    
  • rhq list
    List local repositories managed by rhq.

  • rhq completion [bash|zsh|fish|powershell]
    Generate completion script for your shell and dump to standard output.

If you want to see more information, use rhq help.

Configureation

The location of configuration file is ~/.rhqconfig or ~/.config/rhq/config.

roots = [
  "~/.rhq",
  "~/.vim/plugged",
  "~/.zplug/repos",
  "~/.dotfiles"
]

clone_arg = "--depth 10"

Interface of Visual Studio Code

License

rhq is released under the MIT license. See LICENSE for details.