https://github.com/untoldwind/git-radar-rs
Rust version of git-radar
https://github.com/untoldwind/git-radar-rs
command-line-tool git git-radar
Last synced: 5 months ago
JSON representation
Rust version of git-radar
- Host: GitHub
- URL: https://github.com/untoldwind/git-radar-rs
- Owner: untoldwind
- License: mit
- Created: 2024-05-17T11:26:34.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-01T16:20:30.000Z (about 2 years ago)
- Last Synced: 2025-01-12T12:39:48.956Z (over 1 year ago)
- Topics: command-line-tool, git, git-radar
- Language: Rust
- Homepage:
- Size: 87.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# git-radar-rs
Rust version of [git-radar](https://github.com/michaeldfallen/git-radar) or [gitHUD](https://github.com/gbataille/gitHUD)
## Install
### Cargo
```sh
cargo install git-radar-rs
```
Note: By default `git-radar-rs` compiles with support for `libgit2` (via: https://github.com/rust-lang/git2-rs).
If this causes problems use:
```sh
cargo install --no-default-feature git-radar-rs
```
to install a version that uses the `git` command-line (just like the original `git-radar`)
## Setup
To track the remote HEAD correctly it might be necessary to run a
```sh
git remote set-head origin --auto
```
once on the repository (or whenever the remote default branch is changed).
### Bash
Example for a simplistic bash-prompt:
```sh
export PS1="\W\$(git-radar-rs bash)\[\033[0m\]\$ "
```
### Zsh
Example for a simplistic zsh-prompt:
```sh
setopt PROMPT_SUBST
export PROMPT='%1d $(git-radar-rs zsh)$ '
```
### Fish
`git-radar-rs` can be used directly inside the "fish_prompt" function.
### Tmux
Example `.tmux.conf´:
```
set -g status-bg '#222222'
set -g status-fg '#ffffff'
set -g status-right "#{pane_current_command} #(cd '#{pane_current_path}' && git-radar-rs tmux)"
```