copilot-powerline 0.8.0

A fast, customizable powerline status line for GitHub Copilot CLI
copilot-powerline-0.8.0 is not a library.

copilot-powerline

CI Crates.io License: MIT

A fast, beautiful status line for GitHub Copilot CLI.

Keep context usage, session and monthly spend, prompt-cache efficiency, reasoning tokens, and total session activity visible while you work. copilot-powerline is a native Copilot CLI statusLine command: a small Rust executable with bundled SQLite that reads the data Copilot already provides.

Install and connect it to Copilot CLI

Install a prebuilt binary (macOS and Linux, no Rust toolchain needed):

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/xpepper/copilot-powerline/releases/latest/download/copilot-powerline-installer.sh | sh

Or with Homebrew:

brew install xpepper/tap/copilot-powerline

Or install from crates.io:

cargo install copilot-powerline

Then add it to ~/.copilot/settings.json:

{
  "statusLine": {
    "type": "command",
    "command": "copilot-powerline",
    "refreshInterval": 30
  }
}

Keep refreshInterval: without it Copilot CLI only refreshes the status line on events, so the idle cache-expiry warning (cache_expiry) cannot appear while you are away.

If the install directory is not on your PATH, use the full path as the command: ~/.local/bin/copilot-powerline for the installer, or ~/.cargo/bin/copilot-powerline for Cargo. Run copilot-powerline --init at any time to create the default configuration at ~/.copilot/powerline.toml.

See it in action

Animated Copilot CLI status line updating context usage, session and monthly spend, cache rate, reasoning tokens, and total tokens

Copilot CLI status line showing context usage, session and monthly spend, cache rate, reasoning tokens, and total tokens

๐Ÿ”ฅ 145k/400k (36%)  โ”‚  ๓ฐ„ฌ $8.64  โ”‚  ๓ฐ   $281.66  โ”‚  ๓ฐ˜ธ 95%  โ”‚  ๓ฐšฉ 6.2k  โ”‚  ๓ฐ“… 4.5M

Text preview: a Copilot CLI status line showing a context warning, current-session and month-to-date spend, prompt-cache hit rate, reasoning tokens, and total session tokens.

Choose the presentation that fits your terminal:

# Minimal (Nerd icons)
๓ฐฎš 129k/400k (32%)  โ”‚  ๓ฐ„ฌ $2.20  โ”‚  ๓ฐ   $273.88  โ”‚  ๓ฐ˜ธ 80%  โ”‚  ๓ฐšฉ 4.2k  โ”‚  ๓ฐ“… 175k

# Capsule (Nerd icons)
๎‚ถ๓ฐฎš 129k/400k (32%) ๎‚ด ๎‚ถ๓ฐ„ฌ $2.20 ๎‚ด ๎‚ถ๓ฐ   $273.88 ๎‚ด ๎‚ถ๓ฐ˜ธ 80% ๎‚ด ๎‚ถ๓ฐšฉ 4.2k ๎‚ด ๎‚ถ๓ฐ“… 175k ๎‚ด

# Plain (text labels)
Tokens: 129k/400k (32%)  โ”‚  Session: $2.20  โ”‚  Month: $273.88  โ”‚  Cache: 80%  โ”‚  Think: 4.2k  โ”‚  Total: 175k

Why copilot-powerline?

  • Stay in flow. See context pressure before it becomes disruptive, with configurable warnings and a choice of compact layouts.
  • Understand usage. Follow session spend, month-to-date spend, cache hits, reasoning tokens, and total token volume in the terminal.
  • Make it yours. Select minimal, powerline, capsule, or plain layouts; nerd, emoji, or text icons; and a built-in color theme.
  • Keep it lightweight. A compiled Rust executable runs as Copilot refreshes the native status line and queries Copilot's local session database read-only.

Inspired by claude-powerline.


