nb

nb

功能丰富的命令行笔记和知识管理工具

nb是一款功能丰富的命令行笔记和知识管理工具。它支持纯文本存储、加密、过滤、置顶、标签和搜索等功能。nb利用Git实现版本控制和同步,集成Pandoc进行格式转换,并提供wiki式链接、终端和GUI浏览、内嵌图像、待办事项管理、笔记本组织等特性。作为单一可移植脚本,nb具有高度的灵活性和可扩展性。

nb命令行笔记书签GitGithub开源项目
<p align="center"></p><!-- spacer --> <div align="center"> <img src="https://raw.githubusercontent.com/xwmx/nb/master/docs/assets/images/nb.png" alt="nb" width="200"> </div> <p align="center"></p><!-- spacer --> <div align="center"> <a href="https://github.com/xwmx/nb/actions" rel="nofollow"> <img src="https://img.shields.io/github/actions/workflow/status/xwmx/nb/tests.yml?branch=master" alt="Build Status" style="max-width:100%;"> </a> </div> <div align="center">&nbsp;</div><!-- spacer --> <br/>

nb is a command line and local web note‑taking, bookmarking, archiving, and knowledge base application with:

and more, in a single portable script.

nb creates notes in text-based formats like Markdown, Org, LaTeX, and AsciiDoc, can work with files in any format, can import and export notes to many document formats, and can create private, password-protected encrypted notes and bookmarks. With nb, you can write notes using Vim, Emacs, VS Code, Sublime Text, and any other text editor you like, as well as terminal and GUI web browsers. nb works in any standard Linux / Unix environment, including macOS and Windows via WSL, MSYS, and Cygwin. Optional dependencies can be installed to enhance functionality, but nb works great without them.

<div align="center"> <img src="https://xwmx.github.io/misc/nb/images/nb-theme-nb-home.png" alt="home" width="450"> </div>

nb is also a powerful bookmarking system featuring:

  • locally-served, text-centric, distraction-free bookmark browsing in terminal and GUI web browsers,
  • local full-text search of cached page content with regular expression support,
  • convenient filtering and listing,
  • Internet Archive Wayback Machine snapshot lookup for broken links,
  • tagging, pinning, linking, and full integration with other nb features.

Page information is downloaded, cleaned up, structured, and saved into normal Markdown documents made for humans, so bookmarks are easy to view and edit just like any other note.

<div align="center"> <img src="https://xwmx.github.io/misc/nb/images/gui-terminal-browse.png" alt="nb browse" width="500"> </div>

nb uses Git in the background to automatically record changes and sync notebooks with remote repositories. nb can also be configured to sync notebooks using a general purpose syncing utility like Dropbox so notes can be edited in other apps on any device.

<div align="center"> <img src="https://xwmx.github.io/misc/nb/images/terminal-empty.png" alt="nb list empty" width="450"> </div>

nb is designed to be portable, future-focused, and vendor independent, providing a full-featured and intuitive experience within a highly composable multimodal user-centric text interface. The entire program is contained within a single well-tested shell script that can be installed, copied, or curled almost anywhere and just work, using a strategy inspired by progressive enhancement for various experience improvements in more capable environments. nb works great whether you have one notebook with just a few notes or dozens of notebooks containing thousands of notes, bookmarks, and other items. nb makes it easy to incorporate other tools, writing apps, and workflows. nb can be used a little, a lot, once in a while, or for just a subset of features. nb is flexible.

<div align="center">&nbsp;</div><!-- spacer --> <div align="center"> <sub> 📝 🔖 🔍 🌍 🔒 ✅ 🔄 🎨 📚 📌 📂 🌄 </sub> </div> <p align="center">&nbsp;</p><!-- spacer --> <div align="center"> <h1 align="center" id="nb"><code>nb</code></h1> </div> <div align="center"> <a href="#installation">Installation</a>&nbsp;· <a href="#overview">Overview</a>&nbsp;&nbsp; </div> <p align="center"></p><!-- spacer --> <div align="center"> <a href="#-help">Help</a> </div> <p align="center"></p><!-- spacer --> <div align="center"> <a href="#top">&nbsp;↑&nbsp;</a> </div>

Installation

Dependencies

Required
Optional

nb leverages standard command line tools and works in standard Linux / Unix environments. nb also checks the environment for some additional optional tools and uses them to enhance the experience whenever they are available.

Recommended:

Also supported for various enhancements:

Ack, afplay, asciidoctor, The Silver Searcher (ag), catimg, Chafa, Chromium / Chrome, eza, ffplay, ImageMagick, glow, GnuPG, highlight, imgcat, joshuto, kitty's icat kitten, lsd, Links, Lynx, mdcat, mdless, mdv, Midnight Commander (mc), mpg123, MPlayer, ncat, netcat, note-link-janitor (via plugin), pdftotext, Pygments, Ranger, readability-cli, rga / ripgrep-all, sc-im, socat, termvisage, termpdf.py, Tidy-Viewer (tv), timg, vifm, viu, VisiData

