https://github.com/mtth/git-jot
Branch-local git notes
https://github.com/mtth/git-jot
git
Last synced: 6 months ago
JSON representation
Branch-local git notes
- Host: GitHub
- URL: https://github.com/mtth/git-jot
- Owner: mtth
- License: mit
- Created: 2025-07-26T00:18:53.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-08-20T05:24:32.000Z (10 months ago)
- Last Synced: 2025-08-20T06:29:57.154Z (10 months ago)
- Topics: git
- Language: Shell
- Homepage: https://mtth.github.io/git-jot/
- Size: 31.3 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `git-jot(1)`
Bash script to emulate branch notes, useful for [branching workflows][1]. These
branch-local notes (_jottings_):
* persist across commits, merges, and rebases;
* can be shared and stored on remotes;
* inherit all note capabilities (e.g. history).
## Installation
From the [AUR][2], or with [Homebrew][3]:
```sh
brew install mtth/tap/git-jot
```
Otherwise install it manually by copying `git-jot.sh` as `git-jot` somewhere in
your `$PATH`, then making it executable.
## Usage
```sh
$ git jot # Open an editor to add notes to the current branch
$ # Do some work, add some commits, rebase, etc...
$ git jot # View and edit the existing branch note
$ git switch other-branch
$ git jot # Edit a different branch note
$ git switch original-branch
$ git jot -V # View the original branch's note
$ git jot -X # Push the branch's note to its default remote
```
See the [manpage](https://mtth.github.io/git-jot/) for all options and more
information.
## Alternatives
* [Git branch descriptions](https://stackoverflow.com/q/2108405)
* [`git-branchnotes`](https://gitlab.com/mockturtle/git-branchnotes)
* [`git-branch-notes`](https://github.com/ejmr/git-branch-notes)
[1]: https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows
[2]: https://aur.archlinux.org/packages/git-jot-git
[3]: https://brew.sh/