Documentation Index
Fetch the complete documentation index at: https://mintlify.com/xwmx/nb/llms.txt
Use this file to discover all available pages before exploring further.
nb is a command-line and local web note-taking, bookmarking, and archiving tool that lives entirely in a single portable shell script. It combines plain text data storage with powerful organization features — Git-backed versioning, full-text search, tagging, wiki-style linking, encryption, Pandoc conversion, and an in-terminal web browser — all without requiring a server or cloud account.
Installation
Install nb via Homebrew, npm, curl, or make. Works on macOS, Linux, and Windows (WSL/Cygwin).
Quickstart
Start taking notes and bookmarks in minutes with the essential commands.
Core Features
Notes, bookmarks, todos, search, and notebook management explained in depth.
Command Reference
Full reference for every nb subcommand, flag, and option.
What nb Can Do
nb covers a wide range of knowledge-management workflows from a single script:
Notes
Create Markdown, Org, LaTeX, AsciiDoc notes in any editor
Bookmarks
Save URLs with full-text caching and offline search
Todos & Tasks
Track todos with due dates, descriptions, and subtasks
Git Sync
Auto-version and sync notebooks to any Git remote
Encryption
Password-protect individual notes and bookmarks
Web Browsing
Browse and edit notes in terminal or GUI web browsers
Search
Full-text search with regex, tag, and type filters
Tagging & Linking
Hashtag taxonomy and wiki-style cross-linking
Plugins
Extend nb with Bash plugins and custom themes
Get Started
Install nb
Install via Homebrew, npm, or direct download — see Installation for all options.
Explore commands
Every command has built-in help. Browse the Command Reference or run:
Design Philosophy
nb stores everything as plain text files tracked by Git. There is no proprietary format, no lock-in, and no server required. Notes, bookmarks, and todos are all just Markdown files you can read, edit, and version with any tool. nb is designed to work great with zero optional dependencies and even better when tools like bat, pandoc, and rg are available.