nb
CLI and local web plain text note‑taking, bookmarking, and archiving with linking, tagging, filtering, search, Git versioning & syncing, Pandoc conversion, + mo
What is nb?
CLI and local web plain text note‑taking, bookmarking, and archiving with linking, tagging, filtering, search, Git versioning & syncing, Pandoc conversion, + more, in a single portable script.
Overview of nb
What it is
nb is a command line and local web plain text note‑taking, bookmarking, archiving, and knowledge base application. It stores data in plain text, supports encryption, filtering, pinning, #tagging, and search. It uses Git for automatic versioning and syncing, and Pandoc for document conversion. It includes [[wiki-style linking]], terminal and GUI web browsing, inline images, todos with tasks, global and local notebooks, organization with folders, customizable color themes, and extensibility through plugins. The entire program is contained within a single portable shell script. nb works in any standard Linux / Unix environment, including macOS and Windows via WSL, MSYS, and Cygwin.
Key features
- Plain text data storage with support for Markdown, Org, LaTeX, AsciiDoc, and any file format - Git-backed versioning and syncing with remote repositories - Pandoc-backed conversion for importing and exporting notes to many document formats - Encryption for private, password-protected notes and bookmarks - Bookmarking with locally-served, text-centric browsing, full-text search of cached content, and Internet Archive Wayback Machine snapshot lookup - Tagging, pinning, filtering, search, and [[wiki-style linking]]
- Global and local notebooks, folders, todos with tasks, and customizable color themes
Use cases
nb is designed for note‑taking, bookmarking, archiving, and building a personal knowledge base. It can be used for managing notes in various text formats, organizing bookmarks with cached content, tracking tasks and todos, and maintaining a searchable, versioned archive of information.
Getting started
Install nb using one of the following methods (see the repository README for more options): bash # macOS / Homebrew brew install xwmx/taps/nb # npm npm install -g nb.sh After installation, run nb --help for usage information.
License and pricing
nb is open source under the AGPL-3.0 license. No pricing information is stated.
Based on the project's public README and repository metadata.
