Development¶
| Command | What it does |
|---|---|
make build |
build ./peektea |
make install |
build and install to ~/go/bin (and wire up $PATH) |
make start |
live reload via air — rebuilds on every .go save |
make snapshot |
build release archives locally without publishing |
make release |
tag and publish a GitHub release via goreleaser |
Requirements¶
- air for
make start: - goreleaser for
make release/make snapshot:
Stack¶
peektea is built on the Charm stack:
- Bubble Tea — TUI framework (Elm Architecture)
- Bubbles — TUI components (
textinputfor the filter) - Lipgloss — terminal styling
- BurntSushi/toml — config parsing
Releasing¶
make release-notes-init VERSION=v0.x.x— scaffoldrelease-notes/v0.x.x.mdfrom the template- Fill in the release notes (use
IMG:media/file.giffor images — rewritten to raw GitHub URLs at publish time) make release-notes-preview VERSION=v0.x.x— preview the rendered notes without publishingmake bump VERSION=v0.x.x— tag and pushmake release VERSION=v0.x.x— build with goreleaser and publish the GitHub release with rendered notes
Contributing¶
Issues and pull requests are welcome on GitHub.