
xwmx/nb 是一款功能强大的命令行笔记和书签管理工具,支持多种文件格式、标签管理、版本控制、任务管理等功能,旨在为用户提供高效、灵活的个人知识管理解决方案。
核心功能详解
笔记管理:支持创建、编辑、查看和删除笔记,兼容多种文件格式包括 Markdown、Org、LaTeX、AsciiDoc 等,满足不同场景下的记录需求。
书签管理:支持从网页导入书签,自动获取页面标题、摘要和内容,并保存为 Markdown 格式。提供标签管理、内容缓存和全文搜索功能,方便快速查找和回顾重要信息。
任务管理:支持创建、编辑、完成和删除任务,具备子任务和任务列表功能,适用于日常项目管理。
版本控制:基于 Git 进行版本控制,支持自动同步和版本历史记录,确保笔记内容的安全性和可追溯性。
标签管理:支持为笔记和书签添加标签,便于分类和检索。同时提供强大的搜索功能,支持全文搜索和正则表达式匹配。
多笔记本支持:支持创建和管理多个笔记本,每个笔记本可独立配置和同步,方便用户根据不同项目或场景组织内容。
特色功能亮点
纯文本存储:所有内容以易读的文本格式保存,确保长期可访问性和兼容性。
加密保护:支持加密笔记功能,有效保护用户隐私和敏感信息。
终端与网页双界面:支持命令行操作和本地网页浏览两种交互方式,提升使用灵活性。
Wiki风格链接:支持内部链接功能,便于构建互联的个人知识库。
插件扩展:提供丰富的 插件系统,用户可根据实际需求扩展工具功能。
部署安装指南
基础环境要求
- Bash(系统需安装 Bash,可使用 Zsh、Fish 等作为默认 shell)
- Git(用于版本控制和同步)
- 支持命令行的文本编辑器(如 Vim、Emacs、VS Code 等,通过 $EDITOR 环境变量指定)
安装方法
Homebrew 安装(macOS):
npm 安装(跨平台):
手动安装:
- 使用 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 --download
- 或使用 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 --download
- 对于无管理员权限的用户,可安装到用户目录:
wget https://raw.github.com/xwmx/nb/master/nb -O ~/bin/nb && chmod +x ~/bin/nb
(确保 ~/bin 目录已添加到 PATH 环境变量中)
初始化工作区
首次运行 nb 时,系统会自动创建默认的 "home" 笔记本,所有笔记默认存储在 ~/.nb 目录下(全局笔记本)。用户也可通过设置创建本地笔记本,实现更灵活的内容管理。
项目资源
开源地址:xwmx/nb 的源代码托管在 GitHub 上,地址为 https://github.com/xwmx/nb
文档地址:详细使用文档可在项目的 GitHub Wiki 页面查看,涵盖安装指南、使用教程、API 参考和常见问题解答等内容。
|