Features

  • Context Window Monitoring: Real-time context tracking with percentage and warning alert threshold (>100k).
  • Prompt Cache Tracking: Real-time cache hit rate (or token count), automatically hidden when zero.
  • Idle Cache-Expiry Warning: After 5 idle minutes the prompt cache is gone and the next turn rewrites the whole context; shows how much (e.g. ~92k uncached ยท /clear to start fresh).
  • Reasoning Tokens: Tracks thinking tokens for reasoning models (e.g. o3-mini, Claude 3.7 Sonnet thinking).
  • Total Session Tokens: Displays total accumulated token volume across all turns and compactions.
  • Spend Tracking: Real-time session spend and month-to-date aggregation from Copilot's local SQLite database.
  • GitHub Cycle Usage (optional, experimental): Shows the AI credits GitHub counts for your current billing cycle across every Copilot surface (IDE, github.com, CLI), fetched with the gh CLI in the background. Opt in by adding cycle_cost to segments. A helper script can also log it over time.
  • Pull Request Reference (optional): Shows the current branch's pull request (e.g. PR #50) as a clickable link, via the gh CLI. Disabled from the default segment list; opt in by adding pr to segments.
  • Configurable AIC Display: Toggle whether AI Credits (... AIC) appear alongside dollar amounts.
  • Multiple Styles & Icon Sets: Choose from minimal, powerline, capsule, or plain, with nerd, emoji, or plain icons.
  • Themes: Built-in support for colorblind, github, nord, tokyo-night, and plain. Automatically syncs with your Copilot CLI theme if set to default.
  • Bundled SQLite: SQLite and JSON parsing ship with the executable; no status-line service is required.

Installation and compatibility

Prebuilt binaries

Each GitHub Release ships binaries for macOS (Apple Silicon and Intel) and Linux (x86_64 and arm64, glibc 2.35 or newer), with SHA-256 checksums. The shell installer from the quick start picks the right one and installs it to ~/.local/bin, adding that directory to your PATH if needed.

Homebrew (macOS or Linux) installs the same binaries from the xpepper/homebrew-tap tap:

brew install xpepper/tap/copilot-powerline

If you use cargo-binstall, it downloads the same binaries instead of compiling:

cargo binstall copilot-powerline

If you manage tools with mise, install the release binary directly from GitHub:

mise use -g github:xpepper/copilot-powerline

For the status-line command, use the real binary path printed by mise which copilot-powerline rather than the mise shim: the shim starts mise on every refresh, roughly doubling run time. That path includes the version, so update ~/.copilot/settings.json after upgrading. mise may hide a release for a while after it is published; if it reports no matching versions, pin one explicitly (for example github:xpepper/copilot-powerline@0.3.2).

Install with Cargo

cargo install copilot-powerline

It requires a current stable Rust toolchain with Cargo.

However you install it, the executable runs locally during Copilot CLI status-line refreshes and never makes network requests itself. The only exceptions are the optional pr and cycle_cost segments, which run gh in a detached background process, never inline in the refresh.

Verified environments and terminal support

CI tests and builds release binaries on GitHub Actions' current macOS and Ubuntu runner images. Windows is not currently verified in CI and has no prebuilt binary; use cargo install there at your own risk.

The default nerd icon set requires a Nerd Font. Use --icon-set emoji or --icon-set plain when your terminal does not support Nerd Font glyphs.

Build from source

For local development or unreleased changes:

git clone https://github.com/xpepper/copilot-powerline.git
cd copilot-powerline
cargo install --path .

To configure a generated default, run:

copilot-powerline --init

This creates ~/.copilot/powerline.toml.


Status Line Legend & Segments

