gitflect

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #android #rust #deep-learning #nodejs #java #awesome-list #vue #pytorch #security #ios #openai

(★ 10)

Fast Git-aware prompt helper for Bash and Zsh on Linux and macOS

gitflect Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Fast Git context for Bash and Zsh. Branch, status, and counts right in the prompt.

<a href="https://shravangoswami.com/gitflect/">Docs</a>
 &nbsp;·&nbsp;
 <a href="https://shravangoswami.com/gitflect/docs/reference/changelog/">Changelog</a>
 &nbsp;·&nbsp;
 <a href="https://github.com/shravanngoswamii/gitflect?tab=contributing-ov-file#contributing-to-gitflect">Contributing</a>

```sh
curl -fsSL https://raw.githubusercontent.com/shravanngoswamii/gitflect/main/install.sh | sh
```

The install script detects your shell, places the binary on `PATH`, and wires up the prompt hook. Open a new terminal and you're done.

**Via Cargo**

```sh
cargo install gitflect
```

Then add the init line to your shell profile and reload:

```sh
# Bash — add to ~/.bashrc
echo 'eval "$(gitflect init bash)"' >> ~/.bashrc && exec $SHELL

# Zsh — add to ~/.zshrc
echo 'eval "$(gitflect init zsh)"' >> ~/.zshrc && exec $SHELL
```

To update:

```sh
cargo install gitflect
```

To remove:

```sh
cargo uninstall gitflect
# then remove the eval line from ~/.bashrc or ~/.zshrc
```

## Update

Rerun the install script to update to the latest release:

```sh
curl -fsSL https://raw.githubusercontent.com/shravanngoswamii/gitflect/main/install.sh | sh
```

## Usage

```sh
gitflect status              # print current Git segment
gitflect theme list          # list themes, active one marked with *
gitflect theme set minimal   # switch theme
gitflect settings            # browse and edit all settings interactively
gitflect --version
```

Prompt segment example:

```
user@host ~/project (main ≡ +1 ~0 -0 | !2 ~1 -0 ?)
```

See the [docs](https://shravangoswami.com/gitflect/) for [themes](https://shravangoswami.com/gitflect/docs/use/themes/) and [settings](https://shravangoswami.com/gitflect/docs/use/settings/).

## Development

```sh
git config core.hooksPath .githooks   # enable pre-commit fmt check (once per clone)
cargo test
cargo clippy --all-targets -- -D warnings
cargo build --release
```

Issues at [github.com/shravanngoswamii/gitflect/issues](https://github.com/shravanngoswamii/gitflect/issues).

gitflect

gitflect Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

gitflect

gitflect Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README