brief

brief is a standalone Go CLI backed by SQLite for storing and querying personal notes, decisions, snippets, workflows, and related entries from a terminal or script.

This documentation set is derived from the repository, the design specification in design.md, and behavior verified during dogfooding.

Docs

• Install
• Usage
• Data Model
• Release
• Testing
• Troubleshooting
• Contributing
• Design Spec Notes

Repository Facts

• Module path: github.com/jsldvr/brief
• Entry point: cmd/brief/main.go
• CLI framework: github.com/spf13/cobra
• SQLite driver: modernc.org/sqlite
• TTY detection helper: github.com/mattn/go-isatty
• Embedding backend: Ollama (optional; required for vector/hybrid search)

Current Testing State

• The repo has _test.go files in internal/db, internal/cli, internal/output, internal/tui, and internal/crawl.
• go test ./... is the primary automated validation command.
• A completed manual dogfood/testing pass is recorded in brief.