changelog generator & diff tool
stormlightlabs.github.io/git-storm/
changelog
changeset
markdown
golang
git
1# storm
2
3> Local-first changelog manager with TUIs for review and release.
4
5## Highlights
6
7- **Keep a Changelog native:** unreleased notes live in `.changes/*.md` until you promote them.
8- **Toolchain aware:** `storm bump`/`storm release` can update Cargo, npm, Python, and Deno manifests.
9- **TUI friendly:** commit selectors, diff viewers, and toolchain pickers reuse the same palette and key bindings.
10- **Scriptable CLI:** every subcommand prints concise status messages suitable for CI logs.
11
12## Install
13
14### Homebrew (macOS / Linux)
15
16```sh
17brew install stormlightlabs/tap/storm
18```
19
20The goreleaser workflow keeps the [`stormlightlabs/homebrew-tap`](https://github.com/stormlightlabs/homebrew-tap)
21formula up to date.
22
23### Go toolchain
24
25```sh
26go install github.com/stormlightlabs/git-storm/cmd/storm@latest
27```
28
29## Quick Start
30
31```sh
32storm generate --since v1.2.0 --interactive
33storm unreleased review
34storm release --bump patch --toolchain package.json --tag
35```
36
37## Documentation
38
39- [Introduction](docs/introduction.md)
40- [Quickstart](docs/quickstart.md)
41- [Manual](docs/manual.md)
42- [Development Guide](docs/development.md)
43
44For a deeper dive into release automation, see `PROJECT.md`.
45
46## Contributing
47
48Run the full test suite before opening a PR:
49
50```sh
51go test ./...
52```
53
54Issues and feature ideas are welcome—Storm is intentionally modular so new
55commands and TUIs can be added without touching the entire codebase.