Segment Icon (nerd) Icon (emoji) Text (plain) Example Value Description
tokens ๓ฐฎš / ๐Ÿ”ฅ ๐Ÿช™ / ๐Ÿ”ฅ Tokens: 145k/400k (36%) Context Window: Active context tokens vs model limit (and percentage used). Automatically switches to ๐Ÿ”ฅ when crossing the configured alert threshold (default >100k).
session_cost ๓ฐ„ฌ ๐Ÿ’ฐ Session: $8.64 / ๐Ÿ’ธ $9.10 / ๐Ÿ“ˆ $9.10 Current Session Cost: Real-time spend accumulated in the active session in USD (optional AIC credit display). With alert_above_usd set (opt-in), shows ๐Ÿ’ธ and the alert color once the session costs more than that limit. With spike_alert = true (opt-in), shows ๐Ÿ“ˆ and the alert color when the latest step cost much more per token than the session average, a hint of expensive model routing or a cache miss on a large context. Both icons appear when both apply.
month_cost ๓ฐ   ๐Ÿ“… Month: $281.66 / ๐Ÿ’ธ $312.40 Month-to-Date Cost: Total cumulative monthly spend across all sessions, queried directly from Copilot's ~/.copilot/session-store.db. The current session updates live; other sessions' spend is re-read at most once a minute. With alert_above_usd set (opt-in), shows ๐Ÿ’ธ and the alert color once the month costs more than that limit.
cycle_cost ๓ฐŠค ๐Ÿ™ Cycle: $159.48 / ๐Ÿ’ธ $159.48 GitHub Cycle Usage (optional, not in the default segments list): The AI credits GitHub counts for your current billing cycle, in USD at list price (1 credit = $0.01), across every Copilot surface, not just this CLI. With a per-user budget, it shows the part of the budget used. Read from GitHub's internal /copilot_internal/user API, refreshed every cache_ttl_seconds (default 300). Requires an authenticated gh CLI; hidden until the first fetch completes, and after the cycle resets until the next fetch. When a fetch fails, it keeps showing the last value. With alert_above_usd set (opt-in), shows ๐Ÿ’ธ and the alert color once the cycle costs more than that limit.
cache ๓ฐ˜ธ โšก Cache: 95% โ†“ Prompt Cache Hit Rate: Percentage of prompt tokens served from cache (or raw token count). Shows โ†‘ (green, or blue in colorblind) when the tokens added since the previous refresh hit the cache clearly more than the session average, and โ†“ (red, or orange in colorblind) when they hit it clearly less. The arrow stays until the next step. Automatically hidden when 0.
cache_expiry ๓ฐ”Ÿ โณ Idle: ~92k uncached ยท /clear to start fresh Idle Cache-Expiry Warning: Appears once the session has been idle longer than the prompt cache TTL (ttl_seconds, default 300), when the next turn will rewrite the whole context uncached. Shows the context size at stake and a hint to start fresh. Hidden below min_tokens (default 50k) and whenever the cache is still warm. Needs refreshInterval in Copilot CLI's statusLine settings.
reasoning ๓ฐšฉ ๐Ÿง  Think: 6.2k Reasoning Tokens: Cumulative tokens used by thinking models (e.g. o3-mini, Claude 3.7 Sonnet). Automatically hidden when 0.
total_tokens ๓ฐ“… ๐Ÿ“Š Total: 4.5M Total Session Tokens: Total cumulative token throughput (input + output + cached) exchanged across all turns and compactions in the session.
model ๓ฐ˜š ๐Ÿค– Model: Auto โ†’ Claude Opus 4.5 Active Model (optional, not in the default segments list): The model Copilot is using. With auto, shows which model the router picked, so a switch to a pricier model is visible.
pr `` ๐Ÿ”€ PR PR #50 Pull Request Reference (optional, not in the default segments list): The current branch's open pull request, as a clickable hyperlink. Requires an authenticated gh CLI; hidden when the branch has no open PR or gh is unavailable.

Configuration (~/.copilot/powerline.toml)

copilot-powerline is configured via a simple TOML file:

style = "minimal"      # Options: "minimal", "powerline", "capsule", "plain"
icon_set = "nerd"      # Options: "nerd", "emoji", "plain"
theme = "colorblind"   # Options: "colorblind", "github", "nord", "tokyo-night", "plain"
mode = "full"          # "full" shows `segments`, "compact" shows `compact_segments`
compact_segments = ["tokens", "session_cost", "month_cost", "cache_expiry"]
segments = [
    "tokens",
    "session_cost",
    "month_cost",
    "cache",
    "reasoning",
    "total_tokens",
    "cache_expiry",
    # "model", # Uncomment to show the active model (and where `auto` routed)
    # "pr",   # Uncomment to show the current branch's PR (requires the `gh` CLI)
    # "cycle_cost", # Uncomment to show GitHub's billing-cycle usage (requires the `gh` CLI)
]

