Skip to content

noxcraftdev/soffit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

soffit

Crates.io License: MIT CI

Customizable statusline manager for Claude Code. Desktop editor with drag-and-drop, live preview, and a plugin system for custom widgets.

soffit in action

soffit statusline

Features

  • 9 built-in widgets: context bar, cost, git, version, duration, vim mode, agent, quota, session
  • Desktop editor: drag-and-drop widget ordering, live preview, per-widget component configuration
  • Plugin system: create custom widgets as shell scripts or compiled binaries
  • Auto-detection: plugins declare components via JSON output for full editor integration
  • Terminal-width aware: automatic wrapping and responsive bar widths

Install

Pre-built binary (recommended)

curl -fsSL https://raw.githubusercontent.com/noxcraftdev/soffit/main/install.sh | sh

From source

cargo install soffit

System dependencies (Linux, build from source only)

sudo apt install libgtk-3-dev libwebkit2gtk-4.1-dev libxdo-dev libsoup-3.0-dev libjavascriptcoregtk-4.1-dev

Supported platforms

  • Linux (x86_64)
  • macOS (Intel and Apple Silicon)

Setup

Add to ~/.claude/settings.json:

{
  "statusLine": {
    "type": "command",
    "command": "soffit render",
    "padding": 0
  }
}

Usage

soffit render          # Render statusline (reads Claude Code JSON from stdin)
soffit edit            # Open the desktop config editor
soffit widgets         # List available widgets (built-in + plugins)
soffit widget <name>   # Test a single widget

Configuration

Config lives at ~/.config/soffit/config.toml (falls back to ~/.config/claude-statusline/config.toml):

statusline_line1 = ["vim", "agent", "version", "context_bar", "quota", "duration", "cost"]
statusline_line2 = ["git", "insights"]
statusline_line3 = []

cost_target_weekly = 300.0
autocompact_pct = 100

[statusline_widgets.cost]
compact = false
components = ["session", "today", "week"]

Custom Plugins

Drop scripts in ~/.config/soffit/plugins/:

#!/bin/bash
# ~/.config/soffit/plugins/weather.sh
INPUT=$(cat)
COMPACT=$(echo "$INPUT" | python3 -c "import json,sys; print(json.load(sys.stdin).get('config',{}).get('compact',False))" 2>/dev/null)

TEMP="22°C"
COND="sunny"

if [ "$COMPACT" = "True" ]; then
  echo "{\"output\": \"$TEMP\", \"components\": [\"temp\", \"condition\"]}"
else
  echo "{\"output\": \"$TEMP $COND\", \"components\": [\"temp\", \"condition\"]}"
fi

Make it executable: chmod +x ~/.config/soffit/plugins/weather.sh

Plugin input format

Plugins receive JSON on stdin:

{
  "data": {
    "session_id": "abc123",
    "version": "1.2.16",
    "model": {"display_name": "claude-sonnet-4-6"},
    "context_window": {"used_percentage": 42.0},
    "cost": {"total_duration_ms": 4830000, "total_cost_usd": 0.42},
    "vim": {"mode": "NORMAL"},
    "agent": {"name": "worker-1"}
  },
  "config": {
    "compact": false,
    "components": ["temp", "condition"]
  }
}

Plugin output format

Return JSON with parts so the framework reorders components per user config:

{"parts": {"temp": "22°C", "condition": "sunny"}, "components": ["temp", "condition"]}

Or return a pre-composed string (component reordering won't apply):

{"output": "22°C sunny", "components": ["temp", "condition"]}

Or return plain text:

22°C sunny

Plugin metadata (optional)

Create a .toml sidecar for richer editor integration:

# ~/.config/soffit/plugins/weather.toml
description = "Current weather conditions"
components = ["temp", "condition"]
has_compact = true

Community Plugins

Install plugins shared on GitHub:

# Install all plugins from the official collection
soffit install noxcraftdev/soffit-plugins

# Install a specific plugin
soffit install noxcraftdev/soffit-plugins/last-msg

# Remove an installed plugin
soffit uninstall last-msg

# Overwrite an existing plugin
soffit install noxcraftdev/soffit-plugins --force

Installed plugins land in ~/.config/soffit/plugins/ and are immediately available.

Creating a plugin repository

Lay out your repo as a flat directory of {name}.sh + {name}.toml pairs:

my-soffit-plugins/
  weather.sh
  weather.toml
  stocks.sh
  stocks.toml

soffit looks for this layout at the repo root first, then inside a plugins/ subdirectory. Multiple plugins per repo is the norm — a single repo can host an entire collection.

The .toml sidecar is optional but recommended: it supplies the description and component list shown in soffit edit.

Editor

soffit edit opens a desktop GUI:

  • Lines tab: drag-and-drop widgets across 3 statusline rows
  • Widgets tab: configure built-in widgets (reorder components, toggle compact mode)
  • Plugin management: create, edit, preview, rename, delete plugins
  • Live preview: see your statusline update in real-time

Editor - Lines tab Editor - Widgets tab

License

MIT

About

Customizable statusline manager for Claude Code with desktop editor and plugin system

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors