Home

nt: Note Taking Tool

A minimal, fast CLI note-taking tool with Markdown support, git version control, interactive checkboxes, hyperlinks, and tables. All notes live in ~/.config/nt and every change is auto-committed to git.

---

Wiki Pages

Page	Description
Installation	How to install both editions
Usage	Full command reference
Quick-Append	Add tasks, links, tables and lines without opening an editor
Checkboxes	Check, uncheck, and interactively toggle tasks
Markdown-Cheat-Sheet	Supported Markdown syntax
Git-Integration	Auto-commits, history, remotes, and passthrough commands
Notes-Directory-Layout	Where notes live and how subdirectories work
Configuration	Environment variables and editor setup
Editions	Bash vs Go — differences and trade-offs
Contributing	How to build, test, and submit changes

---

Quick Start

# Install (Go edition)
make install

# Create your first note
nt new meeting

# Append a task without opening an editor
nt add meeting task "Follow up with Alice"

# Check it off
nt check meeting "Follow up with Alice"

# View the note rendered in your terminal
nt show meeting

---

Two Editions

	Bash nt.sh	Go nt-go/
Dependencies	bash 4+, git, sed	Go 1.21+, git
Install	chmod +x nt.sh && sudo cp nt.sh /usr/local/bin/nt	cd nt-go && make install
Portability	Any Unix/macOS	Compile once, run anywhere
Feature parity	✓	✓