Getting started

This page gets you from zero to a working statline prompt in three steps. Budget: two minutes.

1. Install

Pick whichever of these you normally use. All of them install the same statline binary.

# macOS / Linux / WSL — shell installer
curl -fsSL statline.sh/install | sh

# Homebrew
brew install statline

# Arch
pacman -S statline

# Debian / Ubuntu (see "apt repo" below)
apt install statline

# From source
go install go.statline.sh/cmd/statline@latest

Debian / Ubuntu apt repo

If you prefer a signed .deb feed:

curl -fsSL https://apt.statline.sh/keyring.gpg | \
  sudo tee /etc/apt/keyrings/statline.gpg > /dev/null
echo "deb [signed-by=/etc/apt/keyrings/statline.gpg] https://apt.statline.sh stable main" | \
  sudo tee /etc/apt/sources.list.d/statline.list
sudo apt update && sudo apt install statline

2. Hook into your shell

Each shell needs a one-liner. statline generates it for you:

# bash
eval "$(statline init bash)"    # add to ~/.bashrc

# zsh
eval "$(statline init zsh)"     # add to ~/.zshrc

# fish
statline init fish | source   # add to ~/.config/fish/config.fish

# nushell
statline init nu | save -f ~/.config/nushell/statline.nu
# then in your config.nu:  source ~/.config/nushell/statline.nu

Open a new terminal. You should see a rendered status line already, using the default theme.

3. Write a config (optional)

statline ships a sensible default. If you want to customise, drop a file at ~/.config/statline/statline.toml:

# ~/.config/statline/statline.toml
theme     = "tokyonight"
separator = "  "

[[segment]]
type     = "cwd"
truncate = 3

[[segment]]
type   = "git"
format = "{branch} {dirty} {ahead}"

[[segment]]
type    = "kube"
context = "short"
ttl     = "10s"

[[segment]]
type   = "time"
format = "15:04:05"

See the configuration reference for every option.

4. Verify

$ statline doctor
statline v0.9.3
config:    /home/alex/.config/statline/statline.toml  (ok)
shell:     bash 5.2.21                                (hook loaded)
segments:  cwd  git  kube  time                       (4 ok)
cache:     /run/user/1000/statline/                   (ok)
latency:   render p50 0.31ms / p99 1.8ms              (ok)

If statline doctor is all green, you're done. If not, jump to troubleshooting.