Skip to content

Add Termux support and improve installation scripts #495

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
praveensaummya wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add Termux support and improve installation scripts #495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b3c9976
Add Termux support and improve installation scripts
praveensaummya Jun 9, 2026
e74b7fe
Enhance Termux build script and README for improved installation process
praveensaummya Jun 10, 2026
5372b6b
Update Termux build script to extract version from build.info and ins…
praveensaummya Jun 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ VERSION ?= $(shell . ./build.info && printf "%s" "$$gitstatus_version")
# missing in macOS prior to 10.13.
CXXFLAGS += -std=c++14 -funsigned-char -O3 -DNDEBUG -DGITSTATUS_VERSION=$(VERSION) # -Wall -g -fsanitize=thread
LDFLAGS += -pthread # -fsanitize=thread
LDLIBS += -lgit2 # -lprofiler -lunwind
PROFILER_LIBS ?=
LDLIBS += -lgit2 $(PROFILER_LIBS) -lunwind

SRCS := $(shell find src -name "*.cc")
OBJS := $(patsubst src/%.cc, $(OBJDIR)/%.o, $(SRCS))
Expand Down
174 changes: 109 additions & 65 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ Bash bindings for integration with shell.
## Table of Contents

1. [Using from Zsh](#using-from-zsh)
1. [Using from Bash](#using-from-bash)
2. [Using from other shells](#using-from-other-shells)
1. [How it works](#how-it-works)
1. [Benchmarks](#benchmarks)
1. [Why fast](#why-fast)
1. [Requirements](#requirements)
1. [Compiling](#compiling)
1. [License](#license)
2. [Using from Bash](#using-from-bash)
3. [Using from other shells](#using-from-other-shells)
4. [How it works](#how-it-works)
5. [Benchmarks](#benchmarks)
6. [Why fast](#why-fast)
7. [Requirements](#requirements)
8. [Compiling](#compiling)
9. [License](#license)

## Using from Zsh

Expand All @@ -29,8 +29,7 @@ with it. For example, [Powerlevel10k](https://github.com/romkatv/powerlevel10k)
fast theme with first-class gitstatus integration. If you install Powerlevel10k, you don't need to
install gitstatus.

![Powerlevel10k Zsh Theme](
https://raw.githubusercontent.com/romkatv/powerlevel10k-media/master/prompt-styles-high-contrast.png)
![Powerlevel10k Zsh Theme](https://raw.githubusercontent.com/romkatv/powerlevel10k-media/master/prompt-styles-high-contrast.png)

For those who wish to use gitstatus without a theme, there is
[gitstatus.prompt.zsh](gitstatus.prompt.zsh). Install it as follows:
Expand All @@ -40,7 +39,7 @@ git clone --depth=1 https://github.com/romkatv/gitstatus.git ~/gitstatus
echo 'source ~/gitstatus/gitstatus.prompt.zsh' >>! ~/.zshrc
```

Users in China can use the official mirror on gitee.com for faster download.<br>
Users in China can use the official mirror on gitee.com for faster download.`<br>`
中国大陆用户可以使用 gitee.com 上的官方镜像加速下载.

```zsh
Expand Down Expand Up @@ -74,21 +73,21 @@ RPROMPT='$GITSTATUS_PROMPT' # right prompt: git status

The expansion of `${GITSTATUS_PROMPT}` can contain the following bits:

| segment | meaning |
|-------------|-------------------------------------------------------|
| `master` | current branch |
| `#v1` | HEAD is tagged with `v1`; not shown when on a branch |
| `@5fc6fca4` | current commit; not shown when on a branch or tag |
| `⇣1` | local branch is behind the remote by 1 commit |
| `⇡2` | local branch is ahead of the remote by 2 commits |
| `⇠3` | local branch is behind the push remote by 3 commits |
| `⇢4` | local branch is ahead of the push remote by 4 commits |
| `*5` | there are 5 stashes |
| `merge` | merge is in progress (could be some other action) |
| `~6` | there are 6 merge conflicts |
| `+7` | there are 7 staged changes |
| `!8` | there are 8 unstaged changes |
| `?9` | there are 9 untracked files |
| segment | meaning |
| ------------- | ------------------------------------------------------ |
| `master` | current branch |
| `#v1` | HEAD is tagged with `v1`; not shown when on a branch |
| `@5fc6fca4` | current commit; not shown when on a branch or tag |
| `⇣1` | local branch is behind the remote by 1 commit |
| `⇡2` | local branch is ahead of the remote by 2 commits |
| `⇠3` | local branch is behind the push remote by 3 commits |
| `⇢4` | local branch is ahead of the push remote by 4 commits |
| `*5` | there are 5 stashes |
| `merge` | merge is in progress (could be some other action) |
| `~6` | there are 6 merge conflicts |
| `+7` | there are 7 staged changes |
| `!8` | there are 8 unstaged changes |
| `?9` | there are 9 untracked files |

`$GITSTATUS_PROMPT_LEN` tells you how long `$GITSTATUS_PROMPT` is when printed to the console.
[gitstatus.prompt.zsh](gitstatus.prompt.zsh) has an example of using it to truncate the current
Expand Down Expand Up @@ -141,7 +140,7 @@ git clone --depth=1 https://github.com/romkatv/gitstatus.git ~/gitstatus
echo 'source ~/gitstatus/gitstatus.prompt.sh' >> ~/.bashrc
```

Users in China can use the official mirror on gitee.com for faster download.<br>
Users in China can use the official mirror on gitee.com for faster download.`<br>`
中国大陆用户可以使用 gitee.com 上的官方镜像加速下载.

```bash
Expand All @@ -162,8 +161,7 @@ in all code snippets below.)
This will give you a basic yet functional prompt with git status in it. It's
[over 10x faster](#benchmarks) than any alternative that can give you comparable prompt.

![Bash Prompt with GitStatus](
https://raw.githubusercontent.com/romkatv/gitstatus/1ac366952366d89980b3f3484f270b4fa5ae4293/bash-prompt.png)
![Bash Prompt with GitStatus](https://raw.githubusercontent.com/romkatv/gitstatus/1ac366952366d89980b3f3484f270b4fa5ae4293/bash-prompt.png)

In order to customize your prompt, set `PS1` at the end of `~/.bashrc` after sourcing
`gitstatus.prompt.sh`. Insert `${GITSTATUS_PROMPT}` where you want git status to go. For example:
Expand All @@ -176,21 +174,21 @@ PS1='\w ${GITSTATUS_PROMPT}\n\$ ' # directory followed by git status and $/# (no

The expansion of `${GITSTATUS_PROMPT}` can contain the following bits:

| segment | meaning |
|-------------|-------------------------------------------------------|
| `master` | current branch |
| `#v1` | HEAD is tagged with `v1`; not shown when on a branch |
| `@5fc6fca4` | current commit; not shown when on a branch or tag |
| `⇣1` | local branch is behind the remote by 1 commit |
| `⇡2` | local branch is ahead of the remote by 2 commits |
| `⇠3` | local branch is behind the push remote by 3 commits |
| `⇢4` | local branch is ahead of the push remote by 4 commits |
| `*5` | there are 5 stashes |
| `merge` | merge is in progress (could be some other action) |
| `~6` | there are 6 merge conflicts |
| `+7` | there are 7 staged changes |
| `!8` | there are 8 unstaged changes |
| `?9` | there are 9 untracked files |
| segment | meaning |
| ------------- | ------------------------------------------------------ |
| `master` | current branch |
| `#v1` | HEAD is tagged with `v1`; not shown when on a branch |
| `@5fc6fca4` | current commit; not shown when on a branch or tag |
| `⇣1` | local branch is behind the remote by 1 commit |
| `⇡2` | local branch is ahead of the remote by 2 commits |
| `⇠3` | local branch is behind the push remote by 3 commits |
| `⇢4` | local branch is ahead of the push remote by 4 commits |
| `*5` | there are 5 stashes |
| `merge` | merge is in progress (could be some other action) |
| `~6` | there are 6 merge conflicts |
| `+7` | there are 7 staged changes |
| `!8` | there are 8 unstaged changes |
| `?9` | there are 9 untracked files |

If you'd like to change the format of git status, or want to have greater control over the
process of assembling `PS1`, you can copy and modify parts of
Expand Down Expand Up @@ -278,11 +276,11 @@ Two commands were benchmarked: `status` and `describe`.

In this benchmark all tools were computing the equivalent of `git status`. Lower numbers are better.

| Tool | Cold | Hot |
|---------------|-----------:|------------:|
| Tool | Cold | Hot |
| ------------------- | ---------------: | ----------------: |
| **gitstatus** | **291 ms** | **30.9 ms** |
| git | 876 ms | 295 ms |
| lg2 | 1730 ms | 1310 ms |
| git | 876 ms | 295 ms |
| lg2 | 1730 ms | 1310 ms |

gitstatusd is substantially faster than the alternatives, especially on hot runs. Note that hot runs
are of primary importance to the main use case of gitstatus in interactive shells.
Expand All @@ -298,11 +296,11 @@ shown.
In this benchmark all tools were computing the equivalent of `git describe --tags --exact-match`
to find tags that resolve to the same commit as `HEAD`. Lower numbers are better.

| Tool | Cold | Hot |
|---------------|------------:|--------------:|
| Tool | Cold | Hot |
| ------------------- | ----------------: | ------------------: |
| **gitstatus** | **4.04 ms** | **0.0345 ms** |
| git | 18.0 ms | 14.5 ms |
| lg2 | 185 ms | 45.2 ms |
| git | 18.0 ms | 14.5 ms |
| lg2 | 185 ms | 45.2 ms |

gitstatusd is once again faster than the alternatives, more so on hot runs.

Expand All @@ -329,11 +327,11 @@ Under the benchmark conditions described above, the equivalent of libgit2's
gitstatusd. The speedup comes from the following sources.

* gitstatusd uses more efficient data structures and algorithms and employs performance-conscious
coding style throughout the codebase. This reduces CPU time in userspace by 32x compared to libgit2.
coding style throughout the codebase. This reduces CPU time in userspace by 32x compared to libgit2.
* gitstatusd uses less expensive system calls and makes fewer of them. This reduces CPU time spent
in kernel by 1.9x.
in kernel by 1.9x.
* gitstatusd can utilize multiple cores to scan index and workdir in parallel with almost perfect
scaling. This reduces total run time by 12.4x while having virtually no effect on total CPU time.
scaling. This reduces total run time by 12.4x while having virtually no effect on total CPU time.

### Problem statement

Expand All @@ -343,7 +341,7 @@ repository with their last modification times. This is an obvious simplification
this exposition. On disk, index is stored sorted by file path. Here's an example of git index:

| File | Last modification time |
|-------------|-----------------------:|
| ----------- | ---------------------: |
| Makefile | 2019-04-01T14:12:32Z |
| src/hello.c | 2019-04-01T14:12:00Z |
| src/hello.h | 2019-04-01T14:12:32Z |
Expand All @@ -363,8 +361,7 @@ form of work directory traversal.
Let's see how `git_diff_index_to_workdir` from libgit2 accomplishes these tasks. Here's its CPU
profile from 200 hot runs over chromium repository.

![libgit2 CPU profile (hot)](
https://raw.githubusercontent.com/romkatv/gitstatus/1ac366952366d89980b3f3484f270b4fa5ae4293/cpu-profile-libgit2.png)
![libgit2 CPU profile (hot)](https://raw.githubusercontent.com/romkatv/gitstatus/1ac366952366d89980b3f3484f270b4fa5ae4293/cpu-profile-libgit2.png)

(The CPU profile was created with [gperftools](https://github.com/gperftools/gperftools) and
rendered with [pprof](https://github.com/google/pprof)).
Expand All @@ -377,8 +374,7 @@ strings, sorting arrays, etc.

Now let's take a look at the CPU profile of gitstatusd on the same task.

![gitstatusd CPU profile (hot)](
https://raw.githubusercontent.com/romkatv/gitstatus/1ac366952366d89980b3f3484f270b4fa5ae4293/cpu-profile-gitstatusd-hot.png)
![gitstatusd CPU profile (hot)](https://raw.githubusercontent.com/romkatv/gitstatus/1ac366952366d89980b3f3484f270b4fa5ae4293/cpu-profile-gitstatusd-hot.png)

The first impression is that this profile looks pruned. This isn't an artifact. The profile was
generated with the same tools and the same flags as the profile of libgit2.
Expand Down Expand Up @@ -433,8 +429,7 @@ To summarize, here's what gitstatusd was doing when the CPU profile was captured

Here's how the very first scan of a repository looks like in gitstatusd:

![gitstatusd CPU profile (cold)](
https://raw.githubusercontent.com/romkatv/gitstatus/1ac366952366d89980b3f3484f270b4fa5ae4293/cpu-profile-gitstatusd-cold.png)
![gitstatusd CPU profile (cold)](https://raw.githubusercontent.com/romkatv/gitstatus/1ac366952366d89980b3f3484f270b4fa5ae4293/cpu-profile-gitstatusd-cold.png)

(Some glibc functions are mislabel on this profile. `explicit_bzero` and `__nss_passwd_lookup` are
in reality `strcmp` and `memcmp`.)
Expand Down Expand Up @@ -482,8 +477,7 @@ _WARNING: Changes to libgit2 are extensive but the testing they underwent isn't.

## Compiling

There are prebuilt `gitstatusd` binaries in [releases](
https://github.com/romkatv/gitstatus/releases). When using the official shell bindings
There are prebuilt `gitstatusd` binaries in [releases](https://github.com/romkatv/gitstatus/releases). When using the official shell bindings
provided by gitstatus, the right binary for your architecture gets downloaded automatically.

If prebuilt binaries don't work for you, you'll need to get your hands dirty.
Expand All @@ -496,7 +490,7 @@ cd gitstatus
./build -w -s -d docker
```

Users in China can use the official mirror on gitee.com for faster download.<br>
Users in China can use the official mirror on gitee.com for faster download.`<br>`
中国大陆用户可以使用 gitee.com 上的官方镜像加速下载.

```zsh
Expand All @@ -513,6 +507,56 @@ cd gitstatus
If everything goes well, the newly built binary will appear in `./usrbin`. It'll be picked up
by shell bindings automatically.

### Termux (Android)

On Android/Termux, prebuilt Linux binaries may be incompatible. This repository includes a helper
script to build `gitstatusd` in Termux. From the repository root run:

```sh
bash scripts/termux-build.sh "$PWD" "$HOME/local"
```

The script:

- Installs required Termux packages
- Builds a patched `libgit2` from `romkatv/libgit2`
- Compiles `gitstatusd` with the correct version flag from `build.info`
- Produces the binary in `./usrbin`
- Installs the binary to `$HOME/local/bin/gitstatusd`

After a successful build, make the install permanent by exporting the binary path in your shell startup and sourcing the plugin:

```sh
export PATH="$HOME/local/bin:$PATH"
export GITSTATUS_DAEMON="$HOME/local/bin/gitstatusd"
source "$HOME/gitstatus/gitstatus.plugin.zsh"
gitstatus_stop MY 2>/dev/null || true
gitstatus_start -t 5 MY
```

Add that block to `~/.zshrc` or `~/.bashrc` to keep the build available in every shell.

**Manual build (if not using the helper script):**

```sh
# Build libgit2 first
git clone https://github.com/romkatv/libgit2.git ~/libgit2
cd ~/libgit2 && mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=OFF -DBUILD_CLAR=OFF -DUSE_SSH=OFF -DCMAKE_INSTALL_PREFIX="$HOME/local" ..
make -j$(nproc) && make install

# Build gitstatus
export PKG_CONFIG_PATH="$HOME/local/lib/pkgconfig:${PKG_CONFIG_PATH:-}"
export LD_LIBRARY_PATH="$HOME/local/lib:${LD_LIBRARY_PATH:-}"
cd ~/gitstatus
make clean
make CXX=clang++ \
CXXFLAGS="-I$HOME/local/include -DGITSTATUS_VERSION=v1.5.5" \
LDFLAGS="-L$HOME/local/lib" \
LDLIBS="-lgit2 -lcrypto -lssl -lz -lunwind" \
-j8
```

When you update shell bindings, they may refuse to work with the binary you've built earlier. In
this case you'll need to rebuild.

Expand Down
17 changes: 14 additions & 3 deletions gitstatus.plugin.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,14 +97,25 @@ function gitstatus_start() {
local uname_s="${uname_sm% *}"
local uname_m="${uname_sm#* }"

if [[ "$uname_s" == linux ]]; then
local uname_a
if uname_a="$(command uname -a 2>/dev/null)" && [[ "$uname_a" == *Android* ]]; then
uname_s=android
fi
fi

if [[ "${GITSTATUS_NUM_THREADS:-0}" -gt 0 ]]; then
local threads="$GITSTATUS_NUM_THREADS"
else
local cpus
if ! command -v sysctl &>/dev/null || [[ "$uname_s" == linux ]] ||
! cpus="$(command sysctl -n hw.ncpu)"; then
if ! command -v getconf &>/dev/null || ! cpus="$(command getconf _NPROCESSORS_ONLN)"; then
cpus=8
! cpus="$(command sysctl -n hw.ncpu 2>/dev/null)"; then
if ! command -v getconf &>/dev/null || ! cpus="$(command getconf _NPROCESSORS_ONLN 2>/dev/null)"; then
if command -v nproc &>/dev/null && nproc >/dev/null 2>&1; then
cpus="$(command nproc)"
else
cpus=8
fi
fi
fi
local threads=$((cpus > 16 ? 32 : cpus > 0 ? 2 * cpus : 16))
Expand Down
36 changes: 34 additions & 2 deletions install
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/sh
#!/usr/bin/env bash
#
# This script does not have a stable API.

Expand Down Expand Up @@ -142,6 +142,13 @@ END
uname_m="$(printf '%s' "$uname_m" | command tr '[A-Z]' '[a-z]')" || return
fi

if [ "$uname_s" = linux ]; then
local uname_a
if uname_a="$(command uname -a 2>/dev/null)" && [ "${uname_a#*Android}" != "$uname_a" ]; then
uname_s=android
fi
fi

local daemon="${GITSTATUS_DAEMON:-}"
local cache_dir="${GITSTATUS_CACHE_DIR:-${XDG_CACHE_HOME:-$HOME/.cache}/gitstatus}"

Expand Down Expand Up @@ -465,6 +472,31 @@ END

>&"$e" printf 'There is no prebuilt \033[32mgitstatusd\033[0m for \033[1m%s\033[0m.\n' "$uname_s $uname_m"
>&"$e" printf '\n'
if [ "$uname_s" = android ]; then
>&"$e" printf 'Android support for this architecture requires a locally built gitstatusd.\n'
>&"$e" printf 'Build from source and set \033[32mGITSTATUS_DAEMON\033[0m to the executable.\n'
>&"$e" printf '\n'
# If the Termux helper script exists, offer to run it interactively
if [ -x "$gitstatus_dir/scripts/termux-build.sh" ] && [ -t 0 ]; then
>&"$e" printf 'This repository includes a Termux build helper: %s/scripts/termux-build.sh\n' "$gitstatus_dir"
>&"$e" printf 'Would you like to run it now to build gitstatusd locally? [Y/n] '
IFS= read -r _ans || _ans=n
case "$_ans" in
''|[Yy]|[Yy][Ee][Ss])
command chmod +x -- "$gitstatus_dir/scripts/termux-build.sh" 2>/dev/null || true
if bash "$gitstatus_dir/scripts/termux-build.sh" "$gitstatus_dir" "$HOME/local"; then
if [ -x "$gitstatus_dir/usrbin/gitstatusd" ]; then
daemon="$gitstatus_dir/usrbin/gitstatusd"
_gitstatus_install_daemon_found 1 "$@"
return
fi
fi
;;
*) ;;
esac
>&"$e" printf '\n'
fi
fi
>&"$e" printf 'See: \033[4mhttps://github.com/romkatv/gitstatus#compiling\033[0m\n'
return 1
}
Expand All @@ -473,4 +505,4 @@ if [ -z "${0##*/*}" ]; then
_gitstatus_install_main "${0%/*}" "$@"
else
_gitstatus_install_main . "$@"
fi
fi
Loading