A simple, keyboard‑friendly terminal UI for exploring Traefik routers and services. Built with React + Ink, focused on clarity over chrome.

🚀 Installation methods

curl -sSL https://raw.githubusercontent.com/darksworm/traefiktop/main/install.sh | sh

The install script automatically detects your system (including musl vs glibc on Linux) and downloads the appropriate binary from the latest release.

You can also install a specific version:

curl -sSL https://raw.githubusercontent.com/darksworm/traefiktop/main/install.sh | sh -s -- v0.1.0

Pull and run the prebuilt image from GHCR:

docker run --rm -it ghcr.io/darksworm/traefiktop:latest \
  --host https://traefik.example.org

For self-signed endpoints, add --insecure. To reach a Traefik container, attach to its network:

docker run --rm -it --network <traefik_net> ghcr.io/darksworm/traefiktop:latest \
  --host http://traefik:8080

Build locally instead of pulling:

bun run docker:build
bun run docker:run -- --host https://traefik.example.org

npm i --global traefiktop

brew tap darksworm/homebrew-tap
brew install --cask traefiktop

yay -S traefiktop-bin

Grab binaries and packages from the latest release: https://github.com/darksworm/traefiktop/releases/latest

Screenshot

What it shows

• Routers, their rules, and the services they target
• Which router is effectively down (no healthy services)
• The active service path (failover aware)
• Quick, readable status with a minimal set of emojis and colors

Usage

--host is required. Optionally hide routers by name with --ignore patterns (case‑insensitive). Use * at the start/end for “starts with” / “ends with”. Use --insecure to disable TLS verification for development against self‑signed endpoints.

traefiktop --host https://traefik.example.org \
  --ignore staging-* \
  --ignore *-tmp,*-old

Development only (self-signed endpoints):

traefiktop --host https://selfsigned.local --insecure

Keys

• Navigation: j/k or arrows
• Page: PgDn/PgUp, Ctrl+f/Ctrl+b
• Jump: gg (top), G (bottom), Home/End
• Search: / to filter, Esc to clear
• Sort: s toggles (dead first/name); d dead first; n name
• Quit: q or Ctrl+C

Build from source

Prereqs: Bun ≥ 1.2.20, Node ≥ 18

bun install
# Node bundle (dist/cli.js)
bun run build:node
# Native binary (bun compile)
bun run build:binary

Docker

• Prebuilt images are published for releases to ghcr.io/darksworm/traefiktop.
• Local builds work cross‑platform via a multi‑stage Dockerfile.

Pull and run (interactive TTY):

docker run --rm -it ghcr.io/darksworm/traefiktop:latest \
  --host https://traefik.example.org

Build locally and run:

# Build (uses buildx automatically if enabled)
bun run docker:build

# Run (pass CLI flags after image name)
bun run docker:run -- --host https://traefik.example.org

Multi‑arch build with buildx (optional):

docker buildx build \
  --platform linux/amd64,linux/arm64 \
  -t ghcr.io/darksworm/traefiktop:dev .

Notes

• API URL is mandatory. The app won’t start without --host.
• Ignore patterns support: foo* (starts with), *bar (ends with), *mid* (contains). Pass multiple --ignore flags or comma‑separate values.
• When selected, dead routers use a bright red background for better contrast. Active services are colored; inactive/down are grey.