[tokens]
enabled = true
show_percentage = true
alert_threshold = 100000
alert_icon = "๐Ÿ”ฅ "
# prefix = "Tokens:"   # Optional custom override

[session_cost]
enabled = true
currency_symbol = "$"
show_aic = false       # Set to true to show "(X.X AIC)"
decimal_places = 2
spike_alert = false    # Opt-in: flag steps that cost much more per token than the session average
spike_ratio = 2.0      # ...this many times the average
spike_min_usd = 0.05   # ...and at least this much in a single step
spike_icon = "๐Ÿ“ˆ "
# alert_above_usd = 5.0  # Opt-in: flag the session once it costs more than this
alert_icon = "๐Ÿ’ธ "

[month_cost]
enabled = true
currency_symbol = "$"
show_aic = false       # Set to true to show "(X AIC)"
decimal_places = 2
# alert_above_usd = 300.0  # Opt-in: flag the month once it costs more than this
alert_icon = "๐Ÿ’ธ "

[cycle_cost]
enabled = true
currency_symbol = "$"
show_aic = false       # Set to true to show "(X AIC)"
decimal_places = 2
# alert_above_usd = 300.0  # Opt-in: flag the cycle once it costs more than this
alert_icon = "๐Ÿ’ธ "
cache_ttl_seconds = 300  # How long a fetched value is considered fresh
# prefix = "GitHub:"    # Optional custom override

[cache]
enabled = true
show_as_percentage = true  # Set to false to show token count (e.g. 85k)
auto_hide_zero = true      # Automatically hide if 0 cache reads
show_trend = true          # โ†‘/โ†“ when the latest step beats or misses the session average

[reasoning]
enabled = true
auto_hide_zero = true      # Automatically hide if model has no reasoning tokens

[total_tokens]
enabled = true

[cache_expiry]
enabled = true
ttl_seconds = 300      # Prompt cache lifetime: warn after this many idle seconds
min_tokens = 50000     # Stay quiet for contexts smaller than this
hint = "/clear to start fresh"  # Set to "" to show only the uncached size

[model]
enabled = true
# prefix = "Model:"    # Optional custom override

[pr]
enabled = true
hyperlinks = true      # Set to false to print "PR #50" as plain text
cache_ttl_seconds = 60 # How long a cached PR lookup is considered fresh
# prefix = "Pull:"      # Optional custom override

If your powerline.toml sets segments or compact_segments, segments added in later releases (such as cache_expiry) only show once you add them to those lists.

Compact mode

Cache hit rate, reasoning and total tokens are useful when diagnosing a session but noisy during normal work. Switch to the shorter compact_segments list and back at any time:

copilot-powerline --toggle   # prints "copilot-powerline: compact mode" or "... full mode"

From inside Copilot CLI, run it as a shell command: !copilot-powerline --toggle. The change shows up on the next status line refresh, with no restart. The toggle is stored in your user cache directory and is cleared when you toggle back to the mode set in powerline.toml.

The pr segment shells out to gh pr view --json number,url for the current branch. To avoid blocking the status line on a network call, lookups are cached to disk and refreshed by a throttled, detached background process; the segment is hidden until the first refresh completes, and again whenever the branch has no open PR or gh is not installed/authenticated.

The cycle_cost segment works the same way with gh api /copilot_internal/user, which takes about a second per call; the background gh call is killed after 10 seconds, as is the pr one. If COPILOT_GITHUB_TOKEN is set, it is passed to gh as GH_TOKEN, so the token is picked in the same order Copilot CLI uses. The endpoint is internal and undocumented, so GitHub may change it without notice; when the response lacks the fields the segment needs, it keeps the last known value, or stays hidden if there is none, rather than showing a wrong number. month_cost and cycle_cost measure different things: month_cost estimates this CLI's spend from local data, while cycle_cost is GitHub's own counter for all your Copilot usage.


Command Line Options

# Test with sample JSON from stdin
echo '{"context_window":{"current_context_tokens":0,"displayed_context_limit":200000,"current_context_used_percentage":0},"ai_used":{"total_nano_aiu":0}}' | copilot-powerline

# Override icon set on the fly
copilot-powerline --icon-set nerd
copilot-powerline --icon-set emoji
copilot-powerline --icon-set plain

# Override style on the fly
copilot-powerline --style capsule
copilot-powerline --style powerline
copilot-powerline --style minimal

# Override theme on the fly
copilot-powerline --theme nord
copilot-powerline --theme tokyo-night

# Switch between full and compact mode
copilot-powerline --toggle

# Use a custom configuration file
copilot-powerline --config /path/to/custom-powerline.toml

Troubleshooting

  • Icons look like question marks or boxes? Make sure your terminal font is a Nerd Font (such as JetBrainsMono Nerd Font, Hack Nerd Font, or FiraCode Nerd Font). Alternatively, switch to emoji icons by setting icon_set = "emoji" or plain text with icon_set = "plain" in powerline.toml.

  • Copilot shows a blank statusline? Ensure copilot-powerline is in your PATH or use the full path in ~/.copilot/settings.json: ~/.local/bin/copilot-powerline (shell installer), ~/.cargo/bin/copilot-powerline (Cargo), or the output of which copilot-powerline.


Experimental: exact GitHub usage refresh

The month_cost segment calculates an estimate from the local Copilot CLI database. GitHub's Settings > Copilot > Features page can show a more complete personal usage counter, including usage that is absent from the local database. The optional cycle_cost segment shows that counter in the status line; this helper fetches it on demand and keeps a history of readings.

The experimental helper is a separate script, not part of the status-line binary, so it is only available from a clone of this repository. It reads that counter from GitHub's Copilot user API (/copilot_internal/user) with your GitHub token, and it does not run as part of the status-line refresh loop. It needs curl and jq.

# Once, if you have not already: sign in to GitHub CLI.
gh auth login

# Fetch the current value and save a private local cache.
./scripts/fetch-github-copilot-usage
# {"ai_credits_used":49854,"usd":"498.54","cycle":"September 1-30, 2026"}

The token is looked up in the same order Copilot CLI uses: COPILOT_GITHUB_TOKEN, GH_TOKEN, GITHUB_TOKEN, then gh auth token. No extra scope is needed. The output cache is ~/.copilot/github-usage.json; set COPILOT_USAGE_CACHE_FILE to use a different path.

usd is the list price of the credits (USD 0.01 each), not what your organization pays: plans with included credits use those first.

The API endpoint is internal and undocumented, so GitHub may change it without notice. If that happens, --browser falls back to reading Settings > Copilot > Features through a dedicated local browser profile, which needs agent-browser and a GitHub web login that has to be repeated when it expires:

npm install --global agent-browser
agent-browser install

# Open a visible browser once and complete GitHub login, SSO, and 2FA.
./scripts/fetch-github-copilot-usage --login

./scripts/fetch-github-copilot-usage --browser

Browser state is stored in ~/.copilot/github-usage-profile; set COPILOT_USAGE_BROWSER_PROFILE to use a different path. The profile and its cookies never leave your machine.

Every run also appends a timestamped entry to a local JSON Lines history log at ~/.copilot/github-usage-history.jsonl (one JSON object per line: ts, ai_credits_used, usd, cycle), so you can track how your credit consumption changes over time. Set COPILOT_USAGE_HISTORY_FILE to use a different path, or pass --no-history to skip it for a single run. Inspect it with jq, for example:

# Show the last 10 readings.
tail -n 10 ~/.copilot/github-usage-history.jsonl | jq .

# Credit delta between the two most recent runs.
jq -s '.[-1].ai_credits_used - .[-2].ai_credits_used' \
    ~/.copilot/github-usage-history.jsonl

Contributing

Contributions are welcome. See CONTRIBUTING.md for local setup, verification commands, supported scope, and the pull-request workflow.


License

MIT