macOS / Homebrew

brew install xwmx/taps/nb

Installing nb with Homebrew also installs the recommended dependencies above and completion scripts for Bash, Zsh, and Fish.

Install the latest development version from the repository with:

brew install xwmx/taps/nb --head

nb is also available in homebrew-core. Installing it together with the bash formula is recommended:

brew install nb bash

Ubuntu, Windows, and others

npm
npm install -g nb.sh

After npm installation completes, run sudo "$(which nb)" completions install to install Bash and Zsh completion scripts (recommended).

On Ubuntu and WSL, you can run sudo "$(which nb)" env install to install the optional dependencies.

When nb is installed on Windows, socat (MSYS, Cygwin) is recommended.

nb is also available under its original package name, notes.sh, which comes with an extra notes executable wrapping nb.

Download and Install

To install as an administrator, copy and paste one of the following multi-line commands:

# install using wget sudo wget https://raw.github.com/xwmx/nb/master/nb -O /usr/local/bin/nb && sudo chmod +x /usr/local/bin/nb && sudo nb completions install # install using curl sudo curl -L https://raw.github.com/xwmx/nb/master/nb -o /usr/local/bin/nb && sudo chmod +x /usr/local/bin/nb && sudo nb completions install

On Ubuntu and WSL, you can run sudo nb env install to install the optional dependencies.

User-only Installation

To install with just user permissions, simply add the nb script to your $PATH. If you already have a ~/bin directory, for example, you can use one of the following commands:

# download with wget wget https://raw.github.com/xwmx/nb/master/nb -O ~/bin/nb && chmod +x ~/bin/nb # download with curl curl -L https://raw.github.com/xwmx/nb/master/nb -o ~/bin/nb && chmod +x ~/bin/nb

Installing with just user permissions doesn't include the optional dependencies or completions, but nb core functionality works without them. If you have sudo access and want to install the completion scripts and dependencies, run the following command:

sudo nb env install
Make

To install with Make, clone this repository, navigate to the clone's root directory, and run:

sudo make install

This will also install the completion scripts on all systems and the recommended dependencies on Ubuntu and WSL.

bpkg

To install with bpkg:

bpkg install xwmx/nb
basher

To install with basher:

basher install xwmx/nb

Tab Completion

Bash, Fish, and Zsh tab completion should be enabled when nb is installed using the methods above, assuming you have the appropriate system permissions or installed with sudo. If completion isn't working after installing nb, see the completion installation instructions.

Updating

When nb is installed using a package manager like npm or Homebrew, use the package manager's upgrade functionality to update nb to the latest version. When installed via other methods, nb can be updated to the latest version using the nb update subcommand.

Overview

<div align="center"> <a href="#-notes"><code>📝</code>&nbsp;Notes</a>&nbsp;· <a href="#adding">Adding</a>&nbsp;· <a href="#listing--filtering">Listing</a>&nbsp;· <a href="#editing">Editing</a>&nbsp;· <a href="#viewing">Viewing</a>&nbsp;· <a href="#deleting">Deleting</a>&nbsp;· <a href="#-bookmarks"><code>🔖</code>&nbsp;Bookmarks</a>&nbsp;· <a href="#-todos"><code>✅</code>&nbsp;Todos</a>&nbsp;· <a href="#%EF%B8%8F-tasks"><code>✔️</code>&nbsp;Tasks</a>&nbsp;· <a href="#-tagging"><code>🏷</code>&nbsp;Tagging</a>&nbsp;· <a href="#-linking"><code>🔗</code>&nbsp;Linking</a>&nbsp;· <a href="#-browsing"><code>🌍</code>&nbsp;Browsing</a>&nbsp;· <a href="#-images"><code>🌄</code>&nbsp;Images</a>&nbsp;· <a href="#-zettelkasten"><code>🗂</code>&nbsp;Zettelkasten</a>&nbsp;· <a href="#-folders"><code>📂</code>&nbsp;Folders</a>&nbsp;· <a href="#-pinning"><code>📌</code>&nbsp;Pinning</a>&nbsp;· <a href="#-search"><code>🔍</code>&nbsp;Search</a>&nbsp;· <a href="#-moving--renaming"><code>↔</code>&nbsp;Moving&nbsp;&&nbsp;Renaming</a>&nbsp;· <a href="#-revision-history"><code>🗒</code>&nbsp;History</a>&nbsp;· <a href="#-notebooks"><code>📚</code>&nbsp;Notebooks</a>&nbsp;· <a href="#-git-sync"><code>🔄</code>&nbsp;Git&nbsp;Sync</a>&nbsp;· <a href="#%EF%B8%8F-import--export"><code>↕️</code>&nbsp;Import&nbsp;/&nbsp;Export</a>&nbsp;· <a

编辑推荐精选

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

下拉加载更多