debrief

command module
v0.0.0-...-682de65 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 2, 2026 License: MIT Imports: 32 Imported by: 0

README

Debrief

License Go

Hyper-charged reverse search: a GUI shell history browser, available system-wide via Ctrl+Shift+H.

Available on macOS, Windows, and Linux.

Debrief Demo

  • No more pressing Ctrl+R 100 times — navigate visually.
  • Browse history as a list, explore as a tree, or see your most-used commands.
  • One shortcut to summon it from anywhere in the system.
  • Support bash, zsh, powershell.
  • Find commands even with typos - fuzzy search support.
  • Lightweight, offline, open source - no telemetry, no internet required.

Download

Platform AMD64 ARM64
macOS DMG (amd64) DMG (arm64)
Windows (installer) MSI (amd64) MSI (arm64)
Windows (portable) EXE (amd64) EXE (arm64)
Ubuntu / Debian DEB (amd64) DEB (arm64)
Fedora / RHEL RPM (amd64) RPM (arm64)
Arch Linux PKG (amd64) PKG (arm64)
Any Linux tar.xz (amd64) tar.xz (arm64)

Development

Project follows Conventional Commits naming.

Prerequisites:

# Build & Run:
go run .

# Run tests
go test ./...

# Run linter
golangci-lint run --fix

Architecture

Dependencies point downward: 
  Application → Infrastructure → Domain. 

Exception is `data/shell` → `infra/platform` for OS detection.


Application Layer:
  main.go       -> lifecycle
  app/          -> application state
  ui/           -> immediate-mode GUI rendering
    font/       -> embedded font assets

  Infrastructure Layer:
  infra/
    config/     -> configuration, persistence
    platform/   -> OS-specific path expansion, file ops, platform-detection
    hotkey/     -> global hotkey registration
    window/     -> window show/hide controller
    tray/       -> system tray icon and menu

  Domain Layer:
  data/
    model/      -> entities & value objects
    cmdstore/   -> aggregate: index, search, store
    syntax/     -> domain service: shell command parsing
    shell/      -> domain service: history file ingestion
    tree/       -> domain service: prefix tree build & flatten
    search/     -> domain service: fuzzy search, trigram index, scoring

License

Copyright © 2026 bosiakov

Licensed under MIT (see LICENSE).

The font ui/font/FiraCode-Regular.ttf is licensed under the OFL-1.1. See ui/font/LICENSE for details.

All fonts are legally licensed to Yauheni Basiakou via MyFonts.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
data
infra
autostart
Package autostart manages XDG autostart entries on Linux.
Package autostart manages XDG autostart entries on Linux.
ui

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL