Skip to content

JonLD/jot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jot

A smart note-taking CLI/TUI written in Go. Design for developers to quickly capture and organize notes by branch, project, and ticket.

Features

  • Quick note capture - Fast, frictionless note-taking from the command line
  • Smart organization - Notes automatically organized by Git branch, project, and ticket
  • Terminal UI - Clean, keyboard-driven interface with fuzzy search and filtering
  • Intelligent behavior - Single notes open directly, multiple notes show filtered TUI
  • Configurable editor - Use any editor with foreground/background execution options
  • Cross-platform - Works on Windows, macOS, and Linux with SQLite storage
  • Developer-focused - Built for the development workflow

Installation

Install with Go

go install github.com/JonLD/jot@latest

Or build from source

git clone https://github.com/JonLD/jot.git
cd jot
go build

Usage

# Interactive TUI (default)
jot

# Open/create a note by title
jot open "Bug fix notes"

# Branch notes - create/open notes for current Git branch
jot branch                    # Open TUI filtered to current branch, or create new branch note
jot branch "Feature notes"    # Create new note for current branch with specific title

# Project notes - create/open project-wide notes (not branch-specific)
jot proj                      # Open TUI filtered to project-wide notes, or create new project note
jot proj "Architecture docs"  # Create new project-wide note with specific title

Configuration

Editor

By default, notes open in your system's default Markdown editor. To use a specific editor:

# Set Neovim as your editor
jot --editor "nvim"

# Set VS Code
jot --editor "code"

# Set Vim
jot --editor "vim"

# macOS: Set VS Code using open command
jot --editor "open -a 'Visual Studio Code'"

# Run editor in background (new window/tab) - default: false
jot --editor-background "true"

# Run editor in foreground (current terminal) - default
jot --editor-background "false"

Configuration is saved to ~/.jot/config.json.

Neovim Integration

For seamless note-taking from within Neovim, check out the companion plugin:

JonLD/jot.nvim

Development

# Run the application
go run .

# Build
go build

# Run tests
go test ./...

# Format code
go fmt ./...

License

MIT

About

A smart note taking CLI TUI written in Go.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages