59 lines
1.7 KiB
Org Mode
59 lines
1.7 KiB
Org Mode
#+title: gra
|
|
#+subtitle: Add new Git remotes quickly
|
|
|
|
|
|
/gra/ (short for =git remote add=) is a small Bash script which allows to add new Git remotes easily.
|
|
New remote URLs will be added with the same URL scheme as the one of the =origin= remote.
|
|
The only argument which is needed is a =REMOTE_NAME=,
|
|
|
|
#+begin_example
|
|
$ gra Deleh
|
|
Adding remote origin-Deleh with URL git@github.com:Deleh/example.git
|
|
Fetching from remote origin-Deleh
|
|
From github.com:Deleh/example
|
|
* [new branch] main -> origin-Deleh/main
|
|
#+end_example
|
|
|
|
* Usage
|
|
|
|
#+begin_example
|
|
Usage: gra [OPTIONS] REMOTE_NAME
|
|
|
|
Add a Git remote by providing a single name. All remotes get listed if no
|
|
REMOTE_NAME is provided.
|
|
|
|
REMOTE_NAME Name of the remote
|
|
|
|
OPTIONS
|
|
-h, --help Show this help message and exit
|
|
#+end_example
|
|
|
|
** Shorthands
|
|
|
|
Shorthands can be defined in =~/.config/gra.config= for example like this:
|
|
|
|
#+begin_src sh
|
|
ex=example
|
|
slu=SuperLongUsername
|
|
#+end_src
|
|
|
|
They can be passed as =REMOTE_NAME= argument, which is handy for often-used, long remote names.
|
|
Autocompletion is available for all defined shorthands.
|
|
Make sure the shorthands adhere to the Bash variable naming rules.
|
|
|
|
* Installation
|
|
|
|
** Manual
|
|
|
|
Place the =gra= script in your =$PATH=.
|
|
To use the autocompletion feature source the =gra_completion.bash= script.
|
|
|
|
** Script
|
|
|
|
An installation script for Bash (=install.bash=) is provided which will link the two files to =~/.local/{bin/gra,share/bash-completion/completions/gra}= and add the corresponding entries to =~/.bashrc=.
|
|
Further updates of /gra/ require just =git pull=.
|
|
|
|
** Nix Flake
|
|
|
|
This repository is also a [[https://nixos.wiki/wiki/Flakes][Nix Flake]].
|
|
/gra/ is provided as package under =github:Deleh/gra#gra=.
|