[ { "path": ".github/FUNDING.yml", "content": "github: xwmx\ncustom: https://paypal.me/WilliamMelody\n" }, { "path": ".github/workflows/release.yml", "content": "name: Release\n\non:\n push:\n tags:\n - \"[0-9]+.[0-9]+.[0-9]+*\"\n\njobs:\n release:\n name: Release\n runs-on: ubuntu-latest\n steps:\n - name: Checkout code # to upload release assets\n uses: actions/checkout@v4\n - id: major_version\n run: >\n echo major_version=$(\n echo ${{ github.ref }} | cut -d'v' -f2 | cut -d'.' -f1\n ) >> $GITHUB_OUTPUT\n - id: is_release_candidate\n run: >\n echo is_release_candidate=$(\n echo ${{ github.ref }} | grep -c 'rc'\n ) >> $GITHUB_OUTPUT\n - name: Create release\n uses: softprops/action-gh-release@v2\n with:\n prerelease: ${{ steps.major_version.outputs.major_version == 0 || steps.is_release_candidate.outputs.is_release_candidate == 1 }}\n generate_release_notes: true\n files: nb\n" }, { "path": ".github/workflows/tests.yml", "content": "###############################################################################\n# .github/workflows/tests.yml\n#\n# NOTE: GitHub Actions does not allocate a TTY, preventing `nb` from detecting\n# piped input using `[[ -t 0 ]]` in the `_interactive_input()` function.\n#\n# More information:\n#\n# https://github.com/actions/runner/issues/241\n#\n# faketty is a GitHub action that uses work-arounds to provide a tty:\n#\n# https://github.com/marketplace/actions/faketty\n#\n# Scripts used by faketty for each platform:\n#\n# linux: `faketty`\n#\n# ```bash\n# #!/bin/bash\n#\n# script -q -e -c \"$*\"\n# ```\n#\n# win32: `faketty.ps1`\n#\n# ```posh\n# Invoke-Expression \"$args\"\n# ```\n#\n# darwin: `faketty`\n#\n# requires: `brew install expect`\n#\n# ```bash\n# #!/bin/bash\n#\n# unbuffer $*\n# ```\n###############################################################################\n\nname: \"nb · Test Suite\"\n\non:\n pull_request:\n branches: [ master ]\n # push:\n # branches: [ master ]\n workflow_dispatch:\n\njobs:\n # test-ubuntu-aarch64:\n # name: \"Test: Ubuntu AArch64\"\n # runs-on: ubuntu-20.04\n # steps:\n # - uses: actions/checkout@v2.1.0\n # - uses: uraimo/run-on-arch-action@v2\n # # https://github.com/marketplace/actions/run-on-architecture\n # name: Run commands\n # id: runcmd\n # with:\n # arch: aarch64\n # distro: ubuntu20.04\n\n # # Not required, but speeds up builds by storing container images in\n # # a GitHub package registry.\n # # githubToken: ${{ github.token }}\n\n # # Set an output parameter `uname` for use in subsequent steps\n # run: |\n # uname -a\n # echo ::set-output name=uname::$(uname -a)\n # - name: \"Setup\"\n # run: |\n # sudo apt-get update\n # sudo apt-get install bats -y\n # sudo apt-get install ncat -y\n # sudo apt-get install python-pygments -y\n # sudo apt-get install w3m -y\n # curl -LO https://github.com/jgm/pandoc/releases/download/2.17.0.1/pandoc-2.17.0.1-1-amd64.deb\n # sudo dpkg -i pandoc-2.17.0.1-1-amd64.deb\n # curl -LO https://github.com/sharkdp/bat/releases/download/v0.16.0/bat_0.16.0_amd64.deb\n # sudo dpkg -i bat_0.16.0_amd64.deb\n # git config --global user.name \"Example Name\"\n # git config --global user.email \"example@example.com\"\n # - name: \"Install bats-core\"\n # run: |\n # git clone https://github.com/bats-core/bats-core.git \"${HOME}/bats-core\" &&\n # cd \"${HOME}/bats-core\"\n # git checkout 2e2e5df6adf0b846b411b6b2f7bb654cbc3e2c4e\n # sudo ./install.sh /usr/local\n # - name: \"Set $TERM=xterm\"\n # run: printf \"TERM=xterm\\\\n\" >> $GITHUB_ENV\n # - name: \"Run bats tests\"\n # run: script -q -e -c \"bats test/bookmark.bats\"\n # # - name: \"Install Go\"\n # # uses: actions/setup-go@v2\n # # - name: \"Run go test\"\n # # run: cd nb.go && go test\n # # - name: \"Run nb.go bats tests\"\n # # run: script -q -e -c \"bats test\"\n\n # test-ubuntu-armv7:\n # name: \"Test: Ubuntu armv7\"\n # runs-on: ubuntu-20.04\n # steps:\n # - uses: actions/checkout@v2.1.0\n # - uses: uraimo/run-on-arch-action@v2\n # # https://github.com/marketplace/actions/run-on-architecture\n # name: Run commands\n # id: runcmd\n # with:\n # arch: armv7\n # distro: ubuntu20.04\n\n # # Not required, but speeds up builds by storing container images in\n # # a GitHub package registry.\n # # githubToken: ${{ github.token }}\n\n # # Set an output parameter `uname` for use in subsequent steps\n # run: |\n # uname -a\n # echo ::set-output name=uname::$(uname -a)\n # - name: \"Setup\"\n # run: |\n # sudo apt-get update\n # sudo apt-get install bats -y\n # sudo apt-get install ncat -y\n # sudo apt-get install python-pygments -y\n # sudo apt-get install w3m -y\n # curl -LO https://github.com/jgm/pandoc/releases/download/2.17.0.1/pandoc-2.17.0.1-1-amd64.deb\n # sudo dpkg -i pandoc-2.17.0.1-1-amd64.deb\n # curl -LO https://github.com/sharkdp/bat/releases/download/v0.16.0/bat_0.16.0_amd64.deb\n # sudo dpkg -i bat_0.16.0_amd64.deb\n # git config --global user.name \"Example Name\"\n # git config --global user.email \"example@example.com\"\n # - name: \"Install bats-core\"\n # run: |\n # git clone https://github.com/bats-core/bats-core.git \"${HOME}/bats-core\" &&\n # cd \"${HOME}/bats-core\"\n # git checkout 2e2e5df6adf0b846b411b6b2f7bb654cbc3e2c4e\n # sudo ./install.sh /usr/local\n # - name: \"Set $TERM=xterm\"\n # run: printf \"TERM=xterm\\\\n\" >> $GITHUB_ENV\n # - name: \"Run bats tests\"\n # run: script -q -e -c \"bats test/bookmark.bats\"\n # # - name: \"Install Go\"\n # # uses: actions/setup-go@v2\n # # - name: \"Run go test\"\n # # run: cd nb.go && go test\n # # - name: \"Run nb.go bats tests\"\n # # run: script -q -e -c \"bats test\"\n\n test-macos-14:\n name: \"Test: macOS 14 Sonoma\"\n runs-on: macos-14\n steps:\n - uses: actions/checkout@v4\n - name: \"Setup\"\n run: |\n brew update\n brew install bat\n brew install bats-core\n brew install expect\n brew install gpg\n brew install nmap\n brew install pandoc\n brew install ripgrep\n brew install w3m\n gem install asciidoctor\n git config --global user.name \"Example Name\"\n git config --global user.email \"example@example.com\"\n - uses: browser-actions/setup-chrome@v1\n id: setup-chrome\n - run: |\n ${{ steps.setup-chrome.outputs.chrome-path }} --version\n - name: \"Set $TERM=xterm\"\n run: printf \"TERM=xterm\\\\n\" >> $GITHUB_ENV\n - name: \"Run bats tests\"\n run: unbuffer bats test\n # - name: \"Install Go\"\n # uses: actions/setup-go@v2\n # - name: \"Run go test\"\n # run: cd nb.go && go test\n # - name: \"Run nb.go bats test\"\n # run: unbuffer bats test\n # test-macos-12:\n # name: \"Test: macOS 12 Monterey\"\n # runs-on: macos-12\n # steps:\n # - uses: actions/checkout@v3\n # - name: \"Setup\"\n # run: |\n # brew update\n # brew install bat\n # brew install bats-core\n # brew install expect\n # brew install gpg\n # brew install nmap\n # brew install pandoc\n # brew install ripgrep\n # brew install w3m\n # gem install asciidoctor\n # git config --global user.name \"Example Name\"\n # git config --global user.email \"example@example.com\"\n # - uses: browser-actions/setup-chrome@v1\n # id: setup-chrome\n # - run: |\n # ${{ steps.setup-chrome.outputs.chrome-path }} --version\n # - name: \"Set $TERM=xterm\"\n # run: printf \"TERM=xterm\\\\n\" >> $GITHUB_ENV\n # - name: \"Run bats tests\"\n # run: unbuffer bats test\n # # - name: \"Install Go\"\n # # uses: actions/setup-go@v2\n # # - name: \"Run go test\"\n # # run: cd nb.go && go test\n # # - name: \"Run nb.go bats test\"\n # # run: unbuffer bats test\n # test-macos-11:\n # name: \"Test: macOS Big Sur 11.0\"\n # runs-on: macos-11.0\n # steps:\n # - uses: actions/checkout@v3\n # - name: \"Setup\"\n # run: |\n # brew update\n # brew install bat\n # brew install bats-core\n # brew install expect\n # brew install gpg\n # brew install nmap\n # brew install pandoc\n # brew install ripgrep\n # brew install w3m\n # gem install asciidoctor\n # git config --global user.name \"Example Name\"\n # git config --global user.email \"example@example.com\"\n # - name: \"Set $TERM=xterm\"\n # run: printf \"TERM=xterm\\\\n\" >> $GITHUB_ENV\n # - name: \"Run bats tests\"\n # run: unbuffer bats test\n # # - name: \"Install Go\"\n # # uses: actions/setup-go@v2\n # # - name: \"Run go test\"\n # # run: cd nb.go && go test\n # # - name: \"Run nb.go bats test\"\n # # run: unbuffer bats test\n # test-macos-10-15:\n # name: \"Test: macOS Catalina 10.15\"\n # runs-on: macos-10.15\n # steps:\n # - uses: actions/checkout@v1\n # - name: \"Setup\"\n # run: |\n # brew update\n # brew install bat\n # brew unlink bats\n # brew install bats-core\n # brew install expect\n # brew install gpg\n # brew install nmap\n # brew install pandoc\n # brew install w3m\n # git config --global user.name \"Example Name\"\n # git config --global user.email \"example@example.com\"\n # - name: \"Set $TERM=xterm\"\n # run: printf \"TERM=xterm\\\\n\" >> $GITHUB_ENV\n # - name: \"Run bats tests\"\n # run: unbuffer bats test\n # # - name: \"Install Go\"\n # # uses: actions/setup-go@v2\n # # - name: \"Run go test\"\n # # run: cd nb.go && go test\n # # - name: \"Run nb.go bats test\"\n # # run: unbuffer bats test\n test-ubuntu-2404:\n name: \"Test: Ubuntu 24.04\"\n runs-on: ubuntu-24.04\n env:\n LANG: C.UTF-8\n LC_ALL: C.UTF-8\n LC_TYPE: C.UTF-8\n steps:\n - uses: actions/checkout@v1\n - name: \"Setup\"\n run: |\n sudo apt-get update\n sudo apt-get install bats -y\n sudo apt-get install ncat -y\n sudo apt-get install python3-pygments -y\n sudo apt-get install ripgrep -y\n sudo apt-get install w3m -y\n curl -LO https://github.com/jgm/pandoc/releases/download/3.2/pandoc-3.2-1-amd64.deb\n sudo dpkg -i pandoc-3.2-1-amd64.deb\n curl -LO https://github.com/sharkdp/bat/releases/download/v0.24.0/bat_0.24.0_amd64.deb\n sudo dpkg -i bat_0.24.0_amd64.deb\n sudo gem install asciidoctor\n git config --global user.name \"Example Name\"\n git config --global user.email \"example@example.com\"\n - uses: browser-actions/setup-chrome@v1\n id: setup-chrome\n - run: |\n ${{ steps.setup-chrome.outputs.chrome-path }} --version\n - name: \"Set $TERM=xterm\"\n run: printf \"TERM=xterm\\\\n\" >> $GITHUB_ENV\n - name: \"Print encoding variables\"\n run: |\n echo \"'$LANG'\"\n echo \"'$LC_ALL'\"\n echo \"'$LC_TYPE'\"\n - name: \"Run bats tests\"\n run: script -q -e -c \"bats test\"\n # - name: \"Install Go\"\n # uses: actions/setup-go@v2\n # - name: \"Run go test\"\n # run: cd nb.go && go test\n # - name: \"Run nb.go bats tests\"\n # run: script -q -e -c \"bats test\"\n" }, { "path": ".gitignore", "content": ".vagrant\nnb.*\n!nb.go\n!nb.ksh\n!nb.zsh\ntmp\n" }, { "path": ".shellcheckrc", "content": "###############################################################################\n# .shellcheckrc\n#\n# https://github.com/koalaman/shellcheck\n# https://github.com/koalaman/shellcheck/wiki/Ignore\n###############################################################################\n\n# Disable SC1090\n#\n# > Shellcheck can't follow non-constant source.\n#\n# Sourced paths are dependent on the environment in this program.\n#\n# https://github.com/koalaman/shellcheck/wiki/SC1090\ndisable=SC1090\n\n# Disable SC2002\n#\n# I like cats 😸. Redirection is also used in this project.\n#\n# https://github.com/koalaman/shellcheck/wiki/SC2002\ndisable=SC2002\n\n# Disable SC2015\n#\n# This is used in some places as intended.\n#\n# https://github.com/koalaman/shellcheck/wiki/SC2015\ndisable=SC2015\n\n# Disable SC2088\n#\n# \"${HOME}\" is preferred in this project, so tildes in quotes are intended as\n# tildes and are not expected to expand.\n#\n# https://github.com/koalaman/shellcheck/wiki/SC2088\ndisable=SC2088\n\n# Disable SC2120\n#\n# This is being triggered on `_ls`, which is passed arguments in `_main()`.\n# This is likely being triggered because `_ls` is called separately explicitly\n# without arguments.\n#\n# https://github.com/koalaman/shellcheck/wiki/SC2120\n# disable=SC2120\n\n# Disable SC2206 and SC2207\n#\n# `IFS` and `noglob` are set.\n#\n# https://github.com/koalaman/shellcheck/wiki/SC2206\n# https://github.com/koalaman/shellcheck/wiki/SC2207\ndisable=SC2206,SC2207\n\n# Disable SC2317\n#\n# Many commands are invoked indirectly.\n#\n# https://www.shellcheck.net/wiki/SC2317\ndisable=SC2317\n\n# Disable SC2317 and SC2329\n#\n# Many commands are invoked indirectly.\n#\n# https://www.shellcheck.net/wiki/SC2317\n# https://www.shellcheck.net/wiki/SC2329\ndisable=SC2317,SC2329\n" }, { "path": "Baskfile", "content": "#!/usr/bin/env bash\n###############################################################################\n# Baskfile\n#\n# Run With Bask: https://github.com/xwmx/bask\n###############################################################################\n\nexport LANG=en_us.UTF-8\nexport LC_ALL=en_us.UTF-8\n\n###############################################################################\n# Helpers\n###############################################################################\n\n# _sed_i()\n#\n# `sed -i` takes an extension on macOS, but that extension can cause errors in\n# GNU `sed`.\n#\n# https://stackoverflow.com/q/43171648\n# https://stackoverflow.com/a/16746032\n_sed_i() {\n if sed --help >/dev/null 2>&1\n then # GNU\n sed -i \"${@}\"\n else # BSD\n sed -i '' \"${@}\"\n fi\n}\n\n###############################################################################\n# Tasks\n###############################################################################\n\n# g:web ################################################################# g:web\n\ndesc \"g:web\" < \"${_target_file:?}\"\n---\n${_front_matter_lines[*]}\n---\n\n$(cat)\nHEREDOC\n }\n\n printf \"Rebuilt: %s\\\\n\" \"${_target_file:?}\"\n}\n\n# npm:publish ##################################################### npm:publish\n\ndesc \"npm:publish\" <nb<\\/code><\\/h1>\"\n\n printf \"Publishing to npm.\\\\n\"\n while true\n do\n read -r -p \"Proceed? [y/N] \" __yn\n case ${__yn} in\n [Yy]*)\n break\n ;;\n *)\n printf \"Exiting...\\\\n\"\n exit 0\n ;;\n esac\n done\n\n _sed_i -e \"s/^${_h1}$/# \\`nb\\`/g\" \"README.md\"\n\n npm publish\n\n _sed_i -e \"s/^# \\`nb\\`$/${_h1}/g\" \"./README.md\"\n}\n\n# v ######################################################################### v\n\ndesc \"v\" <\n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU Affero General Public License is a free, copyleft license for\nsoftware and other kinds of works, specifically designed to ensure\ncooperation with the community in the case of network server software.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nour General Public Licenses are intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n Developers that use our General Public Licenses protect your rights\nwith two steps: (1) assert copyright on the software, and (2) offer\nyou this License which gives you legal permission to copy, distribute\nand/or modify the software.\n\n A secondary benefit of defending all users' freedom is that\nimprovements made in alternate versions of the program, if they\nreceive widespread use, become available for other developers to\nincorporate. Many developers of free software are heartened and\nencouraged by the resulting cooperation. However, in the case of\nsoftware used on network servers, this result may fail to come about.\nThe GNU General Public License permits making a modified version and\nletting the public access it on a server without ever releasing its\nsource code to the public.\n\n The GNU Affero General Public License is designed specifically to\nensure that, in such cases, the modified source code becomes available\nto the community. It requires the operator of a network server to\nprovide the source code of the modified version running there to the\nusers of that server. Therefore, public use of a modified version, on\na publicly accessible server, gives the public access to the source\ncode of the modified version.\n\n An older license, called the Affero General Public License and\npublished by Affero, was designed to accomplish similar goals. This is\na different license, not a version of the Affero GPL, but Affero has\nreleased a new version of the Affero GPL which permits relicensing under\nthis license.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU Affero General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Remote Network Interaction; Use with the GNU General Public License.\n\n Notwithstanding any other provision of this License, if you modify the\nProgram, your modified version must prominently offer all users\ninteracting with it remotely through a computer network (if your version\nsupports such interaction) an opportunity to receive the Corresponding\nSource of your version by providing access to the Corresponding Source\nfrom a network server at no charge, through some standard or customary\nmeans of facilitating copying of software. This Corresponding Source\nshall include the Corresponding Source for any work covered by version 3\nof the GNU General Public License that is incorporated pursuant to the\nfollowing paragraph.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the work with which it is combined will remain governed by version\n3 of the GNU General Public License.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU Affero General Public License from time to time. Such new versions\nwill be similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU Affero General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU Affero General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU Affero General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n \n Copyright (C) \n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as published\n by the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If your software can interact with users remotely through a computer\nnetwork, you should also make sure that it provides a way for users to\nget its source. For example, if your program is a web application, its\ninterface could display a \"Source\" link that leads users to an archive\nof the code. There are many ways you could offer source, and different\nsolutions will be better for different programs; see section 13 for the\nspecific requirements.\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU AGPL, see\n.\n" }, { "path": "Makefile", "content": "BIN ?= nb\nBIN_BOOKMARK ?= bookmark\nPREFIX ?= /usr/local\n\ninstall:\n\tinstall $(BIN) $(PREFIX)/bin\n\tinstall bin/$(BIN_BOOKMARK) $(PREFIX)/bin\n\t./$(BIN) env install\n\nuninstall:\n\trm -f $(PREFIX)/bin/$(BIN)\n\trm -f $(PREFIX)/bin/$(BIN_BOOKMARK)\n\t./$(BIN) env uninstall\n" }, { "path": "README.md", "content": "

\n\n
\n \"nb\"\n\n
\n\n

\n\n
\n \n \"Build\n \n
\n\n
 
\n
\n\n`nb` is a command line and local web\nnote‑taking, bookmarking, archiving,\nand knowledge base application\nwith:\n\n- plain text data storage,\n- [encryption](#password-protected-encrypted-notes-and-bookmarks),\n- [filtering](#listing--filtering), [pinning](#-pinning), [#tagging](#-tagging), and [search](#-search),\n- [Git](https://git-scm.com/)-backed [versioning](#-revision-history) and [syncing](#-git-sync),\n- [Pandoc](https://pandoc.org/)-backed [conversion](#%EF%B8%8F-import--export),\n- [[wiki-style linking]],\n- terminal and GUI web [browsing](#-browsing),\n- inline [images](#-images),\n- [todos](#-todos) with [tasks](#%EF%B8%8F-tasks),\n- global and local [notebooks](#-notebooks),\n- organization with [folders](#-folders),\n- customizable [color themes](#-color-themes),\n- extensibility through [plugins](#-plugins),\n\nand more, in a single portable script.\n\n`nb` creates notes in text-based formats like\n[Markdown](https://en.wikipedia.org/wiki/Markdown),\n[Org](https://orgmode.org/),\n[LaTeX](https://www.latex-project.org/),\nand [AsciiDoc](https://asciidoc.org/),\ncan work with files in any format,\ncan import and export notes to many document formats,\nand can create private, password-protected encrypted notes and bookmarks.\nWith `nb`, you can write notes using\nVim,\nEmacs,\nVS Code,\nSublime Text,\nand any other text editor you like,\nas well as terminal and GUI web browsers.\n`nb` works in any standard Linux / Unix environment,\nincluding macOS and Windows via WSL, MSYS, and Cygwin.\n[Optional dependencies](#optional) can be installed to enhance functionality,\nbut `nb` works great without them.\n\n
\n \"home\"\n\n
\n\n`nb` is also a powerful [bookmarking](#-bookmarks) system featuring:\n\n- locally-served, text-centric, distraction-free bookmark [browsing](#-browsing)\n in terminal and GUI web browsers,\n- local full-text search of cached page content with regular expression support,\n- convenient filtering and listing,\n- [Internet Archive Wayback Machine](https://archive.org/web/) snapshot lookup\n for broken links,\n- tagging, pinning, linking, and full integration with other `nb` features.\n\nPage information is\ndownloaded,\ncleaned up,\nstructured,\nand saved\ninto normal Markdown documents made for humans,\nso bookmarks are easy to view and edit just like any other note.\n\n
\n \"nb\n
\n\n`nb` uses [Git](https://git-scm.com/) in the background to\nautomatically record changes and sync notebooks with remote repositories.\n`nb` can also be configured to\nsync notebooks using a general purpose syncing utility like Dropbox\nso notes can be edited in other apps on any device.\n\n
\n \"nb\n
\n\n`nb` is designed to be portable, future-focused, and vendor independent,\nproviding a full-featured and intuitive experience within\na highly composable multimodal user-centric text interface.\nThe entire program is contained within\na single [well-tested](#tests) shell script\nthat can be\ninstalled, copied, or `curl`ed almost anywhere and just work,\nusing a strategy inspired by\n[progressive enhancement](https://en.wikipedia.org/wiki/Progressive_enhancement)\nfor various experience improvements in more capable environments.\n`nb` works great whether you have one notebook with just a few notes\nor dozens of notebooks containing thousands of notes, bookmarks, and other items.\n`nb` makes it easy to incorporate other tools, writing apps, and workflows.\n`nb` can be used a little, a lot, once in a while, or for just a subset of features.\n`nb` is flexible.\n\n
 
\n\n
\n \n 📝\n 🔖\n 🔍\n 🌍\n 🔒\n ✅\n 🔄\n 🎨\n 📚\n 📌\n 📂\n 🌄\n \n
\n\n

 

\n\n
\n

nb

\n
\n\n
\n Installation ·\n Overview  \n
\n\n

\n\n
\n Help\n
\n\n

\n\n
\n  ↑ \n
\n\n### Installation\n\n#### Dependencies\n\n##### Required\n\n- [Bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell))\n - `nb` works perfectly with Zsh, fish, and any other shell\n set as your primary login shell,\n the system just needs to have Bash available on it.\n- [Git](https://git-scm.com/)\n- A text editor with command line support, such as:\n - [Vim](https://en.wikipedia.org/wiki/Vim_\\(text_editor\\)),\n - [Emacs](https://en.wikipedia.org/wiki/Emacs),\n - [Visual Studio Code](https://code.visualstudio.com/),\n - [Sublime Text](https://www.sublimetext.com/),\n - [Helix](https://helix-editor.com/),\n - [micro](https://github.com/zyedidia/micro),\n - [nano](https://en.wikipedia.org/wiki/GNU_nano),\n - [Atom](https://atom.io/),\n - [TextMate](https://macromates.com/),\n - [MacDown](https://macdown.uranusjr.com/),\n - [some of these](https://github.com/topics/text-editor),\n - [and many of these.](https://en.wikipedia.org/wiki/List_of_text_editors)\n\n##### Optional\n\n`nb` leverages standard command line tools\nand works in standard Linux / Unix environments.\n`nb` also checks the environment for some additional optional tools and\nuses them to enhance the experience whenever they are available.\n\nRecommended:\n\n- [`bat`](https://github.com/sharkdp/bat)\n- [`ncat`](https://nmap.org/ncat/) or [`socat`](https://www.kali.org/tools/socat/)\n- [`pandoc`](https://pandoc.org/)\n- [`rg`](https://github.com/BurntSushi/ripgrep)\n- [`tig`](https://github.com/jonas/tig)\n- [`w3m`](https://en.wikipedia.org/wiki/W3m)\n\nAlso supported for various enhancements:\n\n[Ack](https://beyondgrep.com/),\n[`afplay`](https://ss64.com/osx/afplay.html),\n[`asciidoctor`](https://asciidoctor.org/),\n[The Silver Searcher (`ag`)](https://github.com/ggreer/the_silver_searcher),\n[`catimg`](https://github.com/posva/catimg),\n[Chafa](https://github.com/hpjansson/chafa),\n[Chromium](https://www.chromium.org) / [Chrome](https://www.google.com/chrome/),\n[`eza`](https://github.com/eza-community/eza),\n[`ffplay`](https://ffmpeg.org/ffplay.html),\n[ImageMagick](https://imagemagick.org/),\n[`glow`](https://github.com/charmbracelet/glow),\n[GnuPG](https://en.wikipedia.org/wiki/GNU_Privacy_Guard),\n[`highlight`](http://www.andre-simon.de/doku/highlight/en/highlight.php),\n[`imgcat`](https://www.iterm2.com/documentation-images.html),\n[`joshuto`](https://github.com/kamiyaa/joshuto),\n[kitty's `icat` kitten](https://sw.kovidgoyal.net/kitty/kittens/icat.html),\n[`lowdown`](https://kristaps.bsd.lv/lowdown),\n[`lsd`](https://github.com/lsd-rs/lsd),\n[Links](https://en.wikipedia.org/wiki/Links_(web_browser)),\n[Lynx](https://en.wikipedia.org/wiki/Lynx_(web_browser)),\n[`mdcat`](https://github.com/swsnr/mdcat),\n[`mdless`](https://github.com/ttscoff/mdless),\n[`mdv`](https://github.com/axiros/terminal_markdown_viewer),\n[Midnight Commander (`mc`)](https://en.wikipedia.org/wiki/Midnight_Commander),\n[`mpg123`](https://en.wikipedia.org/wiki/Mpg123),\n[MPlayer](https://en.wikipedia.org/wiki/MPlayer),\n[`ncat`](https://nmap.org/ncat/),\n[`netcat`](https://netcat.sourceforge.net/),\n[note-link-janitor](https://github.com/andymatuschak/note-link-janitor)\n(via [plugin](https://github.com/xwmx/nb/blob/master/plugins/backlink.nb-plugin)),\n[`pdftotext`](https://en.wikipedia.org/wiki/Pdftotext),\n[Pygments](https://pygments.org/),\n[Ranger](https://ranger.github.io/),\n[readability-cli](https://gitlab.com/gardenappl/readability-cli),\n[`rga` / ripgrep-all](https://github.com/phiresky/ripgrep-all),\n[`sc-im`](https://github.com/andmarti1424/sc-im),\n[`socat`](https://www.kali.org/tools/socat/),\n[`termvisage`](https://github.com/AnonymouX47/termvisage),\n[`termpdf.py`](https://github.com/dsanson/termpdf.py),\n[Tidy-Viewer (`tv`)](https://github.com/alexhallam/tv),\n[`timg`](https://github.com/hzeller/timg),\n[vifm](https://vifm.info/),\n[`viu`](https://github.com/atanunq/viu),\n[VisiData](https://www.visidata.org/)\n\n#### macOS / Homebrew\n\n```bash\nbrew install xwmx/taps/nb\n```\n\nInstalling `nb` with Homebrew also installs\nthe recommended dependencies above\nand completion scripts for Bash, Zsh, and Fish.\n\nInstall the latest development version from the repository with:\n\n```bash\nbrew install xwmx/taps/nb --head\n```\n\n`nb` is also available in\n[homebrew-core](https://github.com/Homebrew/homebrew-core).\nInstalling it together with the `bash` formula is recommended:\n\n```bash\nbrew install nb bash\n```\n\n#### Ubuntu, Windows, and others\n\n##### npm\n\n```bash\nnpm install -g nb.sh\n```\n\nAfter `npm` installation completes, run\n`sudo \"$(which nb)\" completions install`\nto install Bash and Zsh completion scripts (recommended).\n\nOn Ubuntu and WSL, you can\nrun [`sudo \"$(which nb)\" env install`](#env)\nto install the optional dependencies.\n\nWhen `nb` is installed on Windows,\n`socat` ([MSYS](https://packages.msys2.org/package/socat),\n[Cygwin](https://cygwin.com/packages/summary/socat.html)) is recommended.\n\n*`nb` is also available under its original package name,\n[notes.sh](https://www.npmjs.com/package/notes.sh),\nwhich comes with an extra `notes` executable wrapping `nb`.*\n\n##### Download and Install\n\nTo install as an administrator,\ncopy and paste one of the following multi-line commands:\n\n```bash\n# install using wget\nsudo wget https://raw.github.com/xwmx/nb/master/nb -O /usr/local/bin/nb &&\n sudo chmod +x /usr/local/bin/nb &&\n sudo nb completions install --download\n\n# install using curl\nsudo curl -L https://raw.github.com/xwmx/nb/master/nb -o /usr/local/bin/nb &&\n sudo chmod +x /usr/local/bin/nb &&\n sudo nb completions install --download\n```\n\nOn Ubuntu and WSL, you can\nrun [`sudo nb env install`](#env) to install the optional dependencies.\n\n###### User-only Installation\n\nTo install with just user permissions, simply\nadd the `nb` script to your `$PATH`.\nIf you already have a `~/bin` directory, for example, you can\nuse one of the following commands:\n\n```bash\n# download with wget\nwget https://raw.github.com/xwmx/nb/master/nb -O ~/bin/nb && chmod +x ~/bin/nb\n\n# download with curl\ncurl -L https://raw.github.com/xwmx/nb/master/nb -o ~/bin/nb && chmod +x ~/bin/nb\n```\n\nInstalling with just user permissions doesn't include\nthe optional dependencies or completions,\nbut `nb` core functionality works without them.\nIf you have `sudo` access and want\nto install the completion scripts and dependencies, run the following command:\n\n```bash\nsudo nb env install\n```\n\n##### Make\n\nTo install with [Make](https://en.wikipedia.org/wiki/Make_(software)),\nclone this repository, navigate to the clone's root directory, and run:\n\n```bash\nsudo make install\n```\n\nThis will also install the completion scripts on all systems and\nthe recommended dependencies on Ubuntu and WSL.\n\n##### bpkg\n\nTo install with [bpkg](https://github.com/bpkg/bpkg):\n\n```bash\nbpkg install xwmx/nb\n```\n\n##### basher\n\nTo install with [basher](https://www.basher.it/):\n\n```bash\nbasher install xwmx/nb\n```\n\n#### Tab Completion\n\nBash, Fish, and Zsh tab completion should be enabled\nwhen `nb` is installed using the methods above,\nassuming you have the appropriate system permissions or installed with `sudo`.\nIf completion isn't working after installing `nb`, see the\n[completion installation instructions](https://github.com/xwmx/nb/tree/master/etc).\n\n#### Updating\n\nWhen `nb` is installed using a package manager like npm or Homebrew,\nuse the package manager's upgrade functionality to update `nb` to\nthe latest version.\nWhen installed via other methods,\n`nb` can be updated to the latest version using\nthe [`nb update`](#update) subcommand.\n\n## Overview\n\n\n\n

\n\n
\n  ↑ \n
\n\n

\n\nTo get started, simply run:\n\n```bash\nnb\n```\n\n`nb` sets up your initial `home` notebook the first time it runs.\n\nBy default, notebooks and notes are global (at `~/.nb`),\nso they are always available to `nb`\nregardless of the current working directory.\n`nb` also supports [local notebooks](#global-and-local-notebooks).\n\n### 📝 Notes\n\n#### Adding\n\n

\n \n ↑ ·\n nb add,\n nb browse add\n \n

\n\nUse [`nb add`](#add) (shortcuts: [`nb a`](#add), [`nb +`](#add))\nto create new notes:\n\n```bash\n# create a new note in your text editor\nnb add\n\n# create a new note with the filename \"example.md\"\nnb add example.md\n\n# create a new note containing \"This is a note.\"\nnb add \"This is a note.\"\n\n# create a new note with piped content\necho \"Note content.\" | nb add\n\n# create a new password-protected, encrypted note titled \"Secret Document\"\nnb add --title \"Secret Document\" --encrypt\n\n# create a new note in the notebook named \"example\"\nnb example:add \"This is a note.\"\n\n# create a new note in the folder named \"sample\"\nnb add sample/\n```\n\n[`nb add`](#add) with no arguments or input will open the new, blank note\nin your environment's preferred text editor.\nYou can change your editor using\nthe `$EDITOR` environment variable\nor [`nb set editor`](#editor).\n\n`nb` files are [Markdown](https://daringfireball.net/projects/markdown/)\nfiles by default. The default file type can be changed to\nwhatever you like\nusing [`nb set default_extension`](#default_extension).\n\n[`nb add`](#add) has intelligent argument parsing\nand behaves differently depending on the types of arguments it receives.\nWhen a filename with extension is specified,\na new note with that filename is opened in the editor:\n\n```bash\nnb add example.md\n```\n\nWhen a string is specified, a new note is immediately created\nwith that string as the content and without opening the editor:\n\n```bash\n❯ nb add \"This is a note.\"\nAdded: [1] 20200101000000.md\n```\n\n[`nb add `](#add) is useful for quickly jotting down notes directly\nvia the command line. Quoting content is optional, but recommended.\n\nWhen no filename is specified, [`nb add`](#add) uses the current datetime as\nthe filename.\n\n[`nb add`](#add) can also receive piped content, which behaves the same as\n[`nb add `](#add):\n\n```bash\n# create a new note containing \"Note content.\"\n❯ echo \"Note content.\" | nb add\nAdded: [6] 20200101000100.md\n\n# create a new note containing the clipboard contents on macOS\n❯ pbpaste | nb add\nAdded: [7] 20200101000200.md\n\n# create a new note containing the clipboard contents using xclip\n❯ xclip -o | nb add\nAdded: [8] 20200101000300.md\n```\n\nContent can be passed with the [`--content `](#add) option,\nwhich also creates a new note without opening the editor:\n\n```bash\nnb add --content \"Note content.\"\n```\n\nWhen content is piped,\nspecified with [`--content `](#add),\nor passed as a string argument,\nuse the [`--edit`](#add) flag to open the file in the editor\nbefore the change is committed.\n\nThe title, filename, and content can also be specified with long and\nshort options:\n\n```bash\n❯ nb add --filename \"example.md\" -t \"Example Title\" -c \"Example content.\"\nAdded: [9] example.md \"Example Title\"\n```\n\nThe [`-t `](#add) / [`--title <title>`](#add) option also\nsets the filename to the title,\nlowercased with spaces and non-filename characters replaced with underscores:\n\n```bash\n❯ nb add --title \"Example Title\" \"Example content.\"\nAdded: [10] example_title.md \"Example Title\"\n```\n\nTags can be added with the [`--tags <tag1>,<tag2>...`](#add) option, which\ntakes a comma separated list of tags,\nconverts them to [#hashtags](#-tagging),\nand inserts them between the title and content:\n\n```bash\n❯ nb add \"Example content.\" --title \"Tagged Example\" --tags tag1,tag2\nAdded: [11] tagged_example.md \"Tagged Example\"\n\n❯ nb show 11 --print\n# Tagged Example\n\n#tag1 #tag2\n\nExample content.\n```\n\n[Search](#-search) for tagged items with\n[`nb search`](#search) / [`nb q`](#search):\n\n```bash\n# search for items tagged with \"#tag1\"\nnb search --tag tag1\n\n# search for items tagged with \"#tag1\" AND \"#tag2\", short options\nnb q -t tag1 -t tag2\n\n# search for items tagged with \"#tag1\" OR \"#tag2\", arguments\nnb q \\#tag1 --or \\#tag2\n```\n\nFiles can be created with any file type by specifying the extension either\nin the filename (`example.md`),\nthe extension by itself (`.md`),\nor via the [`--type <type>`](#add) option (`--type md`):\n\n```bash\n# open a new Org file in the editor\nnb add example.org\n\n# open a new reStructuredText file in the editor\nnb add --type rst\n\n# open a new JavaScript file in the editor\nnb add .js\n```\n\nCombining a type argument with piped clipboard content provides\na very convenient way to save code snippets using a clipboard utility such as\n`pbpaste`,\n`xclip`,\nor [`pb`](https://github.com/xwmx/pb):\n\n```bash\n# save the clipboard contents as a JavaScript file in the current notebook\npb | nb add .js\n\n# save the clipboard contents as a Rust file in the \"rust\" notebook\n# using the shortcut alias `nb a`\npb | nb a rust: .rs\n\n# save the clipboard contents as a Haskell file named \"example.hs\" in the\n# \"snippets\" notebook using the shortcut alias `nb +`\npb | nb + snippets: example.hs\n```\n\nUse [`nb show`](#show) and [`nb browse`](#browse) to view code snippets\nwith automatic syntax highlighting and\nuse [`nb edit`](#edit) to open in your editor.\n\nThe [`clip` plugin](#clip) can also be used to\ncreate notes from clipboard content.\n\nPiping,\n[`--title <title>`](#add),\n[`--tags <tag-list>`](#add),\n[`--content <content>`](#add),\nand content passed in an argument\ncan be combined as needed\nto create notes with content from multiple input methods and sources\nusing a single command:\n\n```bash\n❯ pb | nb add \"Argument content.\" \\\n --title \"Sample Title\" \\\n --tags tag1,tag2 \\\n --content \"Option content.\"\nAdded: [12] sample_title.md \"Sample Title\"\n\n❯ nb show 12 --print\n# Sample Title\n\n#tag1 #tag2\n\nArgument content.\n\nOption content.\n\nClipboard content.\n```\n\nFor a full list of options available for [`nb add`](#add), run\n[`nb help add`](#add).\n\n##### Password-Protected Encrypted Notes and Bookmarks\n\nPassword-protected notes and [bookmarks](#-bookmarks) are\ncreated with the [`-e`](#add) / [`--encrypt`](#add) flag and\nencrypted with AES-256 using OpenSSL by default.\nGPG is also supported and can be configured with\n[`nb set encryption_tool`](#encryption_tool).\n\nEach protected note and bookmark is\nencrypted individually with its own password.\nWhen an encrypted item is viewed, edited, or opened,\n`nb` will simply prompt for the item's password before proceeding.\nAfter an item is edited,\n`nb` automatically re-encrypts it and saves the new version.\n\nEncrypted notes can be decrypted\nusing the OpenSSL and GPG command line tools directly, so\nyou aren't dependent on `nb` to decrypt your files.\n\n##### Templates\n\nCreate a note based on a template by assigning a template string\nor path to a template file with [`add --template <template>`](#add):\n\n<!-- {% raw %} -->\n```bash\n# create a new note based on a template specified by path\nnb add --template /path/to/example/template\n\n# create a new note based on a template defined as a string\nnb add --template \"{{title}} • {{content}}\"\n```\n<!-- {% endraw %} -->\n\n`nb` template tags are enclosed in double curly brackets.\nSupported tags include:\n\n<dl>\n <dt><code>{{title}}</code></dt>\n <dd>The note title, as specified with\n <a href=\"#add\"><code>add --title <title></code></a></dd>\n <dt><code>{{tags}}</code></dt>\n <dd>A list of hashtags, as specified with\n <a href=\"#add\"><code>add --tags <tag1>,<tag2></code></a></dd>\n <dt><code>{{content}}</code></dt>\n <dd>The note content, as specified with\n <a href=\"#add\"><code>add <content></code></a>,\n <a href=\"#add\"><code>add --content <content></code></a>,\n and piped content.</dd>\n <dt><code>{{date}}</code></dt>\n <dd>The ouput of the system's <code>date</code> command. Use the\n <a href=\"https://man7.org/linux/man-pages/man1/date.1.html\"><code>date</code>\n command options</a> to control formatting, e.g.,\n <code>{{date +\"%Y-%m-%d\"}}</code>.\n </dd>\n</dl>\n\nAn example complete markdown template could look like the following:\n\n<!-- {% raw %} -->\n```\n# {{title}}\n\n{{date +\"%Y-%m-%d\"}}\n\n{{tags}}\n\n{{content}}\n```\n<!-- {% endraw %} -->\n\nTemplates are Bash strings processed with `eval`, so you can use\ncommand substitution (`$(echo \"Example command\")`) to include\nthe output from command line tools and shell code.\n\nA default template can be configured by assigning a string or path\nto the [`$NB_DEFAULT_TEMPLATE`](#nb_default_template) variable\nin your `~/.nbrc` file:\n\n<!-- {% raw %} -->\n```bash\n# set the default template to a path\nexport NB_DEFAULT_TEMPLATE=\"/path/to/example/template\"\n\n# set the default template with a string\nexport NB_DEFAULT_TEMPLATE=\"{{title}} • {{content}}\"\n```\n<!-- {% endraw %} -->\n\nUse [`nb add --no-template`](#add) to skip using a template when\none is assigned.\n\n##### Shortcut Aliases: `nb a`, `nb +`\n\n`nb` includes shortcuts for many commands, including\n[`nb a`](#add) and [`nb +`](#add) for [`nb add`](#add):\n\n```bash\n# create a new note in your text editor\nnb a\n\n# create a new note with the filename \"example.md\"\nnb a example.md\n\n# create a new note containing \"This is a note.\"\nnb + \"This is a note.\"\n\n# create a new note containing the clipboard contents with xclip\nxclip -o | nb +\n\n# create a new note in the notebook named \"example\"\nnb example:a\n```\n\n##### Other Aliases: `nb create`, `nb new`\n\n[`nb add`](#add) can also be invoked with\n[`nb create`](#add) and [`nb new`](#add) for convenience:\n\n```bash\n# create a new note containing \"Example note content.\"\nnb new \"Example note content.\"\n\n# create a new note with the title \"Example Note Title\"\nnb create --title \"Example Note Title\"\n```\n\n##### Adding with `nb browse`\n\nItems can also be added within terminal and GUI web browsers using\n[`nb browse add`](#browse) / [`nb b a`](#browse):\n\n```bash\n❯ nb browse add\n❯nb · home : +\n\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n\n[add]\n```\n\nPass a filename, relative path, and / or notebook name to\ncreate a new note at that location:\n\n```bash\n# open the add form in the browser to create the file \"file.md\" in the folder \"example\"\nnb browse add \"example/file.md\"\n```\n\n[`nb browse add`](#browse) includes options for quickly\npre-populating new notes with content:\n\n```bash\n❯ nb browse add --title \"Example Title\" --content \"Example content.\" --tags tag1,tag2\n❯nb · home : +\n\n[# Example Title ]\n[ ]\n[#tag1 #tag2 ]\n[ ]\n[Example content. ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n\n[add]\n```\n\n[`nb browse add`](#browse) can also be opened with\n[`nb add --browse`](#add) / [`nb a -b`](#add).\n\nFor more information, see [Browsing](#-browsing).\n\n#### Listing & Filtering\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#ls\"><code>nb ls</code></a>,\n <a href=\"#list\"><code>nb list</code></a>,\n <a href=\"#browse\"><code>nb browse</code></a>\n </sup>\n</p>\n\nTo list notes and notebooks, run [`nb ls`](#ls) (shortcut alias: `nb`):\n\n<div align=\"center\">\n <img src=\"https://xwmx.github.io/misc/nb/images/nb-theme-utility-home.png\"\n alt=\"nb ls\"\n width=\"450\">\n</div>\n\nNotebooks are listed above the line,\nwith the current notebook highlighted and/or underlined,\ndepending on terminal capabilities.\n[`nb ls`](#ls) also includes a footer with example commands for easy reference.\nThe notebook header and command footer can be configured or hidden with\n[`nb set header`](#header) and\n[`nb set footer`](#footer).\n\n```bash\n❯ nb ls\nhome\n----\n[3] example.md · \"Example content.\"\n[2] sample.md · \"Sample content.\"\n[1] demo.md · \"- Demo list item one.\"\n```\n\nNotes from the current notebook are listed in the order they were last modified.\nBy default, each note is listed with its\nid, filename, and an excerpt from the first line of the note.\nWhen a note has a title, the title is displayed\ninstead of the filename and first line.\n\nMarkdown titles can be defined within a note using\n[either Markdown `h1` style](https://daringfireball.net/projects/markdown/syntax#header)\nor [YAML front matter](#front-matter):\n\n```markdown\n# Example Title\n```\n\n```markdown\nSample Title\n============\n```\n\n```markdown\n---\ntitle: Demo Title\n---\n```\n\n[Org](https://orgmode.org/),\n[LaTeX](https://www.latex-project.org/),\nand [AsciiDoc](https://asciidoc.org/)\ntitles are recognized in `.org`,`.latex`, and `.asciidoc` / `.adoc` files:\n\n```text\n#+title: Example Org Title\n```\n\n```latex\n\\title{Example LaTeX Title}\n```\n\n```asciidoc\n= Example AsciiDoc Title\n```\n\nOnce defined, titles are displayed in place of the filename and first line\nin the output of [`nb ls`](#ls):\n\n```bash\n❯ nb ls\nhome\n----\n[3] Example Title\n[2] Sample Title\n[1] Demo Title\n```\n\nPass an id, filename, or title to view the listing for that note:\n\n```bash\n❯ nb ls Sample\\ Title\n[2] Sample Title\n\n❯ nb ls 3\n[3] Example Title\n```\n\nIf there is no exact match, `nb` will list items with\ntitles and filenames that fuzzy match the query:\n\n```bash\n❯ nb ls exa\n[3] Example Title\n\n❯ nb ls ample\n[3] Example Title\n[2] Sample Title\n```\n\nMultiple words act like an `OR` filter, listing any\ntitles or filenames that match any of the words:\n\n```bash\n❯ nb ls example demo\n[3] Example Title\n[1] Demo Title\n```\n\nWhen multiple words are quoted, filter titles and filenames for that phrase:\n\n```bash\n❯ nb ls \"example title\"\n[3] Example Title\n```\n\nFor full text search, see [Search](#-search).\n\nTo view excerpts of notes, use the [`--excerpt`](#ls) or [`-e`](#ls) option,\nwhich optionally accepts a length:\n\n```bash\n❯ nb ls 3 --excerpt\n[3] Example Title\n-----------------\n# Example Title\n\nThis is an example excerpt.\n\n❯ nb ls 3 -e 8\n[3] Example Title\n-----------------\n# Example Title\n\nThis is an example excerpt.\n\nMore example content:\n\n- one\n- two\n```\n\nSeveral classes of file types are represented with emoji\n[indicators](#indicators) to make them easily identifiable in lists.\nFor example, bookmarks and encrypted notes are listed with `🔖` and `🔒`:\n\n```bash\n❯ nb ls\nhome\n----\n[4] Example Note\n[3] 🔒 encrypted-note.md.enc\n[2] 🔖 Example Bookmark (example.com)\n[1] 🔖 🔒 encrypted.bookmark.md.enc\n```\n\nFile types include:\n\n```text\n 🔉 Audio\n 📖 Book\n 🔖 Bookmark\n 🔒 Encrypted\n 📂 Folder\n 🌄 Image\n 📄 PDF, Word, or Open Office document\n 📹 Video\n```\n\nBy default, items are listed starting with the most recently modified.\nTo reverse the order, use the [`-r`](#ls) or [`--reverse`](#ls) flag:\n\n```bash\n❯ nb ls\nhome\n----\n[2] Todos\n[3] Example Title\n[1] Ideas\n\n❯ nb ls --reverse\n[1] Ideas\n[3] Example Title\n[2] Todos\n```\n\nNotes can be sorted with the [`-s`](#ls) / [`--sort`](#ls) flag,\nwhich can be combined with [`-r`](#ls) / [`--reverse`](#ls):\n\n```bash\n❯ nb ls\nhome\n----\n[2] Sample Title\n[3] Example Title\n[1] Demo Title\n\n❯ nb ls --sort\n[1] Demo Title\n[2] Sample Title\n[3] Example Title\n\n❯ nb ls --sort --reverse\n[3] Example Title\n[2] Sample Title\n[1] Demo Title\n```\n\n`nb` with no subcommand behaves like an alias for [`nb ls`](#ls),\nso the examples above can be run without the `ls`:\n\n```bash\n❯ nb\nhome\n----\n[2] Sample Title\n[3] Example Title\n[1] Demo Title\n\n❯ nb example\n[3] Example Title\n\n❯ nb 3 --excerpt\n[3] Example Title\n-----------------\n# Example Title\n\nThis is an example excerpt.\n\n❯ nb 3 -e 8\n[3] Example Title\n-----------------\n# Example Title\n\nThis is an example excerpt.\n\nMore example content:\n\n- one\n- two\n\n❯ nb --sort\n[1] Demo Title\n[2] Sample Title\n[3] Example Title\n\n❯ nb --sort --reverse\n[3] Example Title\n[2] Sample Title\n[1] Demo Title\n```\n\nShort options can be combined for brevity:\n\n```bash\n# equivalent to `nb --sort --reverse --excerpt 2` and `nb -s -r -e 2`:\n❯ nb -sre 2\n[3] Example Title\n-----------------\n# Example Title\n\n[2] Sample Title\n----------------\nSample Title\n============\n[1] Demo Title\n--------------\n---\ntitle: Demo Title\n```\n\n`nb` and [`nb ls`](#ls) display the 15 most recently modified items.\nThe default limit can be changed with [`nb set limit <number>`](#limit).\nTo list a different number of items on a per-command basis, use the\n[`-n <limit>`](#ls),\n[`--limit <limit>`](#ls),\n[`--<limit>`](#ls),\n[`-a`](#ls),\nand [`--all`](#ls)\nflags:\n\n```bash\n❯ nb -n 1\nhome\n----\n[5] Example Five\n4 omitted. 5 total.\n\n❯ nb --limit 2\nhome\n----\n[5] Example Five\n[4] Example Four\n3 omitted. 5 total.\n\n❯ nb --3\nhome\n----\n[5] Example Five\n[4] Example Four\n[3] Example Three\n2 omitted. 5 total.\n\n❯ nb --all\nhome\n----\n[5] Example Five\n[4] Example Four\n[3] Example Three\n[2] Example Two\n[1] Example One\n```\n\nLists can be paginated with\n[`-p <number>`](#ls) / [`--page <number>`](#ls),\nwhich paginates by the value of [`nb set limit`](#limit) by\ndefault, or the value of\n[`-n <limit>`](#ls),\n[`--limit <limit>`](#ls),\nor [`--<limit>`](#ls)\nwhen present:\n\n```bash\n❯ nb\nhome\n----\n[6] Example Six\n[5] Example Five\n[4] Example Four\n[3] Example Three\n[2] Example Two\n[1] Example One\n\n❯ nb set limit 3\nNB_LIMIT set to 3\n\n❯ nb --page 1\n[6] Example Six\n[5] Example Five\n[4] Example Four\n\n❯ nb -p 2\n[3] Example Three\n[2] Example Two\n[1] Example One\n\n❯ nb -p 2 --limit 2\n[4] Example Four\n[3] Example Three\n\n❯ nb -p 3 --2\n[2] Example Two\n[1] Example One\n```\n\nList [#tagged](#tagging) items by passing `\\#escaped` or `\"#quoted\"` hashtags\nor tags specified with the [`--tags`](#ls) option. Multiple tags perform an\n`AND` query:\n\n```bash\n# list items in the current notebook tagged with \"#tag1\", escaped\nnb \\#tag1\n\n# list items in the \"example\" notebook tagged with \"#tag2\", quoted\nnb example: \"#tag2\"\n\n# list items in all notebooks tagged with \"#tag1\", long option\nnb \\#tag1 --all\n\n# list items in the current notebook tagged with \"#tag1\" AND \"#tag2\"\nnb \\#tag1 \"#tag2\"\n\n# list items in all notebooks tagged with \"#tag2\" AND \"#tag3\", short option\nnb --tags tag2,tag3 -a\n```\n\n[`nb ls`](#ls) is a combination of\n[`nb notebooks`](#notebooks) and [`nb list`](#list)\nin one view and accepts the same arguments as [`nb list`](#list),\nwhich lists only notes without the notebook list and with no limit by default:\n\n```bash\n❯ nb list\n[100] Example One Hundred\n[99] Example Ninety-Nine\n[98] Example Ninety-Eight\n... lists all notes ...\n[2] Example Two\n[1] Example One\n```\n\nFor more information about options for listing notes, run\n[`nb help ls`](#ls)\nand\n[`nb help list`](#list).\n\n##### Listing with `browse`\n\nItems can be listed within terminal and GUI web browsers using\n[`nb browse`](#browse) / [`nb b`](#browse):\n\n```bash\n❯ nb browse example:sample/demo/\n❯nb · example : sample / demo / +\n\nsearch: [ ]\n\n[example:sample/demo/7] Title Seven\n[example:sample/demo/6] Title Six\n[example:sample/demo/5] Title Five\n[example:sample/demo/4] Title Four\n[example:sample/demo/3] Title Three\n\nnext ❯\n```\n\nFor more information, see [Browsing](#-browsing).\n\n#### Editing\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#edit\"><code>nb edit</code></a>,\n <a href=\"#browse\"><code>nb browse edit</code></a>\n </sup>\n</p>\n\nYou can edit an item in your editor with\n[`nb edit`](#edit) (shortcut: [`nb e`](#edit)):\n\n```bash\n# edit note by id\nnb edit 3\n\n# edit note by filename\nnb edit example.md\n\n# edit note by title\nnb edit \"A Document Title\"\n\n# edit note 12 in the notebook named \"example\"\nnb edit example:12\n\n# edit note 12 in the notebook named \"example\", alternative\nnb example:12 edit\n\n# edit note 12 in the notebook named \"example\", alternative\nnb example:edit 12\n\n# edit the last modified item\nnb edit --last\n```\n\n[`edit`](#edit) and other subcommands that take an identifier\ncan be called with the identifier and subcommand name reversed:\n\n```bash\n# edit note by id\nnb 3 edit\n```\n\n[`nb edit`](#edit) can also receive piped content, which it\nappends to the specified note without opening the editor:\n\n```bash\necho \"Content to append.\" | nb edit 1\n```\n\nContent can be passed with the [`--content <content>`](#edit) option,\nwhich also appends the content without opening the editor:\n\n```bash\nnb edit 1 --content \"Content to append.\"\n```\n\nUse the [`--overwrite`](#edit) option to overwrite existing file content\nand the [`--prepend`](#edit) option to prepend the new content before existing content.\n\nWhen content is piped or specified with [`--content <content>`](#edit),\nuse the [`--edit`](#edit) flag to open the file in the editor\nbefore the change is committed.\n\nEdit the last modified item with [`--last`](#edit) / [`-l`](#edit):\n\n```bash\n# edit the last modified item\nnb edit --last\n\n# edit the last modified item, short option\nnb edit -l\n```\n\n##### Editing Encrypted Notes\n\nWhen a note is encrypted,\n[`nb edit`](#edit) prompts you for the note password,\nopens the unencrypted content in your editor,\nand then automatically reencrypts the note when you are done editing.\n\n##### Shortcut Alias: `nb e`\n\n[`nb edit`](#edit) can be called by the shortcut alias, [`nb e`](#edit):\n\n```bash\n# edit note by id\nnb e 3\n\n# edit note by filename\nnb e example.md\n\n# edit note by title\nnb e \"A Document Title\"\n\n# edit note by id, alternative\nnb 3 e\n\n# edit note 12 in the notebook named \"example\"\nnb e example:12\n\n# edit note 12 in the notebook named \"example\", alternative\nnb example:12 e\n\n# edit note 12 in the notebook named \"example\", alternative\nnb example:e 12\n\n# edit the last modified item, short option\nnb e -l\n```\n\nFor [`nb edit`](#edit) help information, run [`nb help edit`](#edit).\n\n##### Editing with `browse`\n\nItems can be edited within terminal and GUI web browsers using\n[`nb browse edit`](#browse) / [`nb b e`](#browse):\n\n```bash\n❯ nb browse edit text:formats/markdown/123\n❯nb · text : formats / markdown / 123 · ↓ · editing · - | +\n\n[# Daring Fireball: Markdown (daringfireball.net) ]\n[ ]\n[<https://daringfireball.net/projects/markdown/> ]\n[ ]\n[## Related ]\n[ ]\n[- <https://en.wikipedia.org/wiki/Markdown> ]\n[ ]\n[## Comments ]\n[ ]\n[See also: ]\n[ ]\n[- [[text:formats/org]] ]\n[- [[cli:apps/nb]] ]\n[ ]\n[## Tags ]\n[ ]\n\n[save] · last: 2021-01-01 01:00:00\n```\n\nFor more information, see\n[`browse edit`](#browse-edit) and [Browsing](#-browsing).\n\n#### Viewing\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#show\"><code>nb show</code></a>,\n <a href=\"#browse\"><code>nb browse</code></a>,\n <a href=\"#open\"><code>nb open</code></a>,\n <a href=\"#peek\"><code>nb peek</code></a>\n </sup>\n</p>\n\nNotes and other items can be viewed using\n[`nb show`](#show) (shortcut: [`nb s`](#show)):\n\n```bash\n# show note by id\nnb show 3\n\n# show note by filename\nnb show example.md\n\n# show note by title\nnb show \"A Document Title\"\n\n# show note by id, alternative\nnb 3 show\n\n# show note 12 in the notebook named \"example\"\nnb show example:12\n\n# show note 12 in the notebook named \"example\", alternative\nnb example:12 show\n\n# show note 12 in the notebook named \"example\", alternative\nnb example:show 12\n```\n\nBy default, [`nb show`](#show) opens notes in\n[`less`](https://linux.die.net/man/1/less),\nwith syntax highlighting if\n[`bat`](https://github.com/sharkdp/bat),\n[`highlight`](http://www.andre-simon.de/doku/highlight/en/highlight.php),\nor\n[Pygments](https://pygments.org/)\nis installed.\nYou can navigate in `less` using the following keys:\n\n```text\nKey Function\n--- --------\nmouse scroll Scroll up or down\narrow up or down Scroll one line up or down\nf Jump forward one window\nb Jump back one window\nd Jump down one half window\nu Jump up one half window\n/<query> Search for <query>\nn Jump to next <query> match\nq Quit\n```\n\n*If `less` scrolling isn't working in [iTerm2](https://www.iterm2.com/),\ngo to*\n\"Settings\"\n-> \"Advanced\"\n-> \"Scroll wheel sends arrow keys when in alternate screen mode\"\n*and change it to* \"Yes\".\n*[More Info](https://stackoverflow.com/a/37610820)*\n\nUse the [`-p`](#show) / [`--print`](#show) option\nto print to standard output with syntax highlighting:\n\n```bash\n❯ nb show 123 --print\n# Example Title\n\nExample content:\n\n- one\n- two\n- three\n```\n\nUse [`nb show --print --no-color`](#show) to print without syntax highlighting.\n\nWhen [Pandoc](https://pandoc.org/) is available,\nuse the [`-r`](#show) / [`--render`](#show) option to\nrender the note to HTML and open it in your terminal browser:\n\n```bash\nnb show example.md --render\n# opens example.md as an HTML page in w3m, links, or lynx\n```\n\n[`nb show`](#show) also supports previewing other file types in the terminal,\ndepending on the tools available in the environment. To prefer specific tools\nfor certain file types, `nb` provides configuration variables that can be\nset in your `~/.nbrc` file,\nwhich can be opened in your editor with [`nb settings edit`](#settings).\n\nSupported file types and tools include:\n\n- Markdown files ([`$NB_MARKDOWN_TOOL`](#nb_markdown_tool)):\n - [`bat`](https://github.com/sharkdp/bat)\n - [`glow`](https://github.com/charmbracelet/glow)\n - [`lowdown`](https://kristaps.bsd.lv/lowdown)\n - [`mdcat`](https://github.com/swsnr/mdcat)\n - [`mdless`](https://github.com/ttscoff/mdless)\n - [`mdv`](https://github.com/axiros/terminal_markdown_viewer)\n- PDF files:\n - [`termpdf.py`](https://github.com/dsanson/termpdf.py)\n with [kitty](https://sw.kovidgoyal.net/kitty/)\n - [`pdftotext`](https://en.wikipedia.org/wiki/Pdftotext)\n- Audio files ([`$NB_AUDIO_TOOL`](#nb_audio_tool)):\n - [`mplayer`](https://en.wikipedia.org/wiki/MPlayer)\n - [`afplay`](https://ss64.com/osx/afplay.html)\n - [`mpg123`](https://en.wikipedia.org/wiki/Mpg123)\n - [`ffplay`](https://ffmpeg.org/ffplay.html)\n- [Images](#-images) ([`$NB_IMAGE_TOOL`](#nb_image_tool)):\n - [`catimg`](https://github.com/posva/catimg)\n - [Chafa](https://github.com/hpjansson/chafa)\n - [ImageMagick](https://imagemagick.org/) with a terminal that\n supports [sixels](https://en.wikipedia.org/wiki/Sixel)\n - [`imgcat`](https://www.iterm2.com/documentation-images.html) with\n [iTerm2](https://www.iterm2.com/)\n - [kitty's `icat` kitten](https://sw.kovidgoyal.net/kitty/kittens/icat.html)\n - [`termvisage`](https://github.com/AnonymouX47/termvisage)\n - [`timg`](https://github.com/hzeller/timg)\n - [`viu`](https://github.com/atanunq/viu)\n- Folders, Directories, Notebooks ([`$NB_DIRECTORY_TOOL`](#nb_directory_tool)):\n - [`eza`](https://github.com/eza-community/eza)\n - [`joshuto`](https://github.com/kamiyaa/joshuto)\n - [`lsd`](https://github.com/lsd-rs/lsd)\n - [Midnight Commander (`mc`)](https://en.wikipedia.org/wiki/Midnight_Commander)\n - [`ranger`](https://ranger.github.io/)\n - [`vifm`](https://vifm.info/)\n- Word Documents:\n - [Pandoc](https://pandoc.org/) with\n [`w3m`](https://en.wikipedia.org/wiki/W3m) or\n [`links`](https://en.wikipedia.org/wiki/Links_(web_browser))\n- Excel, CSV, TSV, and data files ([`$NB_DATA_TOOL`](#nb_data_tool)):\n - [VisiData](https://www.visidata.org/)\n - [`sc-im`](https://github.com/andmarti1424/sc-im)\n - [Tidy-Viewer (`tv`)](https://github.com/alexhallam/tv)\n- EPUB ebooks:\n - [Pandoc](https://pandoc.org/) with\n [`w3m`](https://en.wikipedia.org/wiki/W3m) or\n [`links`](https://en.wikipedia.org/wiki/Links_(web_browser))\n\nWhen using [`nb show`](#show) with other file types or\nif the above tools are not available,\n[`nb show`](#show) opens files in\nyour system's preferred application for each type.\n\n[`nb show`](#show) also provides [options](#show) for\nquerying information about an item. For example, use the\n[`--added`](#show) / [`-a`](#show) and [`--updated`](#show) / [`-u`](#show)\nflags to print the date and time that an item was added or updated:\n\n```bash\n❯ nb show 2 --added\n2020-01-01 01:01:00 -0700\n\n❯ nb show 2 --updated\n2020-02-02 02:02:00 -0700\n```\n\n[`nb show`](#show) is primarily intended for viewing items within the terminal.\nTo view a file in the system's preferred GUI application, use\n[`nb open`](#open).\nTo [browse](#-browsing) rendered items in terminal and GUI web browsers, use\n[`nb browse`](#browse).\n\nFor full [`nb show`](#show) usage information, run [`nb help show`](#show).\n\n##### Shortcut Alias: `nb s`\n\n[`nb show`](#show) can be called using the shortcut alias [`nb s`](#show):\n\n```bash\n# show note by id\nnb s 3\n\n# show note by filename\nnb s example.md\n\n# show note by title\nnb s \"A Document Title\"\n\n# show note by id, alternative\nnb 3 s\n\n# show note 12 in the notebook named \"example\"\nnb s example:12\n\n# show note 12 in the notebook named \"example\", alternative\nnb example:12 s\n\n# show note 12 in the notebook named \"example\", alternative\nnb example:s 12\n```\n\n##### Alias: `nb view`\n\n[`nb show`](#show) can also be invoked with [`nb view`](#show) for convenience:\n\n```bash\n# show note by id\nnb view 3\n\n# show note by filename\nnb view example.md\n\n# show note by title\nnb view \"A Document Title\"\n\n# show note by id, alternative\nnb 3 view\n```\n\n##### Viewing with `browse`\n\nItems can be viewed within terminal and GUI web browsers using\n[`nb browse`](#browse) / [`nb b`](#browse):\n\n```bash\n❯ nb browse text:formats/markdown/123\n❯nb · text : formats / markdown / 123 · ↓ · edit | +\nDaring Fireball: Markdown (daringfireball.net)\n\nhttps://daringfireball.net/projects/markdown/\n\nRelated\n\n • https://en.wikipedia.org/wiki/Markdown\n\nComments\n\nSee also:\n\n • [[text:formats/org]]\n • [[cli:apps/nb]]\n\nTags\n\n#markup #plain-text\n\nContent\n\nDaring Fireball: Markdown\n\nDownload\n\nMarkdown 1.0.1 (18 KB) — 17 Dec 2004\n\nIntroduction\n\nMarkdown is a text-to-HTML conversion tool for web writers. Markdown allows\nyou to write using an easy-to-read, easy-to-write plain text format, then\nconvert it to structurally valid XHTML (or HTML).\n```\n\nFor more information, see [Browsing](#-browsing).\n\n#### Deleting\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#delete\"><code>nb delete</code></a>,\n <a href=\"#browse\"><code>nb browse delete</code></a>\n </sup>\n</p>\n\nTo delete one or more notes, pass any number of\nids, filenames, titles, and other [selectors](#-selectors)\nto [`nb delete`](#delete) (shortcuts: [`nb d`](#delete), [`nb -`](#delete)):\n\n```bash\n# delete item by id\nnb delete 3\n\n# delete item by filename\nnb delete example.md\n\n# delete item by title\nnb delete \"A Document Title\"\n\n# delete item by id, alternative\nnb 3 delete\n\n# delete item 12 in the notebook named \"example\"\nnb delete example:12\n\n# delete item 12 in the notebook named \"example\", alternative\nnb example:12 delete\n\n# delete item 12 in the notebook named \"example\", alternative\nnb example:delete 12\n\n# delete item 345 in the folder named \"example\"\nnb delete example/345\n\n# delete items with the ids 89, 56, and 21\nnb delete 89 56 21\n```\n\nBy default, [`nb delete`](#delete) will display a confirmation prompt.\nTo skip, use the [`--force`](#delete) / [`-f`](#delete) option:\n\n```bash\nnb delete 3 --force\n```\n\n##### Shortcut Aliases: `nb d`, `nb -`\n\n[`nb delete`](#delete) has the aliases [`nb d`](#delete) and [`nb -`](#delete):\n\n```bash\n# delete note by id\nnb d 3\n\n# delete note by filename\nnb d example.md\n\n# delete note by title\nnb - \"A Document Title\"\n\n# delete note by id, alternative\nnb 3 d\n\n# delete note 12 in the notebook named \"example\"\nnb - example:12\n\n# delete note 12 in the notebook named \"example\", alternative\nnb example:12 d\n\n# delete note 12 in the notebook named \"example\", alternative\nnb example:d 12\n```\n\nFor [`nb delete`](#delete) help information, run [`nb help delete`](#delete).\n\n##### Deleting with `nb browse`\n\nItems can be deleted within terminal and GUI web browsers using\n[`nb browse delete`](#browse) / [`nb b d`](#browse):\n\n```bash\n❯ nb browse delete example:4\n❯nb · example : 4 · ↓ · edit · - | +\n\n deleting\n\n[4] example_file.md \"Example Title\"\n\n [delete]\n\n```\n\nFor more information, see [Browsing](#-browsing).\n\n### 🔖 Bookmarks\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#nb-help\"><code>nb <url></code></a>,\n <a href=\"#browse\"><code>nb browse</code></a>,\n <a href=\"#bookmark\"><code>nb bookmark</code></a>,\n <a href=\"#open\"><code>nb open</code></a>,\n <a href=\"#peek\"><code>nb peek</code></a>,\n <a href=\"#show\"><code>nb show</code></a>\n </sup>\n</p>\n\n`nb` includes a bookmarking system to conveniently\ncreate, annotate, view, search, [browse](#-browsing), and manage\ncollections of bookmarks.\n\n<div align=\"center\">\n <img src=\"https://xwmx.github.io/misc/nb/images/nb-bookmarks-gui-gui-terminal.png\"\n alt=\"nb bookmarks\"\n width=\"450\">\n</div>\n\nBookmarks in `nb` are stored as\n[simple structured Markdown files](#nb-markdown-bookmark-file-format)\ncontaining information extracted from the bookmarked pages.\n\nTo create a new bookmark, pass a URL as the first argument to `nb`:\n\n```bash\nnb https://example.com\n```\n\n`nb` automatically generates a bookmark using information from the page:\n\n```markdown\n# Example Title (example.com)\n\n<https://example.com>\n\n## Description\n\nExample description.\n\n## Content\n\nExample Title\n=============\n\nThis domain is for use in illustrative examples in documents. You may\nuse this domain in literature without prior coordination or asking for\npermission.\n\n[More information\\...](https://www.iana.org/domains/example)\n```\n\n`nb` embeds the page content in the bookmark, making it available for\n[full text search](#-search) with [`nb search`](#search) and\nlocally-served, distraction-free [reading and browsing](#-browsing)\nwith [`nb browse`](#browse).\nWhen [Pandoc](https://pandoc.org/) is installed,\nthe HTML page content is converted to Markdown.\nWhen [readability-cli](https://gitlab.com/gardenappl/readability-cli)\nis installed, markup is cleaned up to focus on content. When\n[Chromium](https://www.chromium.org) or\n[Chrome](https://www.google.com/chrome/) is installed on the system,\n`nb` automatically renders JavaScript-dependent pages\nand saves the resulting markup.\n\nMany shells automatically escape special characters in URLs. If a\nURL contains characters that are preventing it from being saved in full,\nURLs can also be enclosed in quotes when passed to `nb`:\n\n```bash\nnb \"https://example.com#sample-anchor\"\n```\n\nIn addition to caching the page content,\nyou can also include a quote from the page in a\n[`## Quote`](#-quote) section\nusing the\n[`-q <quote>`](#bookmark) / [`--quote <quote>`](#bookmark) option:\n\n```bash\nnb https://example.com --quote \"Example quote line one.\n\nExample quote line two.\"\n```\n```markdown\n# Example Title (example.com)\n\n<https://example.com>\n\n## Description\n\nExample description.\n\n## Quote\n\n> Example quote line one.\n>\n> Example quote line two.\n\n## Content\n\nExample Title\n=============\n\nThis domain is for use in illustrative examples in documents. You may\nuse this domain in literature without prior coordination or asking for\npermission.\n\n[More information\\...](https://www.iana.org/domains/example)\n```\n\nAdd a comment in a [`## Comment`](#-comment) section using the\n[`-c <comment>`](#bookmark) / [`--comment <comment>`](#bookmark) option:\n\n```bash\nnb https://example.com --comment \"Example comment.\"\n```\n```markdown\n# Example Title (example.com)\n\n<https://example.com>\n\n## Description\n\nExample description.\n\n## Comment\n\nExample comment.\n\n## Content\n\nExample Title\n=============\n\nThis domain is for use in illustrative examples in documents. You may\nuse this domain in literature without prior coordination or asking for\npermission.\n\n[More information\\...](https://www.iana.org/domains/example)\n```\n\nAdd related URLs and [linked](#-linking) [selectors](#-selectors)\nto a [`## Related`](#-related) section using the\n[`-r (<url> | <selector>)`](#bookmark) /\n[`--related (<url> | <selector>)`](#bookmark)\noption:\n\n```bash\nnb https://example.com --related example:123 -r https://example.net\n```\n```markdown\n# Example Title (example.com)\n\n<https://example.com>\n\n## Description\n\nExample description.\n\n## Related\n\n- [[example:123]]\n- <https://example.net>\n\n## Content\n\nExample Title\n=============\n\nThis domain is for use in illustrative examples in documents. You may\nuse this domain in literature without prior coordination or asking for\npermission.\n\n[More information\\...](https://www.iana.org/domains/example)\n```\n\nBookmarks can be tagged using the\n[`-t <tag1>,<tag2>...`](#bookmark) /\n[`--tags <tag1>,<tag2>...`](#bookmark) option.\nTags are converted into [#hashtags](#-tagging) and\nadded to a [`## Tags`](#-tags) section:\n\n```bash\nnb https://example.com --tags tag1,tag2\n```\n```markdown\n# Example Title (example.com)\n\n<https://example.com>\n\n## Description\n\nExample description.\n\n## Tags\n\n#tag1 #tag2\n\n## Content\n\nExample Title\n=============\n\nThis domain is for use in illustrative examples in documents. You may\nuse this domain in literature without prior coordination or asking for\npermission.\n\n[More information\\...](https://www.iana.org/domains/example)\n```\n\n[Search](#-search) for tagged bookmarks with\n[`nb search`](#search) / [`nb q`](#search):\n\n```bash\nnb search --tag tag1\n\nnb q -t tag1\n\nnb q \\#tag1\n```\n\n[`nb search`](#search) / [`nb q`](#search)\nautomatically searches archived page content:\n\n```bash\n❯ nb q \"example query\"\n[10] 🔖 example.bookmark.md \"Example Bookmark (example.com)\"\n------------------------------------------------------------\n5:Lorem ipsum example query.\n```\n\nBookmarks can also be encrypted:\n\n```bash\n# create a new password-protected, encrypted bookmark\nnb https://example.com --encrypt\n```\n\nEncrypted bookmarks require a password before they can be viewed or\nopened.\n\nMultiple URLs can be bookmarked with a single command by passing\nmultiple [`<url>`](#bookmark) arguments. Additional arguments will be reused\nfor each bookmark:\n\n```bash\n❯ nb https://example.com https://example.net --tags tag1,tag2 --filename example\nAdded: [1] 🔖 example.bookmark.md \"Example Domain (example.com)\"\nAdded: [2] 🔖 example-1.bookmark.md \"Example Domain (example.net)\"\n```\n\n#### Listing and Filtering Bookmarks\n\n<div align=\"center\">\n <img src=\"https://xwmx.github.io/misc/nb/images/nb-bookmarks-gui-terminal-terminal.png\"\n alt=\"nb bookmark lists\"\n width=\"500\">\n</div>\n\nBookmarks are included in\n`nb`,\n[`nb ls`](#ls),\n[`nb list`](#list),\nand [`nb browse`](#browse)\nalong with items of other types.\n[`nb bookmark`](#bookmark) and [`nb bookmark list`](#bookmark) can be used to\nlist and filter only bookmarks:\n\n```bash\n❯ nb bookmark\nAdd: nb <url> Help: nb help bookmark\n------------------------------------\n[3] 🔖 🔒 example.bookmark.md.enc\n[2] 🔖 Bookmark Two (example.com)\n[1] 🔖 Bookmark One (example.com)\n\n❯ nb bookmark list two\n[2] 🔖 Bookmark Two (example.com)\n```\n\nBookmarks are also included in `nb`, [`nb ls`](#ls), and [`nb list`](#list):\n\n```bash\n❯ nb\nhome\n----\n[7] 🔖 Bookmark Three (example.com)\n[6] Example Note\n[5] 🔖 Bookmark Two (example.net)\n[4] Sample Note\n[3] 🔖 🔒 example-encrypted.bookmark.md.enc\n[2] Demo Note\n[1] 🔖 Bookmark One (example.com)\n```\n\nUse the [`--type <type>`](#ls) / [`--<type>`](#ls)\noption as a filter to display only bookmarks:\n\n```bash\n❯ nb --type bookmark\n[7] 🔖 Bookmark Three (example.com)\n[5] 🔖 Bookmark Two (example.net)\n[3] 🔖 🔒 example-encrypted.bookmark.md.enc\n[1] 🔖 Bookmark One (example.com)\n\n❯ nb --bookmark\n[7] 🔖 Bookmark Three (example.com)\n[5] 🔖 Bookmark Two (example.net)\n[3] 🔖 🔒 example-encrypted.bookmark.md.enc\n[1] 🔖 Bookmark One (example.com)\n```\n\n`nb` saves the domain in the title, making it easy to filter by domain\nusing any list subcommands:\n\n```bash\n❯ nb example.com\n[7] 🔖 Bookmark Three (example.com)\n[1] 🔖 Bookmark One (example.com)\n```\n\nFor more listing options, see\n[`nb help ls`](#ls),\n[`nb help list`](#list),\nand [`nb help bookmark`](#bookmark).\n\n##### Shortcut Aliases: `nb bk`, `nb bm`\n\n[`nb bookmark`](#bookmark) can also be used with the aliases\n[`nb bk`](#bookmark) and [`nb bm`](#bookmark):\n\n```bash\n❯ nb bk\nAdd: nb <url> Help: nb help bookmark\n------------------------------------\n[7] 🔖 Bookmark Three (example.com)\n[5] 🔖 Bookmark Two (example.net)\n[3] 🔖 🔒 example-encrypted.bookmark.md.enc\n[1] 🔖 Bookmark One (example.com)\n\n❯ nb bm example.net\n[5] 🔖 Bookmark Two (example.net)\n```\n\n#### Viewing Bookmarks\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#browse\"><code>nb browse</code></a>,\n <a href=\"#open\"><code>nb open</code></a>,\n <a href=\"#peek\"><code>nb peek</code></a>,\n <a href=\"#show\"><code>nb show</code></a>\n </sup>\n</p>\n\n`nb` provides multiple ways to view bookmark files, bookmarked content,\nand bookmarked URLs.\n\nUse [`nb browse`](#browse) (shortcut: [`nb b`](#browse))\nto [browse](#-browsing) bookmarks with cached content,\n<a href=\"#-linking\">[[wiki-style links]]</a>,\nlinked [#tags](#-tagging), and external links:\n\n```bash\n❯ nb browse text:formats/markdown/123\n❯nb · text : formats / markdown / 123 · ↓ · edit | +\nDaring Fireball: Markdown (daringfireball.net)\n\nhttps://daringfireball.net/projects/markdown/\n\nRelated\n\n • https://en.wikipedia.org/wiki/Markdown\n\nComments\n\nSee also:\n\n • [[text:formats/org]]\n • [[cli:apps/nb]]\n\nTags\n\n#markup #plain-text\n\nContent\n\nDaring Fireball: Markdown\n\nDownload\n\nMarkdown 1.0.1 (18 KB) — 17 Dec 2004\n\nIntroduction\n\nMarkdown is a text-to-HTML conversion tool for web writers. Markdown allows\nyou to write using an easy-to-read, easy-to-write plain text format, then\nconvert it to structurally valid XHTML (or HTML).\n```\n\nFor more information, see [Browsing](#-browsing).\n\n[`nb open`](#open) (shortcut: [`nb o`](#open)) opens the bookmarked URL in\nyour system's primary web browser:\n\n```bash\n# open bookmark by id\nnb open 3\n\n# open bookmark 12 in the notebook named \"example\"\nnb open example:12\n\n# open bookmark 12 in the notebook named \"example\", alternative\nnb example:12 open\n\n# open bookmark 12 in the notebook named \"example\", alternative\nnb example:open 12\n```\n\n*N.B. To use [`nb open`](#open) with\n[WSL](https://docs.microsoft.com/en-us/windows/wsl/install),\ninstall [wslu](https://github.com/wslutilities/wslu).*\n\n[`nb peek`](#peek) (shortcut: [`nb p`](#peek), alias: [`nb preview`](#peek))\nopens the bookmarked URL in your terminal web browser,\nsuch as\n[w3m](https://en.wikipedia.org/wiki/W3m),\n[Links](https://en.wikipedia.org/wiki/Links_(web_browser)), or\n[Lynx](https://en.wikipedia.org/wiki/Lynx_(web_browser)):\n\n```bash\n# peek bookmark by id\nnb peek 3\n\n# peek bookmark 12 in the notebook named \"example\"\nnb peek example:12\n\n# peek bookmark 12 in the notebook named \"example\", alternative\nnb example:12 peek\n\n# peek bookmark 12 in the notebook named \"example\", alternative\nnb example:peek 12\n```\n\n[`nb open`](#open) and [`nb peek`](#peek)\nwork seamlessly with encrypted bookmarks.\n`nb` simply prompts you for the bookmark's password.\n\n[`nb open`](#open) and [`nb peek`](#peek)\nautomatically check whether the URL is still valid.\nIf the page has been removed, `nb` can check\nthe [Internet Archive Wayback Machine](https://archive.org/web/)\nfor an archived copy.\n\nThe preferred terminal web browser can be set using\nthe `$BROWSER` environment variable,\nassigned in `~/.bashrc`, `~/.zshrc`, or similar:\n\n```bash\nexport BROWSER=lynx\n```\n\nWhen `$BROWSER` is not set, `nb` looks for\n[`w3m`](https://en.wikipedia.org/wiki/W3m),\n[`links`](https://en.wikipedia.org/wiki/Links_(web_browser)), and\n[`lynx`](https://en.wikipedia.org/wiki/Lynx_(web_browser))\nand uses the first one it finds.\n\n`$BROWSER` can also be used to easy specify the terminal browser for\nan individual command:\n\n```bash\n❯ BROWSER=links nb 12 peek\n# opens the URL from bookmark 12 in links\n\n❯ BROWSER=w3m nb 12 peek\n# opens the URL from bookmark 12 in w3m\n```\n\n[`nb show`](#show) and [`nb edit`](#edit)\ncan also be used to view and edit bookmark files,\nwhich include the cached page converted to Markdown.\n\n[`nb show <id> --render`](#show) / [`nb show <id> -r`](#show)\ndisplays the bookmark file converted to HTML in the terminal web browser,\nincluding all bookmark fields and the cached page content,\nproviding a cleaned-up, distraction-free, locally-served view of\nthe page content along with all of your notes.\n\n##### Shortcut Aliases: `nb o` and `nb p`\n\n[`nb open`](#open) and [`nb peek`](#peek)\ncan also be used with the shortcut aliases\n[`nb o`](#open) and [`nb p`](#peek):\n\n```bash\n# open bookmark by id\nnb o 3\n\n# open bookmark 12 in the notebook named \"example\"\nnb o example:12\n\n# open bookmark 12 in the notebook named \"example\", alternative\nnb example:12 o\n\n# peek bookmark by id\nnb p 3\n\n# peek bookmark 12 in the notebook named \"example\"\nnb p example:12\n\n# peek bookmark 12 in the notebook named \"example\", alternative\nnb example:12 p\n```\n\n#### Bookmark File Format\n\nBookmarks are identified by a `.bookmark.md` file extension.\nThe bookmark URL is the first URL in the file within `<` and `>` characters.\nTo create a minimally valid bookmark file with [`nb add`](#add):\n\n```bash\nnb add example.bookmark.md --content \"<https://example.com>\"\n```\n\nFor a full overview, see\n[`nb` Markdown Bookmark File Format](#nb-markdown-bookmark-file-format).\n\n#### `bookmark` -- A command line tool for managing bookmarks.\n\n`nb` includes [`bookmark`](#bookmark-help), a full-featured\ncommand line interface for creating, viewing, searching, and editing bookmarks.\n\n[`bookmark`](#bookmark-help) is a shortcut for the\n[`nb bookmark`](#bookmark) subcommand,\naccepting all of the same subcommands and options with identical behavior.\n\nBookmark a page:\n\n```bash\n❯ bookmark https://example.com --tags tag1,tag2\nAdded: [3] 🔖 20200101000000.bookmark.md \"Example Title (example.com)\"\n```\nList and filter bookmarks with\n[`bookmark`](#bookmark) and [`bookmark list`](#bookmark):\n\n```bash\n❯ bookmark\nAdd: bookmark <url> Help: bookmark help\n---------------------------------------\n[3] 🔖 🔒 example.bookmark.md.enc\n[2] 🔖 Example Two (example.com)\n[1] 🔖 Example One (example.com)\n\n❯ bookmark list two\n[2] 🔖 Example Two (example.com)\n```\n\nView a bookmark in your terminal web browser:\n\n```bash\nbookmark peek 2\n```\n\nOpen a bookmark in your system's primary web browser:\n\n```bash\nbookmark open 2\n```\n\nPerform a full text search of bookmarks and archived page content:\n\n```bash\n❯ bookmark search \"example query\"\n[10] 🔖 example.bookmark.md \"Example Bookmark (example.com)\"\n------------------------------------------------------------\n5:Lorem ipsum example query.\n```\n\nSee [`bookmark help`](#bookmark-help) for more information.\n\n### ✅ Todos\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#do\"><code>nb do</code></a>,\n <a href=\"#tasks\"><code>nb tasks</code></a>,\n <a href=\"#todo\"><code>nb todo</code></a>,\n <a href=\"#undo\"><code>nb undo</code></a>\n </sup>\n</p>\n\nUse [`nb todo`](#todo) (shortcut: [`nb to`](#todo))\nto create, list, and update todos.\n`nb` todos are [structured Markdown documents](#nb-markdown-todo-file-format)\nreferencing a single primary todo,\nwith optional [tasks](#%EF%B8%8F-tasks).\n\nUse [`nb todo add`](#todo) to create a new todo:\n\n```bash\n# create a new todo titled \"Example todo one.\"\n❯ nb todo add \"Example todo one.\"\nAdded: [1] ✔️ [ ] Example todo one.\n\n❯ nb show 1 --print\n# [ ] Example todo one.\n```\n\nUse the [`--due <date>`](#todo) option to add an optional due date in a\n[`## Due`](#-due) section:\n\n```bash\n# create a new todo titled \"Example todo two.\" with a due date of \"2100-01-01\"\n❯ nb todo add \"Example todo two.\" --due \"2100-01-01\"\nAdded: [2] ✔️ [ ] Example todo two.\n\n❯ nb show 2 --print\n# [ ] Example todo two.\n\n## Due\n\n2100-01-01\n```\n\nAdd an optional [description](#-description-1) with the\n[`--description <description>`](#todo)\noption:\n\n```bash\n❯ nb todo add \"Example todo three.\" --description \"Example description.\"\nAdded: [3] ✔️ [ ] Example todo three.\n\n❯ nb show 3 --print\n# [ ] Example todo three.\n\n## Description\n\nExample description.\n```\n\nTodos can have [tasks](#%EF%B8%8F-tasks).\nTasks added with one or more [`--task <task>`](#todo) options\nare represented as a markdown task list and placed in a\n[`## Tasks`](#-tasks) section:\n\n```bash\n❯ nb todo add \"Example todo seven.\" --task \"Task one.\" --task \"Task two.\" --task \"Task three.\"\nAdded: [7] ✔️ [ ] Example todo seven.\n\n❯ nb show 7 --print\n# [ ] Example todo seven.\n\n## Tasks\n\n- [ ] Task one.\n- [ ] Task two.\n- [ ] Task three.\n```\n\nRelated URLs and [linked](#-linking) [selectors](#-selectors)\ncan be added to a [`## Related`](#-related-1) field using the\n[`-r (<url> | <selector>)`](#todo) / [`--related (<url> | <selector>)`](#todo)\noption:\n\n```bash\n❯ nb todo add \"Example todo four.\" --related example:123 -r https://example.com\nAdded: [4] ✔️ [ ] Example todo four.\n\n❯ nb show 4 --print\n# [ ] Example todo four.\n\n## Related\n\n- [[example:123]]\n- <https://example.com>\n```\n\n[Tags](#-tagging) can be added to todos with the\n[`--tags <tag1>,<tag2>...`](#todo) option:\n\n```bash\n❯ nb todo add \"Example todo five.\" --tags tag1,tag2\nAdded: [5] ✔️ [ ] Example todo five.\n\n❯ nb show 5 --print\n# [ ] Example todo five.\n\n## Tags\n\n#tag1 #tag2\n```\n\n[Tags](#-tagging), [links](#-linking), and URLs can be\n[browsed](#-browsing)\nin terminal and GUI web browsers with [`nb browse`](#browse).\n\n#### Listing Todos\n\nList todos in with [`nb todos`](#todo):\n\n```bash\n# list todos in the current notebook\n❯ nb todos\n[6] ✔️ [ ] Example todo six.\n[5] ✅ [x] Example todo five.\n[4] ✔️ [ ] Example todo four.\n[3] ✅ [x] Example todo three.\n[2] ✅ [x] Example todo two.\n[1] ✔️ [ ] Example todo one.\n\n# list todos in the notebook named \"sample\"\n❯ nb todos sample:\n[sample:4] ✅ [x] Sample todo four.\n[sample:3] ✔️ [ ] Sample todo three.\n[sample:2] ✔️ [ ] Sample todo two.\n[sample:1] ✅ [x] Sample todo one.\n\n```\n\nOpen / undone todos can be listed with [`nb todos open`](#todo):\n\n```bash\n# list open todos in the current notebook\n❯ nb todos open\n[6] ✔️ [ ] Example todo six.\n[4] ✔️ [ ] Example todo four.\n[1] ✔️ [ ] Example todo one.\n\n# list open todos in the notebook named \"sample\"\n❯ nb tasks open sample:\n[sample:3] ✔️ [ ] Sample todo three.\n[sample:2] ✔️ [ ] Sample todo two.\n```\n\nClosed / done todos can be listed with [`nb todos closed`](#todo):\n\n```bash\n# list closed todos in the current notebook\n❯ nb todos closed\n[5] ✅ [x] Example todo five.\n[3] ✅ [x] Example todo three.\n[2] ✅ [x] Example todo two.\n\n# list closed todos in the notebook named \"sample\"\n❯ nb tasks closed sample:\n[sample:4] ✅ [x] Sample todo four.\n[sample:1] ✅ [x] Sample todo one.\n```\n\nSee\n[`nb help todo`](#todo)\nfor more information.\n\n#### `do` / `undo`\n\nMark a todo as done or closed with [`nb do`](#do):\n\n```bash\n# add a new todo titled \"Example todo six.\"\n❯ nb todo add \"Example todo six.\"\nAdded: [6] ✔️ [ ] Example todo six.\n\n# mark todo 6 as done / closed\n❯ nb do 6\nDone: [6] ✅ [x] Example todo six.\n```\n\nRe-open a closed todo with [`nb undo`](#undo):\n\n```bash\n# mark todo 6 as undone / open\n❯ nb undo 6\nUndone: [6] ✔️ [ ] Example todo six.\n```\n\nSee\n[`nb help do`](#do)\nand\n[`nb help undo`](#undo)\nfor more information.\n\n### ✔️ Tasks\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#do\"><code>nb do</code></a>,\n <a href=\"#tasks\"><code>nb tasks</code></a>,\n <a href=\"#todo\"><code>nb todo</code></a>,\n <a href=\"#undo\"><code>nb undo</code></a>\n </sup>\n</p>\n\n`nb` can list and update tasks in [todos](#-todos) and other Markdown documents.\n\nTasks are defined as one or more Markdown list items starting with\n`- [ ]` to indicate an open task or `- [x]` to indicate a done / closed task:\n\n```markdown\n- [ ] Example open task.\n- [x] Example closed task.\n```\n\nList tasks in items, folders, and notebooks with\n[`nb tasks`](#tasks) (shortcut: [`nb t`](#tasks)),\nwhich lists both tasks and todos:\n\n```bash\n# list tasks in item 7\n❯ nb tasks 7\n[7] ✔️ [ ] Example todo seven.\n------------------------------\n[7 1] [x] Task one.\n[7 2] [x] Task two.\n[7 3] [ ] Task three.\n\n# list tasks and todos in the notebook named \"example\"\n❯ nb tasks example:\n[example:9] ✔️ [ ] Example todo nine.\n[example:8] ✅ [x] Example todo eight.\n--------------------------------------\n[example:8 1] [x] Task one.\n[example:8 2] [x] Task two.\n\n[example:6] ✔️ [ ] Example todo six.\n[example:4] Example Note Title\n------------------------------\n[example:4 1] [ ] Task one.\n[example:4 2] [x] Task two.\n[example:4 3] [ ] Task three.\n\n[example:3] ✔️ [ ] Example todo three.\n```\n\nOpen / undone tasks can be listed with [`nb tasks open`](#tasks):\n\n```bash\n# list open tasks in item 7\n❯ nb tasks open 7\n[7] ✔️ [ ] Example todo seven.\n------------------------------\n[7 3] [ ] Task three.\n\n# list open tasks and todos in the notebook named \"example\"\n❯ nb tasks open example:\n[example:9] ✔️ [ ] Example todo nine.\n[example:6] ✔️ [ ] Example todo six.\n[example:4] Example Note Title\n------------------------------\n[example:4 1] [ ] Task one.\n[example:4 3] [ ] Task three.\n\n[example:3] ✔️ [ ] Example todo three.\n```\n\nClosed / done tasks can be listed with [`nb tasks closed`](#tasks):\n\n```bash\n# list closed tasks in item 7\n❯ nb tasks closed 7\n[7] ✔️ [ ] Example todo seven.\n------------------------------\n[7 1] [x] Task one.\n[7 2] [x] Task two.\n\n# list closed tasks and todos in the notebook named \"example\"\n❯ nb tasks closed example:\n[example:8] ✅ [x] Example todo eight.\n--------------------------------------\n[example:8 1] [x] Task one.\n[example:8 2] [x] Task two.\n\n[example:4] Example Note Title\n------------------------------\n[example:4 2] [x] Task two.\n```\n\nTasks are identified by the item [selector](#-selectors), followed by\na space, then followed by the sequential number of the task in the file.\n\nUse [`nb do`](#do) to mark tasks as done / closed:\n\n```bash\n# list tasks in item 9\n❯ nb tasks 9\n[9] ✔️ [ ] Example todo nine.\n-----------------------------\n[9 1] [ ] Task one.\n[9 2] [ ] Task two.\n[9 3] [ ] Task three.\n\n# mark task 2 in item 9 as done / closed\n❯ nb do 9 2\n[9] ✔️ [ ] Example todo nine.\n-----------------------------\nDone: [9 2] [x] Task two.\n\n# list tasks in item 9\n❯ nb tasks 9\n[9] ✔️ [ ] Example todo nine.\n-----------------------------\n[9 1] [ ] Task one.\n[9 2] [x] Task two.\n[9 3] [ ] Task three.\n```\n\nUndo a done / closed task with [`nb undo`](#undo):\n\n```bash\n# mark task 2 in item 9 as undone / open\n❯ nb undo 9 2\n[9] ✔️ [ ] Example todo nine.\n-----------------------------\nUndone: [9 2] [ ] Task two.\n\n# list tasks in item 9\n❯ nb tasks 9\n[9] ✔️ [ ] Example todo nine.\n-----------------------------\n[9 1] [ ] Task one.\n[9 2] [ ] Task two.\n[9 3] [ ] Task three.\n```\n\nSee\n[`nb help tasks`](#tasks)\nfor more information.\n\n### 🏷 #tagging\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#add\"><code>nb add</code></a>,\n <a href=\"#bookmark\"><code>nb bookmark</code></a>,\n <a href=\"#browse\"><code>nb browse</code></a>,\n <a href=\"#list\"><code>nb list</code></a>,\n <a href=\"#ls\"><code>nb ls</code></a>,\n <a href=\"#search\"><code>nb search</code></a>\n </sup>\n</p>\n\nTagging is a flexible and powerful way to organize, filter, and discover your\nnotes, bookmarks, and todos in `nb`.\n\nTags in `nb` are written as `#hashtags`\nand can be placed anywhere within a document. A hashtag is defined as a `#`\ncharacter followed by any number of letters, numbers, underscores, or dashes,\nallowing you to create custom categories or keywords tailored to your workflow.\n\nTagging lets you group related items, quickly search for topics, set up ad hoc\ncollections, and create multi-dimensional taxonomies that complement notebooks\nand folders.\n\nTags can be added when creating or editing items, or embedded\ndirectly in your note content.\n\n#### Nested Tagging\n\nIn addition to standard hashtags, `nb` supports hierarchical tags using\nslashes, such as `#project/design/ui`. This enables an organizational structure\nwhere tags can represent parent-child relationships. For example, tagging a\nnote with `#topic/subtopic/detail` lets you group related notes at different\nlevels of specificity.\n\nWhen searching for tags, nested tags are matched by prefix:\n- Searching for `#project` matches notes tagged with `#project`,\n `#project/design`, and `#project/design/ui`.\n- Searching for `#project/design` matches `#project/design` and any deeper\n descendants like `#project/design/ui`.\n- Searching for an exact nested tag like `#project/design/ui` matches only\n that tag.\n- Searching for a branch that doesn't exist, such as `#project/ui` when only\n `#project/design/ui` exists, will match nothing.\n\nThis makes it easy to filter, organize, and browse notes and bookmarks using\neither broad or specific tag queries.\n\n#### Adding Tags\n\nNotes and bookmarks can be tagged when they are created using the\n`--tags <tag1>,<tag2>...` option,\nwhich is available with\n[`nb add`](#add),\n[`nb <url>`](#nb-help),\n[`nb browse add`](#browse),\n[`nb bookmark`](#bookmark),\nand\n[`nb todo`](#todo).\n`--tags` takes a comma-separated list of tags, converts them to\n`#hashtags`,\nand adds them to the document.\n\nTags added to notes with [`nb add --tags`](#add) are placed between the title\nand body text:\n\n```bash\n❯ nb add --title \"Example Title\" \"Example note content.\" --tags tag1,tag2\n```\n\n```markdown\n# Example Title\n\n#tag1 #tag2\n\nExample note content.\n```\n\nTags added to [bookmarks](#bookmarks) with\n[`nb <url> --tags`](#nb-help) and [`nb bookmark <url> --tags`](#bookmark)\nare placed in a [`## Tags`](#-tags) section:\n\n```bash\n❯ nb https://example.com --tags tag1,tag2\n```\n\n```markdown\n# Example Title (example.com)\n\n<https://example.com>\n\n## Description\n\nExample description.\n\n## Tags\n\n#tag1 #tag2\n\n## Content\n\nExample Title\n=============\n\nThis domain is for use in illustrative examples in documents. You may\nuse this domain in literature without prior coordination or asking for\npermission.\n\n[More information\\...](https://www.iana.org/domains/example)\n```\n\nTags added to [todos](#-todos) with\n[`nb todo add --tags`](#todo)\nare placed in a [`## Tags`](#-tags-1) section:\n\n```bash\n❯ nb todo add --tags tag1,tag2 \"Example todo.\"\n```\n\n```markdown\n# [ ] Example todo.\n\n## Tags\n\n#tag1 #tag2\n```\n\n#### Listing and Searching Tags\n\nUse [`nb --tags`](#nb-help), [`nb ls --tags`](#ls),\nand [`nb list --tags`](#list)\nto list the tags present in a notebook, folder, or item:\n\n```bash\n# list all tags found in items in the current notebook\nnb --tags\n\n# list all tags found in the folder named \"example\"\nnb example/ --tags\n\n# list all tags in the item with id 123 in the notebook named \"sample\"\nnb sample:123 --tags\n```\n\nList tagged items by passing `\\#escaped` or `\"#quoted\"` hashtags or tags\nspecified with the [`--tags`](#ls) option to [`nb`](#ls) / [`nb ls`](#ls):\n\n```bash\n# list items in the current notebook tagged with \"#tag1\", escaped\nnb \\#tag1\n\n# list items in the \"example\" notebook tagged with \"#tag2\", quoted\nnb example: \"#tag2\"\n\n# list items in all notebooks tagged with \"#tag3\", long option\nnb --tags tag3 --all\n\n# list items in all notebooks tagged with \"#tag3\", short option\nnb --tags tag3 -a\n```\n\nCombine multiple tags to search for items containing all specified tags:\n\n```bash\n# list items in the current notebook tagged with \"#tag1\" AND \"#tag2\"\nnb \\#tag1 \"#tag2\"\n\n# list items in the current notebook tagged with \"#tag2\" AND \"#tag3\"\nnb --tags tag2,tag3\n\n# list items in all notebooks tagged with \"#tag1\" AND \"#tag2\" AND \"#tag3\" AND \"#tag4\"\nnb \\#tag1 \"#tag2\" --tags tag3,tag4 --all\n```\n\nTagged items can be [searched](#-search) with\n[`nb search`](#search) / [`nb q`](#search):\n\n```bash\n# search for items tagged with \"#tag1\"\nnb search --tag tag1\n\n# search for items tagged with \"#tag1\", shortcut and short option\nnb q -t tag1\n\n# search for items tagged with \"#tag1\", shortcut and argument\nnb q \\#tag1\n\n# search for items tagged with \"#tag1\", shortcut and argument, alternative\nnb q \"#tag1\"\n\n# search for items tagged with \"#tag1\" AND \"#tag2\"\nnb q --tag tag1 --tag tag2\n\n# search for items tagged with \"#tag1\" AND \"#tag2\", short options\nnb q -t tag1 -t tag2\n\n# search for items tagged with \"#tag1\" AND \"#tag2\", arguments\nnb q \\#tag1 \\#tag2\n\n# search for items tagged with \"#tag1\" AND \"#tag2\", tag list\nnb q --tags tag1,tag2\n\n# search for items tagged with either \"#tag1\" OR \"#tag2\", options\nnb q -t tag1 --or -t tag2\n\n# search for items tagged with either \"#tag1\" OR \"#tag2\", arguments\nnb q \\#tag1 --or \\#tag2\n\n# search for items tagged with either \"#tag1\" OR \"#tag2\", single argument\nnb q \"#tag1|#tag2\"\n\n# search for items tagged with \"#tag1\" AND \"#tag2\" AND \"#tag3\"\nnb q -t tag1 --tags tag2,tag3\n\n# search for items tagged with \"#tag1\" OR \"#tag2\" OR \"#tag3\"\nnb q -t tag1 --or --tags tag2,tag3\n\n# search for items tagged with \"#tag1\" OR \"#tag2\" OR \"#tag3\"\nnb q \\#tag1 --or -t tag2 --or \"#tag3\"\n```\n\n#### Browsing Tags\n\nLinked tags can be [browsed](#-browsing) with [`nb browse`](#browse),\nproviding another dimension of browsability in terminal and GUI web browsers,\ncomplimenting <a href=\"#-linking\">[[wiki-style linking]]</a>.\n\nTags in notes,\nbookmarks,\nfiles in text-based formats,\nWord `.docx` documents,\nand [Open Document](https://en.wikipedia.org/wiki/OpenDocument) `.odt` files\nare rendered as links to the list of items in the notebook sharing that tag:\n\n```bash\n❯nb · example : 321\n\nExample Title\n\n#tag1 #tag2\n\nExample content with link to [[Sample Title]].\n\nMore example content:\n\n- one\n- two\n- three\n```\n\nUse the [`-t <tag>`](#browse) / [`--tag <tag>`](#browse) option\nto open [`nb browse`](#browse) to the list of\nall items in the current notebook or a specified notebook or folder that\nshare a tag:\n\n```bash\n# open to a list of items tagged with \"#tag2\" in the \"example\" notebook\n❯ nb browse example: --tag tag2\n❯nb · example\n\nsearch: [#tag2 ]\n\n[example:321] Example Title\n[example:654] Sample Title\n[example:789] Demo Title\n\n# shortcut alias and short option\n❯ nb b example: -t tag2\n❯nb · example\n\nsearch: [#tag2 ]\n\n[example:321] Example Title\n[example:654] Sample Title\n[example:789] Demo Title\n```\n\nFor more information about full-text search, see\n[Search](#-search) and [`nb search`](#search).\nFor more information about browsing, see\n[Browsing](#-browsing) and [`nb browse`](#browse).\n\n### 🔗 Linking\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#browse\"><code>nb browse</code></a>\n </sup>\n</p>\n\nNotes,\nbookmarks,\nfiles in text-based formats,\nWord `.docx` documents,\nand [Open Document](https://en.wikipedia.org/wiki/OpenDocument) `.odt` files\ncan reference other items using\n<a href=\"#-linking\">[[wiki-style links]]</a>,\nmaking `nb` a powerful terminal-first platform for\n[Zettelkasten](#-zettelkasten),\nwiki-style knowledge mapping,\nand other link-based note-taking methods.\n\nTo add a link from a note or bookmark to another in the same notebook,\ninclude the id, title, or relative path for the target item\nwithin double square brackets anywhere in the linking document:\n\n```bash\n# link to the item with id 123 in the root level of current notebook\n[[123]]\n\n# link to the item titled \"Example Title\" in the root level of the current notebook\n[[Example Title]]\n\n# link to the item with id 456 in the folder named \"Sample Folder\"\n[[Sample Folder/456]]\n\n# link to the item titled \"Demo Title\" in the folder named \"Sample Folder\"\n[[Sample Folder/Demo Title]]\n```\n\nTo link to an item in another notebook,\nadd the notebook name with a colon before the identifier:\n\n```bash\n# link to the item with id 123 in the \"sample\" folder in the \"example\" notebook\n[[example:sample/123]]\n\n# link to the item titled \"Example Title\" in the \"demo\" notebook\n[[demo:Example Title]]\n\n# link to the item with filename \"Example File.md\" in the \"sample\" notebook\n[[sample:Example File.md]]\n```\n\nThe text for a link can be specified after a pipe `|` character:\n\n```bash\n# render link to item 123 in the \"example\" notebook as [[Example Link Text]]\n[[example:123|Example Link Text]]\n```\n\n<a href=\"#-linking\">[[wiki-style links]]</a> cooperate well with\n[Org links](https://orgmode.org/guide/Hyperlinks.html),\nwhich have a similar syntax,\nproviding a convenient option for linking collections of Org files.\n\nLinked items can be [browsed](#-browsing) with [`nb browse`](#browse).\n\nFor more information about identifying items, see [Selectors](#-selectors).\n\n### 🌍 Browsing\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#browse\"><code>nb browse</code></a>\n </sup>\n</p>\n\nUse [`nb browse`](#browse) (shortcut: [`nb b`](#browse)) to\nbrowse, view, edit, and search linked notes, bookmarks, notebooks, folders,\nand other items using terminal and GUI web browsers.\n\n<div align=\"center\">\n <img src=\"https://xwmx.github.io/misc/nb/images/gui-gui-terminal-browse.png\"\n alt=\"nb browse\"\n width=\"500\">\n</div>\n\n[`nb browse`](#browse) includes an embedded, terminal-first web application\nthat renders\n<a href=\"#-linking\">[[wiki-style links]]</a>\nand\n[#hashtags](#-tagging)\nas internal links, enabling you to browse your notes and notebooks in web\nbrowsers, including seamlessly browsing to and from the offsite links in\nbookmarks and notes.\n\n```bash\n❯ nb browse\n❯nb · home : +\n\nsearch: [ ]\n\n[home:6]  📌 Example Markdown Title\n[home:12] 🔒 example-encrypted.md.enc\n[home:11] 🔖 Example Bookmark (example.com)\n[home:10] 🔖 🔒 example-encrypted.bookmark.md.enc\n[home:9]  Example .org Title\n[home:8]  🌄 example-image.png\n[home:7]  📄 example.pdf\n[home:5]  🔉 example-audio.mp3\n[home:4]  Example LaTeX Title\n[home:3]  📹 example-video.mp4\n[home:2]  example.md\n[home:1]  📂 Example Folder\n```\n\nLists are displayed using the same format as `nb` and [`nb ls`](#ls),\nincluding [pinned](#-pinning) items, with each list item linked.\nLists are automatically paginated to fit the height of the terminal window.\n\n```bash\n❯ nb browse example:sample/demo/\n❯nb · example : sample / demo / +\n\nsearch: [ ]\n\n[example:sample/demo/7] Title Seven\n[example:sample/demo/6] Title Six\n[example:sample/demo/5] Title Five\n[example:sample/demo/4] Title Four\n[example:sample/demo/3] Title Three\n\nnext ❯\n```\n\n[`nb browse`](#browse) is designed to make it easy to navigate within\nterminal web browsers using only keyboard commands,\nwhile also supporting mouse interactions.\nThe [`nb browse`](#browse) interface includes links\nto quickly jump to parent folders,\nthe current notebook,\nand other notebooks.\n\n[`nb browse`](#browse) opens in\n[w3m](https://en.wikipedia.org/wiki/W3m),\n[Links](https://en.wikipedia.org/wiki/Links_\\(web_browser\\)),\nor in the browser set in the `$BROWSER` environment variable.\nUse [`nb browse --gui`](#browse) / [`nb b -g`](#browse) to\nopen in the system's primary [GUI web browser](#browse---gui).\n\nTo open a specific item in [`nb browse`](#browse),\npass the [selector](#-selectors) for the item, folder, or notebook\nto [`nb browse`](#browse):\n\n```bash\n# open the item with id 42 in the folder named \"sample\" in the \"example\" notebook\n❯ nb browse example:sample/42\n❯nb · example : sample / 42 · ↓ · edit | +\n\nExample Title\n\n#tag1 #tag2\n\nExample content with link to [[Demo Title]].\n\nMore example content:\n\n • one\n • two\n • three\n```\n\nItems can also be browsed with\n[`nb show --browse`](#show) / [`nb s -b`](#show),\nwhich behaves identically.\n\n[`nb browse`](#browse) is particularly useful for [bookmarks](#-bookmarks).\nCached content is rendered in the web browser along with comments and notes.\nInternal and external links are easily accessible directly in the terminal,\nproviding a convenient, distraction-free approach for browsing collections\nof bookmarks.\n\n```bash\n❯ nb browse text:formats/markdown/123\n❯nb · text : formats / markdown / 123 · ↓ · edit | +\nDaring Fireball: Markdown (daringfireball.net)\n\nhttps://daringfireball.net/projects/markdown/\n\nRelated\n\n • https://en.wikipedia.org/wiki/Markdown\n\nComments\n\nSee also:\n\n • [[text:formats/org]]\n • [[cli:apps/nb]]\n\nTags\n\n#markup #plain-text\n\nContent\n\nDaring Fireball: Markdown\n\nDownload\n\nMarkdown 1.0.1 (18 KB) — 17 Dec 2004\n\nIntroduction\n\nMarkdown is a text-to-HTML conversion tool for web writers. Markdown allows\nyou to write using an easy-to-read, easy-to-write plain text format, then\nconvert it to structurally valid XHTML (or HTML).\n```\n\nNotes, bookmarks, files in text-based formats, source code,\nWord `.docx` documents, and\n[Open Document](https://en.wikipedia.org/wiki/OpenDocument) `.odt`\nfiles are converted into HTML and rendered in the browser. Use the down\narrow (`↓`) link to view or download the original file.\n\n[MathJax](https://www.mathjax.org/) support can be enabled by setting\nthe [`$NB_MATHJAX_ENABLED`](https://github.com/xwmx/nb#nb_mathjax_enabled)\nvariable in your `~/.nbrc` file:\n\n```bash\nexport NB_MATHJAX_ENABLED=1\n```\n\nWith this variable set, `nb` will automatically download and install MathJax\nfrom [GitHub](https://github.com/mathjax/MathJax) and enable it when items\nare viewed in [`nb browse --gui`](#browse).\n\n#### `browse edit`\n\n<div align=\"center\">\n <img src=\"https://xwmx.github.io/misc/nb/images/gui-terminal-browse-edit.png\"\n alt=\"nb browse edit\"\n width=\"500\">\n</div>\n\nItems in text formats can be edited within terminal and GUI web browsers using\nthe `edit` link on the item page or by opening the item with\n[`nb browse edit`](#browse) / [`nb b e`](#browse),\nwhich automatically resizes the form to fit the current terminal window:\n\n```bash\n❯ nb browse edit text:formats/markdown/123\n❯nb · text : formats / markdown / 123 · ↓ · editing · - | +\n\n[# Daring Fireball: Markdown (daringfireball.net) ]\n[ ]\n[<https://daringfireball.net/projects/markdown/> ]\n[ ]\n[## Related ]\n[ ]\n[- <https://en.wikipedia.org/wiki/Markdown> ]\n[ ]\n[## Comments ]\n[ ]\n[See also: ]\n[ ]\n[- [[text:formats/org]] ]\n[- [[cli:apps/nb]] ]\n[ ]\n[## Tags ]\n[ ]\n\n[save] · last: 2021-01-01 01:00:00\n```\n\nTerminal web browsers provide different editing workflows.\n[`w3m`](https://en.wikipedia.org/wiki/W3m) opens items in your `$EDITOR`,\nthen returns you back to the browser to save changes and continue browsing.\nEdits in [`links`](https://en.wikipedia.org/wiki/Links_(web_browser))\nare performed directly in the browser.\n\nSyntax highlighting, block selection, and other\n[advanced editor features](#browse---gui-editing)\nare available with [`nb browse --gui`](#browse).\n\n#### `browse add`\n\nAdd an item within the browser using the `+` link or\n[`nb browse add`](#browse) / [`nb b a`](#browse).\nPass a notebook, folder, and / or filename selector to create a new note\nin that location:\n\n```bash\n❯ nb browse add text:formats/\n❯nb · text : formats / +\n\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n\n[add]\n```\n\n[`nb browse add`](#browse) includes options for quickly pre-populating\nnew notes with content:\n\n```bash\n❯ nb browse add --title \"Example Title\" --content \"Example content.\" --tags tag1,tag2\n❯nb · home : +\n\n[# Example Title ]\n[ ]\n[#tag1 #tag2 ]\n[ ]\n[Example content. ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n\n[add]\n```\n\n#### `browse delete`\n\nUse the `-` link on the [`nb browse edit`](#browse) page or\n[`nb browse delete`](#browse) / [`nb b d`](#browse)\nto delete an item:\n\n```bash\n❯ nb browse delete example:4\n❯nb · example : 4 · ↓ · edit · - | +\n\n deleting\n\n[4] example_file.md \"Example Title\"\n\n [delete]\n\n```\n\n#### `browse` Search\n\n[`nb browse`](#browse) includes a search field powered by\n[`nb search`](#search)\nthat can be used to search the current notebook or folder.\nSearch queries are treated as command line arguments for\n[`nb search`](#search),\nproviding the ability to perform `AND` and `OR` queries.\nUse the\n[`-q <query>`](#browse) / [`--query <query>`](#browse)\noption to open [`nb browse`](#browse) to\nthe results page for a search:\n\n```bash\n# open to a list of items containing \"example\" in the current notebook\n❯ nb browse --query \"example\"\n❯nb · home\n\nsearch: [example ]\n\n[home:321] Test Title\n[home:654] Sample Title\n[home:789] Demo Title\n\n# using shortcut alias and short option\n❯ nb b -q \"example\"\n❯nb · home\n\nsearch: [example ]\n\n[home:321] Test Title\n[home:654] Sample Title\n[home:789] Demo Title\n```\n\nSearch for [#tags](#-tagging) with the\n[`-t`](#browse) / [`--tag`](#browse) / [`--tags`](#browse) options:\n\n```bash\n# open to a list of items tagged with \"#tag2\" in the current notebook\n❯ nb browse --tag tag2\n❯nb · home\n\nsearch: [#tag2 ]\n\n[home:654] Sample Title\n[home:789] Demo Title\n\n# using shortcut alias and short option\n❯ nb b -t tag2\n❯nb · home\n\nsearch: [#tag2 ]\n\n[home:654] Sample Title\n[home:789] Demo Title\n```\n\nFor more information about search options, see [Search](#-search) and\n[`nb search`](#search).\n\n#### `browse --gui`\n\nTo open any [`nb browse`](#browse) view in\nthe system's primary GUI web browser,\nadd the [`nb browse --gui`](#browse) / [`nb b -g`](#browse) option:\n\n```bash\n# open the item with id 123 in the \"sample\" notebook in the system's primary GUI browser\nnb browse sample:123 --gui\n\n# open the folder named \"example\" in the system's primary GUI browser,\n# short option\nnb browse example/ -g\n\n# open the current notebook in the system's primary GUI browser,\n# shortcut alias and short option\nnb b -g\n```\n\n##### `browse --gui` Editing\n\nBy default,\n[`nb browse --gui`](#browse)\nuses the browser's default `<textarea>` for editing items.\n\n[Ace](https://ace.c9.io/) is a text editor for GUI web browsers\nthat provides advanced text editing functionality,\nincluding block selection and\n[syntax highlighting](#gui-web-syntax-highlighting).\n\nTo use Ace as the editor for [`nb browse --gui`](#browse),\nadd the following line to set the\n[`$NB_ACE_ENABLED`](https://github.com/xwmx/nb#nb_ace_enabled)\nvariable in your `~/.nbrc` file:\n\n```bash\nexport NB_ACE_ENABLED=1\n```\n\nThe next time a form is loaded in [`nb browse`](#browse),\n`nb` will automatically download\n(from [GitHub](https://github.com/ajaxorg/ace-builds/)),\ninstall,\nand enable the Ace editor in\n[`nb browse edit --gui`](#browse) and [`nb browse add --gui`](#browse).\n\n#### `browse` Portability\n\n[`nb browse`](#browse) depends on\neither [`socat`](https://www.kali.org/tools/socat/)\nor\n[`ncat`](https://nmap.org/ncat/) (available as part of\nthe `ncat` or `nmap` package in most package managers) and\n[`pandoc`](https://pandoc.org/). When neither `socat` nor `ncat` is\navailable and the Bash version is 5.2 or higher, [`nb browse`](#browse)\nfalls back to a pure Bash implementation that supports all features\nexcept the Ace editor. When only `pandoc` is available,\nthe current note is rendered and\n<a href=\"#-linking\">[[wiki-style links]]</a>\ngo to unrendered, original files.\nWhen `socat`,`ncat`, or Bash 5.2+ is available without `pandoc`,\nfiles in plain text formats are rendered with the original markup unconverted.\nIf neither `ncat`, `socat`, Bash 5.2+, nor `pandoc` is available,\n[`nb browse`](#browse) falls back to the default behavior of [`nb show`](#show).\n\nWhen `nb` is installed on Windows,\n`socat` ([MSYS](https://packages.msys2.org/package/socat),\n[Cygwin](https://cygwin.com/packages/summary/socat.html)) is recommended.\n\n#### `browse` Privacy\n\n[`nb browse`](#browse) is completely local and self-contained within `nb`,\nfrom the CSS and JavaScript\nall the way down through the HTTP request parsing and response building,\nwith no imports, libraries, frameworks, or third-party code\noutside of the few binary dependencies\n(`bash`, `git`, `ncat` / `socat`, `pandoc`),\nthe Linux / Unix environment,\nand the optional [Ace editor](#ace-editor).\n\nTerminal web browsers don't use JavaScript, so visits from them are not\nvisible to some web analytics tools.\n[`nb browse`](#browse) includes a number of additional features\nto enhance privacy and avoid leaking information:\n\n- Page content is cached locally within each bookmark file,\n making it readable in terminal and GUI web browsers\n without requesting the page again or needing to be connected to the internet.\n- `<img>` tags in bookmarked content are removed to avoid requests.\n- Outbound links are automatically rewritten to use an\n [exit page redirect](https://geekthis.net/post/hide-http-referer-headers/#exit-page-redirect)\n to mitigate leaking information via the\n [referer header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer).\n- All pages include the `<meta name=\"referrer\" content=\"no-referrer\" />` tag.\n- Links include a `rel=\"noopener noreferrer\"` attribute.\n- `lynx` is opened with the `-noreferer` option.\n\n#### `browse` AsciiDoc\n\nTo [`browse`](#browse) items in [AsciiDoc](https://asciidoc.org/) format,\ninstall [`asciidoctor`](https://asciidoctor.org/).\n\n#### Shortcut Alias: `nb b`\n\n[`nb browse`](#browse) can also be used with the alias [`nb b`](#browse):\n\n```bash\n# open the current notebook in the terminal web browser\nnb b\n\n# open the item with id 123 in the \"example\" notebook using the terminal web browser\nnb b example:123\n\n# open the notebook named \"sample\" in the GUI web browser\nnb b sample: -g\n```\n\nFor more information, see [`nb browse`](#browse).\n\n### 🌄 Images\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#browse\"><code>nb browse</code></a>,\n <a href=\"#import\"><code>nb import</code></a>,\n <a href=\"#open\"><code>nb open</code></a>,\n <a href=\"#show\"><code>nb show</code></a>\n </sup>\n</p>\n\n`nb` can be used to view, organize, browse, reference, and work with images in\nterminals,\nweb browsers,\nand GUI applications.\n\n#### Image Items\n\n[Import](#%EF%B8%8F-import--export) images with [`nb import`](#import):\n\n```bash\n# import the image file \"example.png\" into the current notebook\nnb import example.png\n\n# import an image file from a URL into the current notebook\nnb import https://raw.githubusercontent.com/xwmx/nb/master/docs/images/nb.png\n\n# nb import \"sample.jpg\" into the \"demo\" folder in the \"example\" notebook\nnb import sample.jpg example:demo/\n```\n\nImported images are displayed with [`🌄` indicators](#indicators) in\n[lists](#listing--filtering):\n\n```bash\n❯ nb\nhome\n----\n[5] Example Five\n[4] 🌄 example-image.png\n[3] Example Three\n[2] Example Two\n[1] Example One\n```\n\nImported image items can be opened in the system GUI application for\nthe item's file type using [`nb open`](#open):\n\n```bash\n# open the image \"example-image.png\" in the system GUI photo viewer\nnb open example-image.png\n\n# open the image with id \"4\" in the system GUI photo viewer\nnb 4 o\n```\n\nImage items can be viewed in web browsers with [`nb browse`](#browse),\nproviding a convenient mechanism for\n[browsing](#-browsing) notebooks and folders containing image collections.\n\n[`nb browse`](#browse) renders image items within in an `<img>` tag\non the item page. Open the item page for an image item by passing a\n[selector](#-selectors) to [`nb browse`](#browse), optionally including the\n[`-g`](#browse) / [`--gui`](#browse) option\nto open the page in the system GUI web browser:\n\n```bash\n# open item with id \"123\" in the terminal web browser\nnb browse 123\n\n# open item with id \"456\" in the \"example\" notebook in the GUI web browser\nnb browse example:456 --gui\n\n# open item \"example:456\" in the GUI web browser, alternative\nnb example:456 b -g\n```\n\nThe original file can be viewed or downloaded from the item page\nby either clicking the image item or using the down arrow (`↓`) link.\n\n[`nb browse --gui`](#browse---gui) displays images in any GUI web browser.\nSome terminal web browsers, such as [`w3m`](http://w3m.sourceforge.net/),\ncan be configured to display images.\n\n[`nb show`](#show) can display images directly in the terminal with\nsupported tools and configurations, including:\n\n- [`catimg`](https://github.com/posva/catimg)\n- [Chafa](https://github.com/hpjansson/chafa)\n- [ImageMagick](https://imagemagick.org/) with a terminal that\n supports [sixels](https://en.wikipedia.org/wiki/Sixel)\n- [`imgcat`](https://www.iterm2.com/documentation-images.html) with\n [iTerm2](https://www.iterm2.com/)\n- [kitty's `icat` kitten](https://sw.kovidgoyal.net/kitty/kittens/icat.html)\n- [`termvisage`](https://github.com/AnonymouX47/termvisage)\n- [`timg`](https://github.com/hzeller/timg)\n- [`viu`](https://github.com/atanunq/viu)\n\nA preferred image viewer tool can be set with the\n[`$NB_IMAGE_TOOL`](#nb_image_tool) variable in your `~/.nbrc` file,\nwhich can be opened in your editor with [`nb settings edit`](#settings).\n\n#### Inline Images\n\nImages can be referenced and rendered inline within\nnotes, bookmarks, and other items.\n\nTo reference an image in the same notebook,\nspecify the image's relative path within the notebook:\n\n```markdown\n# reference \"example.jpg\" from markdown\n![](example.jpg)\n\n# reference \"demo.png\" in the \"sample\" folder from markdown\n![](sample/demo.png)\n```\n\nImages in any notebook can be referenced using the `--original` URL,\nobtainable from the image's [`nb browse`](#browse) item page\nby either clicking the image item or using the down arrow (`↓`) link.\n\n```markdown\n# reference \"example.jpg\" in the \"home\" notebook with the --original URL\n![](http://localhost:6789/--original/home/example.jpg)\n```\n\nImage references in content are rendered inline within web browsers with\n[`nb browse`](#browse) and [`nb show --render`](#show).\n\n`<img>` tags are stripped from bookmarked content when rendering to HTML.\nInline images can still be used in other bookmark sections like\n[`## Comment`](#-comment).\n\n### 🗂 Zettelkasten\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a>\n </sup>\n</p>\n\nZettelkasten (German: \"slip box\") is a method of note-taking and\npersonal knowledge management modeled around a few key features:\n\n- Notes are taken liberally on index cards.\n- Each note is numbered for easy reference.\n- Index cards are organized into boxes.\n- Index cards can reference other index cards.\n- Cards can include tags and other metadata.\n\nSince `nb` works directly on plain text files\norganized in normal system directories in normal git repositories,\n`nb` is a very close digital analogue to physical zettelkasten note-taking.\n\n| Zettelkasten | `nb` |\n|:-----------------:|:-----------------------------------------------:|\n| index cards | [notes](#-notes) & [bookmarks](#-bookmarks) |\n| numbering | ids & [selectors](#-selectors) |\n| slip boxes | [notebooks](#-notebooks) |\n| tags | [#tags](#-tagging) |\n| metadata | [front matter](#front-matter) |\n| cross-references | <a href=\"#-linking\">[[wiki-style links]]</a> |\n| fast note-taking | [`nb add`](#adding)/[`nb <url>`](#-bookmarks) |\n\nFor more information about Zettelkasten, see\n[Wikipedia](https://en.wikipedia.org/wiki/Zettelkasten).\n\n### 📂 Folders\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#add\"><code>nb add</code></a>,\n <a href=\"#browse\"><code>nb browse</code></a>,\n <a href=\"#folders\"><code>nb folders</code></a>,\n <a href=\"#list\"><code>nb list</code></a>,\n <a href=\"#ls\"><code>nb ls</code></a>\n </sup>\n</p>\n\nItems can be organized in folders.\nTo add a note to a folder,\ncall [`nb add`](#add) with the folder's relative path within the notebook\nfollowed by a slash:\n\n```bash\n# add a new note in the folder named \"example\"\nnb add example/\n\n# add a new note in the folder named \"demo\" in \"example\"\nnb add example/demo/\n```\n\n`nb` automatically creates any intermediate folders as needed.\n\nFolders can be created directly using [`nb add folder`](#add),\n[`nb folders add`](#folders), and [`nb add --type folder`](#add):\n\n```bash\n# create a new folder named \"sample\"\nnb add folder sample\n\n# create a new folder named \"sample\", alternative\nnb folders add sample\n\n# create a new folder named \"demo\"\nnb add demo --type folder\n\n# create a folder named \"example\" containing a folder named \"test\"\nnb add example/test --type folder\n```\n\nTo list the items in a folder, pass the folder relative path to\n`nb`,\n[`nb ls`](#ls),\n[`nb list`](#list),\nor [`nb browse`](#browse)\nwith a trailing slash:\n\n```bash\n❯ nb example/demo/\nhome\n----\n[example/demo/3] Title Three\n[example/demo/2] Title Two\n[example/demo/1] Title One\n```\n\nFolders can also be identified by the folder's id\nand listed with a trailing slash:\n\n```bash\n❯ nb list\n[1] 📂 example\n\n❯ nb list 1/\n[example/2] 📂 demo\n[example/1] document.md\n\n❯ nb list 1/2/\n[example/demo/3] Title Three\n[example/demo/2] Title Two\n[example/demo/1] Title One\n```\n\nItems in folders can be idenitified with\nthe folder's relative path using either folder ids or names,\nfollowed by the id, title, or filename of the item:\n\n```bash\n# list item 1 (\"Title One\", one.md) in the example/demo/ folder\nnb list example/demo/1\n\n# edit item 1 (\"Title One\", one.md) in the example/demo/ folder\nnb edit example/2/one.md\n\n# show item 1 (\"Title One\", one.md) in the example/demo/ folder\nnb show 1/2/Title\\ One\n\n# delete item 1 (\"Title One\", one.md) in the example/demo/ folder\nnb delete 1/demo/1\n```\n\nFor folders and items in other notebooks,\ncombine the relative path with the notebook name, separated by a colon:\n\n```bash\n# list the contents of the \"sample\" folder in the \"example\" notebook\nnb example:sample/\n\n# add an item to the \"sample/demo\" folder in the \"example\" notebook\nnb add example:sample/demo/\n\n# edit item 3 in the \"sample/demo\" folder in the \"example\" notebook\nnb edit example:sample/demo/3\n```\n\n[Browse](#-browsing) starting at any folder with [`nb browse`](#browse):\n\n```bash\n❯ nb browse example:sample/demo/\n❯nb · example : sample / demo /\n\nsearch: [ ]\n\n[example:sample/demo/5] Title Five\n[example:sample/demo/4] Title Four\n[example:sample/demo/3] Title Three\n[example:sample/demo/2] Title Two\n[example:sample/demo/1] Title One\n```\n\nFor more information about identifying folders, see [Selectors](#-selectors).\n\n### 📌 Pinning\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#pin\"><code>nb pin</code></a>,\n <a href=\"#unpin\"><code>nb unpin</code></a>,\n <a href=\"#ls\"><code>nb ls</code></a>,\n <a href=\"#browse\"><code>nb browse</code></a>\n </sup>\n</p>\n\nItems can be pinned so they appear first in\n`nb`, [`nb ls`](#ls), and [`nb browse`](#browse):\n\n```bash\n❯ nb\nhome\n----\n[2] 📌 Title Two\n[5] Title Five\n[4] Title Four\n[3] Title Three\n[1] Title One\n```\n\nUse [`nb pin`](#pin) and [`nb unpin`](#unpin) to pin and unpin items:\n\n```bash\n❯ nb\nhome\n----\n[5] Title Five\n[4] Title Four\n[3] Title Three\n[2] Title Two\n[1] Title One\n\n❯ nb pin 4\nPinned: [4] four.md \"Title Four\"\n\n❯ nb pin 1\nPinned: [1] one.md \"Title One\"\n\n❯ nb\nhome\n----\n[4] 📌 Title Four\n[1] 📌 Title One\n[5] Title Five\n[3] Title Three\n[2] Title Two\n\n❯ nb unpin 4\nUnpinned: [4] four.md \"Title Four\"\n\n❯ nb\nhome\n----\n[1] 📌 Title One\n[5] Title Five\n[4] Title Four\n[3] Title Three\n[2] Title Two\n```\n\n`nb` can also be configured to pin notes that contain\na specified [#hashtag](#-tagging) or other search pattern.\nTo enable tag / search-based pinning,\nset the [`$NB_PINNED_PATTERN`](#nb_pinned_pattern) environment variable to\nthe desired [#tag](#-tagging) or pattern.\n\nFor example, to treat all items tagged with `#pinned` as pinned items,\nadd the following line to your `~/.nbrc` file,\nwhich can be opened in your editor with [`nb settings edit`](#settings):\n\n```bash\nexport NB_PINNED_PATTERN=\"#pinned\"\n```\n\nAll [indicator icons](#indicators) in `nb` can be customized, so\nto use a different character as the pindicator,\nsimply add a line like the following to your `~/.nbrc` file:\n\n```bash\nexport NB_INDICATOR_PINNED=\"💖\"\n```\n\n```bash\n❯ nb\nhome\n----\n[1] 💖 Title One\n[5] Title Five\n[4] Title Four\n[3] Title Three\n[2] Title Two\n```\n\nTo bump an item to the top of the list without pinning, use the\n[`bump` plugin](#bump).\n\n### 🔍 Search\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#search\"><code>nb search</code></a>\n </sup>\n</p>\n\nUse [`nb search`](#search) (shortcut: [`nb q`](#search)) to\nperform full text searches, with support for regular expressions,\n[#tags](#-tagging), and `AND`, `OR`, and `NOT` queries:\n\n```bash\n# search current notebook for \"example query\"\nnb search \"example query\"\n\n# search the notebook \"example\" for \"example query\"\nnb search example: \"example query\"\n\n# search the folder named \"demo\" for \"example query\"\nnb search demo/ \"example query\"\n\n# search all unarchived notebooks for \"example query\" and list matching items\nnb search \"example query\" --all --list\n\n# search for \"example\" AND \"demo\" with multiple arguments\nnb search \"example\" \"demo\"\n\n# search for \"example\" AND \"demo\" with option\nnb search \"example\" --and \"demo\"\n\n# search for \"example\" OR \"sample\" with argument\nnb search \"example|sample\"\n\n# search for \"example\" OR \"sample\" with option\nnb search \"example\" --or \"sample\"\n\n# search for items matching both \"Example\" AND \"Sample\", and NOT \"Demo\"\nnb search \"Example\" --and \"Sample\" --not \"Demo\"\n\n# search items containing the hashtag \"#example\"\nnb search \"#example\"\n\n# search with a regular expression\nnb search \"\\d\\d\\d-\\d\\d\\d\\d\"\n\n# search bookmarks for \"example\"\nnb search \"example\" --type bookmark\n\n# search bookmarks for \"example\", alternative\nnb bk q \"example\"\n\n# search the current notebook for \"example query\"\nnb q \"example query\"\n\n# search the notebook named \"example\" for \"example query\"\nnb q example: \"example query\"\n\n# search all unarchived notebooks for \"example query\" and list matching items\nnb q -la \"example query\"\n```\n\n[`nb search`](#search) prints the id number, filename,\nand title of each matched file,\nfollowed by each search query match and its line number,\nwith color highlighting:\n\n```bash\n❯ nb search \"example\"\n[314] 🔖 example.bookmark.md \"Example Bookmark (example.com)\"\n--------------------------------------------------------------\n1:# Example Bookmark (example.com)\n\n3:<https://example.com>\n\n[2718] example.md \"Example Note\"\n--------------------------------\n1:# Example Note\n```\n\nTo just print the note information line without the content matches,\nuse the [`-l`](#search) or [`--list`](#search) option:\n\n```bash\n❯ nb search \"example\" --list\n[314] 🔖 example.bookmark.md \"Example Bookmark (example.com)\"\n[2718] example.md \"Example Note\"\n```\n\nMultiple query arguments are treated as `AND` queries,\nreturning items that match all queries.\n`AND` queries can also be specified with the\n[`--and <query>`](#search) option:\n\n```bash\n# search for items tagged with \"#example\" AND \"#demo\" AND \"#sample\" using\n# multiple arguments\nnb q \"#example\" \"#demo\" \"#sample\"\n\n# options\nnb q \"#example\" --and \"#demo\" --and \"#sample\"\n```\n\n`nb` matches `AND` query terms regardless of where they appear in a document,\nan improvement over most approaches for performing `AND` queries\nwith command line tools,\nwhich typically only match terms appearing on the same line.\n\n`OR` queries return items that match at least one of the queries\nand can be created by separating terms in a single argument\nwith a pipe character `|` or with the [`--or <query>`](#search) option:\n\n```bash\n# search for \"example\" OR \"sample\" with argument\nnb q \"example|sample\"\n\n# search for \"example\" OR \"sample\" with option\nnb q \"example\" --or \"sample\"\n```\n\n[`--or`](#search) and [`--and`](#search) queries can be used together:\n\n```bash\nnb q \"example\" --or \"sample\" --and \"demo\"\n# equivalent: example|sample AND demo|sample\n```\n\n`NOT` queries exclude items that match the specified query and are\nspecified with [`--not <query>`](#search), which can be used with\n`--and` and `--or`:\n\n```bash\n# search for items that match \"Example\", excluding items that also match \"Sample\"\nnb search \"Example\" --not \"Sample\"\n\n# search for items matching both \"Example\" AND \"Sample\", and NOT \"Demo\"\nnb search \"Example\" --and \"Sample\" --not \"Demo\"\n```\n\nSearch for [#tags](#-tagging) with flexible\n[`nb search --tags [<tags>]`](#search) / [`nb q -t [<tags>]`](#search) options:\n\n```bash\n# search for tags in the current notebook\nnb search --tags\n\n# search for tags in the \"sample\" notebook, shortcut alias\nnb sample:q --tags\n\n# search for items tagged with \"#tag1\"\nnb search --tag tag1\n\n# search for items tagged with \"#tag1\", shortcut alias and short option\nnb q -t tag1\n\n# search for items tagged with \"#tag1\", shortcut alias and argument\nnb q \\#tag1\n\n# search for items tagged with \"#tag1\", shortcut alias and argument, alternative\nnb q \"#tag1\"\n\n# search for items in the \"sample\" notebook tagged with \"#tag1\" AND \"#tag2\"\nnb sample:search --tag tag1 --tag tag2\n\n# search for items in the \"sample\" notebook tagged with \"#tag1\" AND \"#tag2\"\nnb sample:q --tags tag1,tag2\n\n# search for items in the current notebook tagged with \"#tag1\" AND \"#tag2\"\nnb q --tag tag1 --tag tag2\n\n# search for items in the current notebook tagged with \"#tag1\" OR \"#tag2\"\nnb q -t tag1 --or -t tag2\n\n# search for items tagged with \"#tag1\" AND \"#tag2\" AND \"#tag3\"\nnb q -t tag1 --tags tag2,tag3\n\n# search for items tagged with \"#tag1\" OR \"#tag2\" OR \"#tag3\"\nnb q -t tag1 --or --tags tag2,tag3\n\n# search for items tagged with \"#tag1\" OR \"#tag2\" OR \"#tag3\"\nnb q \\#tag1 --or -t tag2 --or \"#tag3\"\n```\n\n[`nb search`](#search) leverages Git's powerful built-in\n[`git grep`](https://git-scm.com/docs/git-grep).\n`nb` also supports performing searches with alternative search tools\nusing the [`--utility <name>`](#search) option.\n\nSupported alternative search tools:\n- [`rga`](https://github.com/phiresky/ripgrep-all)\n- [`rg`](https://github.com/BurntSushi/ripgrep)\n- [`ag`](https://github.com/ggreer/the_silver_searcher)\n- [`ack`](https://beyondgrep.com/)\n- [`grep`](https://en.wikipedia.org/wiki/Grep)\n\n##### Shortcut Alias: `nb q`\n\n[`nb search`](#search) can also be used with the alias\n[`nb q`](#search) (for \"query\"):\n\n```bash\n# search for \"example\" and print matching excerpts\nnb q \"example\"\n\n# search for \"example\" and list each matching file\nnb q -l \"example\"\n\n# search for \"example\" in all unarchived notebooks\nnb q -a \"example\"\n\n# search for \"example\" in the notbook named \"sample\"\nnb sample:q \"example\"\n```\n\nFor more information about search, see [`nb help search`](#search).\n\n##### Searching with `browse`\n\nSearches can be performed within terminal and GUI web browsers using\n[`nb browse --query`](#browse) / [`nb b -q`](#browse):\n\n```bash\n❯ nb browse --query \"#example\"\n❯nb · home : +\n\nsearch: [#example ]\n\n[home:7] Title Seven\n[home:32] Title Thirty-Two\n[home:56] Title Fifty-Six\n[home:135] Title One Hundred and Thirty-Five\n```\n\nFor more information, see [Browsing](#-browsing).\n\n### ↔ Moving & Renaming\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#move\"><code>nb move</code></a>,\n <a href=\"#copy\"><code>nb copy</code></a>\n </sup>\n</p>\n\nUse [`nb move`](#move) (alias: [`nb rename`](#move), shortcut: [`nb mv`](#move))\nto move and rename items:\n\n```bash\n# move \"example.md\" to \"sample.org\"\nnb move example.md sample.org\n\n# rename note 2 (\"example.md\") to \"New Name.md\"\nnb rename 2 \"New Name\"\n```\n\nItems can be moved between notebooks and folders:\n\n```bash\n# move note 12 from the \"example\" notebook into \"Sample Folder\" in the \"demo\" notebook\nnb move example:12 demo:Sample\\ Folder/\n```\n\nWhen the file extension is omitted, the existing extension is used:\n\n```bash\n# rename \"example.bookmark.md\" to \"New Name.bookmark.md\"\nnb move example.bookmark.md \"New Name\"\n```\n\nWhen only a file extension is specified, only the extension is updated:\n\n```bash\n# change the file extension of note 5 (\"demo file.md\") to .org (\"demo file.org\")\nnb rename 5 .org\n```\n\nUse [`nb rename --to-bookmark`](#move) to change the extension of a note\nto `.bookmark.md`,\n[`nb rename --to-todo`](#move) to change the extension to `.todo.md`,\nand [`nb rename --to-note`](#move) to change the extension\nof a bookmark or todo to either `.md` or the extension set with\n[`nb set default_extension`](#default_extension):\n\n```bash\n# rename note 3 (\"example.md\") to a bookmark named \"example.bookmark.md\"\nnb rename 3 --to-bookmark\n\n# rename bookmark 6 (\"sample.bookmark.md\") to a note named \"sample.md\"\nnb rename 6 --to-note\n\n# rename note 7 (\"demo.md\") to a todo named \"demo.todo.md\"\nnb rename 7 --to-todo\n```\n\nUse [`nb rename --to-title`](#move) to set the filename to the note title,\nlowercased with spaces and disallowed filename characters replaced\nwith underscores:\n\n```bash\n❯ nb rename 12 --to-title\nMoving: [12] 20210101010000.md \"Example Title\"\nTo: example_title.md\nProceed? [y/N]\n```\n\nCopy an item to a destination notebook, folder path, or filename\nwith [`nb copy`](#copy) (alias: [`nb duplicate`](#copy)):\n\n```bash\n# copy item 456 to \"sample.md\"\nnb copy 456 sample.md\n\n# copy item 678 to the \"example\" notebook\nnb copy 678 example:\n\n# copy item 789 to the \"demo\" folder\nnb copy 789 demo/\n\n# copy item 543 to test.md in the \"sample\" folder in the \"example\" notebook\nnb copy 543 example:sample/test.md\n```\n\nOmit a destination to copy the item in place:\n\n```bash\n# copy item 123 (\"example.md\") to example-1.md\n❯ nb copy 123\nAdded: [124] example-1.md\n\n# copy item 123 (\"example.md\") to example-2.md, alias\n❯ nb duplicate 123\nAdded: [125] example-2.md\n```\n\nFor more information about moving, renaming, and copying items, see\n[`nb help move`](#move) and [`nb help copy`](#copy).\n\n### 🗒 Revision History\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#history\"><code>nb history</code></a>,\n <a href=\"#notebooks\"><code>nb notebooks</code></a>\n </sup>\n</p>\n\nWhenever a note is added, modified, or deleted,\n`nb` automatically commits the change to git transparently in the background.\n\nUse [`nb history`](#history) to view the revision history of\nany notebook, folder, or item:\n\n```bash\n# show history for current notebook\nnb history\n\n# show history for note number 4\nnb history 4\n\n# show history for note with filename example.md\nnb history example.md\n\n# show history for note titled \"Example\"\nnb history Example\n\n# show history for the notebook named \"example\"\nnb example:history\n\n# show history for the notebook named \"example\", alternative\nnb history example:\n\n# show the history for note 12 in the notebook named \"example\"\nnb history example:12\n```\n\n[`nb history`](#history) uses `git log` by default and prefers\n[`tig`](https://github.com/jonas/tig) when available.\n\n#### Authorship\n\nBy default, git commits are attributed to the email and name configured in your\n[global `git` configuration](https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration).\n\nChange the email and name used for a notebook with\n[`nb notebooks author`](#notebooks):\n\n```bash\n# edit the commit author email and name for the current notebook\n❯ nb notebooks author\nCurrent configuration for: home\n--------------------------\nemail (global): example@example.test\nname (global): Example Name\n\nUpdate? [y/N]\n\n# edit the commit author email and name for the notebook named \"example\"\n❯ nb notebooks author example\nCurrent configuration for: example\n--------------------------\nemail (global): example@example.test\nname (global): Example Name\n\nUpdate? [y/N]\n```\n\nThe updated author email and name applies to subsequent commits.\n\nTo use a different email and name from the beginning of a notebook's\nhistory, create the new notebook using\n[`nb notebooks add --author`](#notebooks) or\n[`nb notebooks init --author`](#notebooks).\n\n### 📚 Notebooks\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#notebooks\"><code>nb notebooks</code></a>,\n <a href=\"#archive\"><code>nb archive</code></a>,\n <a href=\"#unarchive\"><code>nb unarchive</code></a>,\n <a href=\"#use\"><code>nb use</code></a>\n </sup>\n</p>\n\nYou can create additional notebooks, each of which has its own version history.\n\nCreate a new notebook with [`nb notebooks add`](#notebooks):\n\n```bash\n# add a notebook named example\nnb notebooks add example\n```\n\n`nb` and [`nb ls`](#ls) list the available notebooks above the list of notes:\n\n```bash\n❯ nb\nexample · home\n--------------\n[3] Title Three\n[2] Title Two\n[1] Title One\n```\n\nCommands in `nb` run within the current notebook, and identifiers\nsuch as ids, filenames, and titles refer to notes within the current notebook.\n`nb edit 3`, for example, tells `nb` to\n[`edit`](#edit) note with id `3` within the current notebook.\n\nTo switch to a different notebook, use [`nb use`](#use):\n\n```bash\n# switch to the notebook named \"example\"\nnb use example\n```\n\nIf you are in one notebook and you want\nto perform a command in a different notebook without switching to it,\nadd the notebook name with a colon before the command name:\n\n```bash\n# add a new note in the notebook \"example\"\nnb example:add\n\n# add a new note in the notebook \"example\", shortcut alias\nnb example:a\n\n# show note 5 in the notebook \"example\"\nnb example:show 5\n\n# show note 5 in the notebook \"example\", shortcut alias\nnb example:s 5\n\n# edit note 12 in the notebook \"example\"\nnb example:edit 12\n\n# edit note 12 in the notebook \"example\", shortcut alias\nnb example:e 12\n\n# search for \"example query\" in the notebook \"example\"\nnb example:search \"example query\"\n\n# search for \"example query\" in the notebook \"example\", shortcut alias\nnb example:q \"example query\"\n\n# show the revision history of the notebook \"example\"\nnb example:history\n```\n\nThe notebook name with colon can also be used as a modifier to\nthe id, filename, or title:\n\n```bash\n# edit note 12 in the notebook \"example\"\nnb edit example:12\n\n# edit note 12 in the notebook \"example\", shortcut alias\nnb e example:12\n\n# edit note 12 in the notebook \"example\", alternative\nnb example:12 edit\n\n# edit note 12 in the notebook \"example\", alternative, shortcut alias\nnb example:12 e\n\n# show note titled \"misc\" in the notebook \"example\"\nnb show example:misc\n\n# show note titled \"misc\" in the notebook \"example\", shortcut alias\nnb s example:misc\n\n# delete note with filename \"todos.md\" in the notebook \"example\", alternative\nnb example:todos.md delete\n\n# delete note with filename \"todos.md\" in the notebook \"example\", alternative,\n# shortcut alias\nnb example:todos.md d\n```\n\nWhen a notebook name with colon is called without a subcommand,\n`nb` runs [`nb ls`](#ls) in the specified notebook:\n\n```bash\n❯ nb example:\nexample · home\n--------------\n[example:3] Title Three\n[example:2] Title Two\n[example:1] Title One\n```\n\nA bookmark can be created in another notebook by specifying\nthe notebook name with colon, then a space, then the URL and bookmark options:\n\n```bash\n# create a new bookmark in a notebook named \"sample\"\n❯ nb sample: https://example.com --tags tag1,tag2\n```\n\nNotes can also be moved between notebooks:\n\n```bash\n# move note 3 from the current notebook to \"example\"\nnb move 3 example:\n\n# move note 5 in the notebook \"example\" to the notebook \"sample\"\nnb move example:5 sample:\n```\n\n##### Example Workflow\n\nThe flexibility of `nb`'s argument handling makes it easy to\nbuild commands step by step as items are listed, filtered, viewed, and edited,\nparticularly in combination with shell history:\n\n```bash\n# list items in the \"example\" notebook\n❯ nb example:\nexample · home\n--------------\n[example:3] Title Three\n[example:2] Title Two\n[example:1] Title One\n\n# filter list\n❯ nb example: three\n[example:3] Title Three\n\n# view item\n❯ nb example:3 show\n# opens item in `less`\n\n# edit item\n❯ nb example:3 edit\n# opens item in $EDITOR\n```\n\n##### Notebooks and Tab Completion\n\n[`nb` tab completion](#tab-completion) is optimized for\nfrequently running commands in various notebooks using the colon syntax,\nso installing the completion scripts is recommended\nand makes working with notebooks easy, fluid, and fun.\n\nFor example, listing the contents of a notebook is usually as simple as typing\nthe first two or three characters of the name,\nthen pressing the `<tab>` key,\nthen pressing `<enter>` / `<return>`:\n\n```bash\n❯ nb exa<tab>\n# completes to \"example:\"\n❯ nb example:\nexample · home\n--------------\n[example:3] Title Three\n[example:2] Title Two\n[example:1] Title One\n```\n\nScoped notebook commands are also available in tab completion:\n\n```bash\n❯ nb exa<tab>\n# completes to \"example:\"\n❯ nb example:hi<tab>\n# completes to \"example:history\"\n```\n\n#### Notebooks, Tags, and Taxonomy\n\n`nb` is optimized to work well with a collection of notebooks, so\nnotebooks are a good way to organize notes and bookmarks by top-level topic.\n\n[#tags](#-tagging) are searchable across notebooks and can be created ad hoc,\nmaking notebooks and tags distinct and complementary organizational systems\nin `nb`.\n\nSearch for a tag in or across notebooks with\n[`nb search`](#search) / [`nb q`](#search):\n\n```bash\n# search for #tag in the current notebook\nnb q --tag tag\n\n# search for #tag in all notebooks, short options\nnb q -t tag -a\n\n# search for #tag in the \"example\" notebook, argument\nnb q example: \"#tag\"\n```\n\n#### Global and Local Notebooks\n\n##### Global Notebooks\n\nBy default, all `nb` notebooks are global, making them\nalways accessible in the terminal regardless of the current working directory.\nGlobal notebooks are stored in the directory configured in\n[`nb set nb_dir`](#nb_dir),\nwhich is `~/.nb` by default.\n\n##### Local Notebooks\n\n`nb` also supports creating and working with local notebooks.\nLocal notebooks are notebooks that are\nanywhere on the system outside of [`$NB_DIR`](#nb_dir-1).\nAny folder can be an `nb` local notebook, which is just a normal folder\nthat has been initialized as a git repository and contains an `nb` .index file.\nInitializing a folder as an `nb` local notebook is a very easy way to\nadd structured git versioning to any folder of documents and other files.\n\nWhen `nb` runs within a local notebook,\nthe local notebook is set as the current notebook:\n\n```bash\n❯ nb\nlocal · example · home\n----------------------\n[3] Title Three\n[2] Title Two\n[1] Title One\n```\n\nA local notebook is always referred to by the name `local`\nand otherwise behaves just like a global notebook\nwhenever a command is run from within it:\n\n```bash\n# add a new note in the local notebook\nnb add\n\n# edit note 15 in the local notebook\nnb edit 15\n\n# move note titled \"Todos\" from the home notebook to the local notebook\nnb move home:Todos local:\n\n# move note 1 from the local notebook to the home notebook\nnb move 1 home:\n\n# search the local notebook for <query string>\nnb search \"query string\"\n\n# search the local notebook and all unarchived global notebooks for <query string>\nnb search \"query string\" --all\n```\n\nLocal notebooks can be created with [`nb notebooks init`](#notebooks):\n\n```bash\n# initialize the current directory as a notebook\nnb notebooks init\n\n# create a new notebook at ~/example\nnb notebooks init ~/example\n\n# clone an existing notebook to ~/example\nnb notebooks init ~/example https://github.com/example/example.git\n```\n\nLocal notebooks can also be created by exporting a global notebook:\n\n```bash\n# export global notebook named \"example\" to \"../path/to/destination\"\nnb notebooks export example ../path/to/destination\n\n# alternative\nnb export example ../path/to/destination\n```\n\nLocal notebooks can also be imported, making them global:\n\n```bash\n# import notebook or folder at \"../path/to/notebook\"\nnb notebooks import ../path/to/notebook\n\n# alternative\nnb import ../path/to/notebook\n```\n\n[`nb notebooks init`](#notebooks) and [`nb notebooks import`](#notebooks)\ncan be used together to easily turn any directory of existing files\ninto a global `nb` notebook:\n\n```bash\n❯ ls\nexample-directory\n\n❯ nb notebooks init example-directory\nInitialized local notebook: /home/username/example-directory\n\n❯ nb notebooks import example-directory\nImported notebook: example-directory\n\n❯ nb notebooks\nexample-directory\nhome\n```\n\n#### Archiving Notebooks\n\n<p>\n <sup>\n <a href=\"#-notebooks\">↑</a> ·\n <a href=\"#archive\"><code>nb archive</code></a>,\n <a href=\"#status\"><code>nb status</code></a>,\n <a href=\"#unarchive\"><code>nb unarchive</code></a>\n </sup>\n</p>\n\nNotebooks can be archived using\n[`nb archive`](#archive) (shortcut: [`nb ar`](#archive)):\n\n```bash\n# archive the current notebook\nnb archive\n\n# archive the notebook named \"example\"\nnb archive example\n\n# archive the current notebook, shortcut alias\nnb ar\n\n# archive the notebook named \"example\", shortcut alias\nnb ar example\n```\n\nWhen a notebook is archived it is not included in\n[`nb`](#ls) / [`nb ls`](#ls) output,\n[`nb search --all`](#search),\nor tab completion,\nnor synced automatically with [`nb sync --all`](#sync).\n\n```bash\n❯ nb\nexample1 · example2 · example3 · [1 archived]\n---------------------------------------------\n[3] Title Three\n[2] Title Two\n[1] Title One\n```\n\nArchived notebooks can still be used individually\nusing normal notebook commands:\n\n```bash\n# switch the current notebook to the archived notebook \"example\"\nnb use example\n\n# run the `list` subcommand in the archived notebook \"example\"\nnb example:list\n```\n\nCheck a notebook's archival status with\n[`nb status`](#status) (shortcut: [`nb st`](#status)) and\n[`nb notebooks status`](#notebooks):\n\n```bash\n# print status information, including archival status, for the current notebook\nnb status\n\n# print status information, including archival status, for the notebook named \"example\"\nnb status example\n\n# print status information, including archival status, for the current notebook,\n# shortcut alias\nnb st\n\n# print status information, including archival status, for the notebook named \"example\",\n# shortcut alias\nnb st example\n\n# print the archival status of the current notebook\nnb notebooks status\n\n# print the archival status of the notebook named \"example\"\nnb notebooks status example\n```\n\nUse [`nb unarchive`](#unarchive) (shortcut: [`nb unar`](#unarchive))\nto unarchive a notebook:\n\n```bash\n# unarchive the current notebook\nnb unarchive\n\n# unarchive the notebook named \"example\"\nnb unarchive example\n```\n\nFor more information about working with notebooks, see\n[`nb help notebooks`](#notebooks),\n[`nb help archive`](#archive),\nand [`nb help unarchive`](#unarchive).\n\nFor technical details about notebooks, see\n[`nb` Notebook Specification](#nb-notebook-specification).\n\n### 🔄 Git Sync\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#remote\"><code>nb remote</code></a>,\n <a href=\"#sync\"><code>nb sync</code></a>\n </sup>\n</p>\n\nEach notebook can be synced with a remote git repository by\nsetting the remote URL using [`nb remote`](#remote):\n\n```bash\n# set the current notebook's remote to a private GitHub repository\nnb remote set https://github.com/example/example\n\n# set the remote for the notebook named \"example\"\nnb example:remote set https://github.com/example/example\n```\n\nAny notebook with a remote URL will sync automatically\nevery time a command is run in that notebook.\n\nWhen you use `nb` on multiple systems, you can\nset a notebook on each system to the same remote\nand `nb` will keep everything in sync in the background\nevery time there's a change in that notebook.\n\nSince each notebook has its own git history,\nyou can have some notebooks syncing with remotes\nwhile other notebooks are only available locally on that system.\n\nMany services provide free private git repositories, so\ngit syncing with `nb` is easy, free, and vendor-independent.\nYou can also sync your notes using\nDropbox, Drive, Box, Syncthing, or another syncing tool\nby changing your `nb` directory with\n[`nb set nb_dir <path>`](#nb_dir),\nand git syncing will still work simultaneously.\n\nClone an existing notebook by passing the URL to\n[`nb notebooks add`](#notebooks):\n\n```bash\n# create a new notebook named \"example\" cloned from a private GitLab repository\nnb notebooks add example https://gitlab.com/example/example.git\n```\n\nTurn off syncing for a notebook by removing the remote:\n\n```bash\n# remove the remote from the current notebook\nnb remote remove\n\n# remove the remote from the notebook named \"example\"\nnb example:remote remove\n```\n\nAutomatic git syncing can be turned on or off with\n[`nb set auto_sync`](#auto_sync).\n\nTo sync manually, use [`nb sync`](#sync):\n\n```bash\n# manually sync the current notebook\nnb sync\n\n# manually sync the notebook named \"example\"\nnb example:sync\n```\n\nTo bypass `nb` syncing and run `git` commands directly within a\nnotebook, use [`nb git`](#git):\n\n```bash\n# run `git fetch` in the current notebook\nnb git fetch origin\n\n# run `git status` in the notebook named \"example\"\nnb example:git status\n```\n\n#### Syncing Multiple Notebooks with One Remote\n\nMultiple notebooks can be synced to one remote using orphan branches.\nAn\n[orphan branch](https://git-scm.com/docs/git-checkout#Documentation/git-checkout.txt---orphanltnewbranchgt)\nis a branch with a history that is independent\nfrom the repository's `main`, `master`,\nor equivalent primary branch history.\nTo sync a notebook with a new orphan branch,\nadd the remote using [`nb remote set`](#remote)\nand select the option to create a new orphan branch.\nThe name of orphan branch is derived from notebook name\nand can alternatively be specified as an argument to\n[`nb remote set`](#remote):\n\n```bash\n# set the remote for the current notebook to a remote URL and branch\nnb remote set https://github.com/xwmx/example demo-branch\n```\n\nTo create a notebook using an existing orphan branch on a remote,\npass the branch name to\n[`nb init`](#init),\n[`nb notebooks add`](#notebooks), or\n[`nb notebooks init`](#notebooks) after the URL:\n\n```bash\n# initialize new \"home\" notebook with the branch \"sample-branch\" on the remote\nnb init https://github.com/xwmx/example sample-branch\n\n# add a new \"example\" notebook from the branch \"example-branch\" on the remote\nnb notebooks add example https://github.com/xwmx/example example-branch\n```\n\nTo list all branches on a remote, use [`nb remote branches`](#remote):\n\n```bash\n# list all branches on the current remote\nnb remote branches\n\n# list all branches on a remote repository identified by a URL\nnb remote branches \"https://github.com/xwmx/example\"\n```\n\nFor information about assigning remotes, see [`nb help remote`](#remote).\n\n#### Private Repositories and Git Credentials\n\nSyncing with private repositories requires\nconfiguring git to not prompt for credentials.\nFor repositories cloned over HTTPS,\n[credentials can be cached with git\n](https://docs.github.com/en/free-pro-team@latest/github/using-git/caching-your-github-credentials-in-git).\nFor repositories cloned over SSH,\n[keys can be added to the ssh-agent\n](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).\n\nUse [`nb sync`](#sync) within a notebook to determine\nwhether your configuration is working.\nIf `nb sync` displays a password prompt,\nthen follow the instructions above to configure your credentials.\nThe password prompt can be used to authenticate, but\n`nb` does not cache or otherwise handle git credentials in any way,\nso there will likely be multiple password prompts during each sync\nif credentials are not configured.\n\n#### Sync Conflict Resolution\n\n`nb` handles git operations automatically, so\nyou shouldn't ever need to use the `git` command line tool directly.\n`nb` merges changes when syncing\nand handles conflicts using a couple different strategies.\n\nWhen [`nb sync`](#sync) encounters a conflict in a text file\nand can't cleanly merge overlapping local and remote changes,\n`nb` saves both versions within the file separated by git conflict markers\nand prints a message indicating which files contain conflicting text.\nUse [`nb edit`](#edit) to remove the conflict markers\nand delete any unwanted text.\n\nFor example, in the following file, the second list item was changed\non two systems, and git has no way to determine which one we want to keep:\n\n```\n# Example Title\n\n- List Item apple\n<<<<<<< HEAD\n- List Item apricot\n=======\n- List Item pluot\n>>>>>>> 719od01... [nb] Commit\n- List Item plum\n```\n\nThe local change is between the lines starting with\n`<<<<<<<` and `=======`,\nwhile the remote change is between the\n`=======` and `>>>>>>>`\nlines.\n\nTo resolve this conflict by keeping both items, simply\nedit the file with [`nb edit`](#edit) and\nremove the lines starting with `<<<<<<<`, `=======`, and `>>>>>>>`:\n\n```\n# Example Title\n\n- List Item apple\n- List Item apricot\n- List Item pluot\n- List Item plum\n```\n\nWhen `nb` encounters a conflict in a binary file,\nsuch as an encrypted note,\nboth versions of the file are saved in the notebook as individual files,\nwith `--conflicted-copy` appended to the filename\nof the version from the remote.\nTo resolve a conflicted copy of a binary file,\ncompare both versions and merge them manually,\nthen delete the `--conflicted-copy`.\n\nIf you do encounter a conflict that `nb` says it can't merge at all,\n[`nb git`](#git) and [`nb run`](#run) can be used to\nperform git and shell operations within the notebook\nto resolve the conflict manually.\nPlease also\n[open an issue](https://github.com/xwmx/nb/issues/new)\nwith any relevant details\nthat could inform a strategy for handling any such cases automatically.\n\n### ↕️ Import / Export\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#import\"><code>nb import</code></a>,\n <a href=\"#export\"><code>nb export</code></a>,\n <a href=\"#browse\"><code>nb browse</code></a>\n </sup>\n</p>\n\n#### Importing\n\nFiles of any type can be imported into a notebook using\n[`nb import`](#import) (shortcut: [`nb i`](#import)).\n[`nb edit`](#edit) and [`nb open`](#open) open files in\nyour system's default application for that file type.\n\n```bash\n# import an image file\nnb import ~/Pictures/example.png\n\n# open image in your default image viewer\nnb open example.png\n\n# import a .docx file\nnb import ~/Documents/example.docx\n\n# open .docx file in Word or your system's .docx viewer\nnb open example.docx\n```\n\nMultiple filenames and globbing are supported:\n\n```bash\n# import all files and directories in the current directory\nnb import ./*\n\n# import all markdown files in the current directory\nnb import ./*.md\n\n# import example.md and sample.md in the current directory\nnb import example.md sample.md\n```\n\n[`nb import`](#import) can also download and import files directly from the web:\n\n```bash\n# import a PDF file from the web\nnb import https://example.com/example.pdf\n# Imported \"https://example.com/example.pdf\" to \"example.pdf\"\n\n# open example.pdf in your system's PDF viewer\nnb open example.pdf\n```\n\nSome imported file types have [indicators](#indicators) to make them\neasier to identify in lists:\n\n```bash\n❯ nb\nhome\n----\n[6] 📖 example-ebook.epub\n[5] 🌄 example-picture.png\n[4] 📄 example-document.docx\n[3] 📹 example-video.mp4\n[2] 🔉 example-audio.mp3\n[1] 📂 Example Folder\n```\n\n#### Importing Bookmarks\n\nBookmarks exported from Chrome, Firefox, and Edge can be imported with\n[`nb import bookmarks`](#import). A new `nb` bookmark file is created for\neach bookmark.\n\n#### Exporting\n\nNotes, bookmarks, and other files can be exported using [`nb export`](#export).\nIf [Pandoc](https://pandoc.org/) is installed,\nnotes can be automatically converted to any of the\n[formats supported by Pandoc](https://pandoc.org/MANUAL.html#option--to).\nBy default, the output format is determined by the file extension:\n\n```bash\n# export a Markdown note to a .docx Microsoft Office Word document\nnb export example.md /path/to/example.docx\n\n# export a note titled \"Movies\" to an HTML web page.\nnb export Movies /path/to/example.html\n```\n\nFor more control over the `pandoc` options, use the\n[`nb export pandoc`](#export) subcommand:\n\n```bash\n# export note 42 as an epub with pandoc options\nnb export pandoc 42 --from markdown_strict --to epub -o path/to/example.epub\n```\n\n[`nb export notebook`](#export) and [`nb import notebook`](#import) can be\nused to export and import notebooks:\n\n```bash\n# export global notebook named \"example\" to \"../path/to/destination\"\nnb export notebook example ../path/to/destination\n\n# import notebook or folder at \"../path/to/notebook\"\nnb import notebook ../path/to/notebook\n```\n\n[`nb export notebook`](#export) and [`nb import notebook`](#import)\nbehave like aliases for\n[`nb notebooks export`](#notebooks) and [`nb notebooks import`](#notebooks),\nand the subcommands can be used interchangeably.\n\nFor more information about imported and exported notebooks, see\n[Global and Local Notebooks](#global-and-local-notebooks).\n\nFor [`nb import`](#import) and [`nb export`](#export) help information, see\n[`nb help import`](#import) and [`nb help export`](#export).\n\n#### Exporting with `browse`\n\nItems can be exported using terminal and GUI [web browsers](#-browsing).\nUse the down arrow (`↓`) link\non the [`nb browse`](#browse) item page\nto download the original file:\n\n```bash\n❯ nb browse 123\n❯nb · home : 123 · ↓ | +\n\n example.pdf\n\n```\n\n### ⚙️ `set` & `settings`\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#-variables\">Variables</a>,\n <a href=\"#settings\"><code>nb settings</code></a>,\n <a href=\"#unset\"><code>nb unset</code></a>\n </sup>\n</p>\n\n[`nb set`](#settings) and [`nb settings`](#settings)\nopen the settings prompt,\nwhich provides an easy way to change your `nb` settings.\n\n```bash\nnb set\n```\n\nTo update a setting in the prompt,\nenter the setting name or number and then enter the new value.\n`nb` will add the setting to your `~/.nbrc` configuration file.\n\n#### Example: editor\n\n`nb` can be configured to use a specific command line editor\nusing the `editor` setting.\n\nThe settings prompt for a setting can be started by passing\nthe setting name or number to [`nb set`](#settings):\n\n```bash\n❯ nb set editor\n[6] editor\n ------\n The command line text editor used by `nb`.\n\n • Example Values:\n\n atom\n code\n emacs\n hx\n macdown\n mate\n micro\n nano\n pico\n subl\n vi\n vim\n\nEDITOR is currently set to vim\n\nEnter a new value, unset to set to the default value, or q to quit.\nValue:\n```\n\nA setting can also be updated without the prompt by\npassing both the name and value to [`nb set`](#settings):\n\n```bash\n# set editor with setting name\n❯ nb set editor code\nEDITOR set to code\n\n# set editor with setting number (6)\n❯ nb set 6 code\nEDITOR set to code\n\n# set the color theme to blacklight\n❯ nb set color_theme blacklight\nNB_COLOR_THEME set to blacklight\n\n# set the default `ls` limit to 10\n❯ nb set limit 10\nNB_LIMIT set to 10\n```\n\nUse [`nb settings get`](#settings) to print the value of a setting:\n\n```bash\n❯ nb settings get editor\ncode\n\n❯ nb settings get 6\ncode\n```\n\nUse\n[`nb unset`](#unset) or\n[`nb settings unset`](#settings)\nto unset a setting and revert to the default:\n\n```bash\n❯ nb unset editor\nEDITOR restored to the default: vim\n\n❯ nb settings get editor\nvim\n```\n\n[`nb set`](#settings) and [`nb settings`](#settings)\nare aliases that refer to the same subcommand,\nso the two subcommand names can be used interchangeably.\n\nFor more information about [`set`](#settings) and [`settings`](#settings), see\n[`nb help settings`](#settings).\n\n### 🎨 Color Themes\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#color_theme\"><code>nb set color_theme</code></a>,\n <a href=\"#syntax_theme\"><code>nb set syntax_theme</code></a>,\n <a href=\"#color_primary\"><code>nb set color_primary</code></a>,\n <a href=\"#color_secondary\"><code>nb set color_secondary</code></a>\n </sup>\n</p>\n\n`nb` uses color to highlight various interface elements, including\nids and [selectors](#-selectors),\nthe current notebook name,\nthe shell prompt,\ndivider lines,\n[syntax elements](#terminal-syntax-highlighting-theme),\nand links.\n\n`nb` includes several built-in color themes\nand also supports user-defined themes.\nThe current color theme can be set using [`nb set color_theme`](#color_theme):\n\n```bash\nnb set color_theme\n```\n\n#### Built-in Color Themes\n\n##### `blacklight`\n\n| ![blacklight](https://xwmx.github.io/misc/nb/images/nb-theme-blacklight-home.png) | ![blacklight](https://xwmx.github.io/misc/nb/images/nb-theme-blacklight-web.png) |\n|:--:|:--:|\n| | |\n\n##### `console`\n\n| ![console](https://xwmx.github.io/misc/nb/images/nb-theme-console-home.png) | ![console](https://xwmx.github.io/misc/nb/images/nb-theme-console-web.png) |\n|:--:|:--:|\n| | |\n\n##### `desert`\n\n| ![desert](https://xwmx.github.io/misc/nb/images/nb-theme-desert-home.png) | ![desert](https://xwmx.github.io/misc/nb/images/nb-theme-desert-web.png) |\n|:--:|:--:|\n| | |\n\n##### `electro`\n\n| ![electro](https://xwmx.github.io/misc/nb/images/nb-theme-electro-home.png) | ![electro](https://xwmx.github.io/misc/nb/images/nb-theme-electro-web.png) |\n|:--:|:--:|\n| | |\n\n##### `forest`\n\n| ![forest](https://xwmx.github.io/misc/nb/images/nb-theme-forest-home.png) | ![forest](https://xwmx.github.io/misc/nb/images/nb-theme-forest-web.png) |\n|:--:|:--:|\n| | |\n\n##### `nb` (default)\n\n| ![nb](https://xwmx.github.io/misc/nb/images/nb-theme-nb-home.png) | ![nb](https://xwmx.github.io/misc/nb/images/nb-theme-nb-web.png) |\n|:--:|:--:|\n| | |\n\n##### `ocean`\n\n| ![ocean](https://xwmx.github.io/misc/nb/images/nb-theme-ocean-home.png) | ![ocean](https://xwmx.github.io/misc/nb/images/nb-theme-ocean-web.png) |\n|:--:|:--:|\n| | |\n\n##### `raspberry`\n\n| ![raspberry](https://xwmx.github.io/misc/nb/images/nb-theme-raspberry-home.png) | ![raspberry](https://xwmx.github.io/misc/nb/images/nb-theme-raspberry-web.png) |\n|:--:|:--:|\n| | |\n\n##### `smoke`\n\n| ![smoke](https://xwmx.github.io/misc/nb/images/nb-theme-monochrome-home.png) | ![smoke](https://xwmx.github.io/misc/nb/images/nb-theme-smoke-web.png) |\n|:--:|:--:|\n| | |\n\n##### `unicorn`\n\n| ![unicorn](https://xwmx.github.io/misc/nb/images/nb-theme-unicorn-home.png) | ![unicorn](https://xwmx.github.io/misc/nb/images/nb-theme-unicorn-web.png) |\n|:--:|:--:|\n| | |\n\n##### `utility`\n\n| ![utility](https://xwmx.github.io/misc/nb/images/nb-theme-utility-home.png) | ![utility](https://xwmx.github.io/misc/nb/images/nb-theme-utility-web.png) |\n|:--:|:--:|\n| | |\n\n#### Custom Color Themes\n\nColor themes are\n[`nb` plugins](#-plugins) with a `.nb-theme` file extension.\n`.nb-theme` files are expected to contain one `if` statement\ntesting for the theme name\nand setting the color environment variables to `tput` ANSI color numbers:\n\n```bash\n# turquoise.nb-theme\nif [[ \"${NB_COLOR_THEME}\" == \"turquoise\" ]]\nthen\n export NB_COLOR_PRIMARY=43\n export NB_COLOR_SECONDARY=38\nfi\n```\n\nView this theme as a complete file:\n[`plugins/turquoise.nb-theme`](https://github.com/xwmx/nb/blob/master/plugins/turquoise.nb-theme)\n\nThemes can be installed using [`nb plugins`](#plugins):\n\n```bash\n❯ nb plugins install https://github.com/xwmx/nb/blob/master/plugins/turquoise.nb-theme\nPlugin installed:\n/home/example/.nb/.plugins/turquoise.nb-theme\n```\n\nOnce a theme is installed,\nuse [`nb set color_theme`](#color_theme) to set it as the current theme:\n\n```bash\n❯ nb set color_theme turquoise\nNB_COLOR_THEME set to turquoise\n```\n\nThe primary and secondary colors can also be overridden individually,\nmaking color themes easily customizable:\n\n```bash\n# open the settings prompt for the primary color\nnb set color_primary\n\n# open the settings prompt for the secondary color\nnb set color_secondary\n```\n\nTo view a table of available colors and numbers, run:\n\n```bash\nnb set colors\n```\n\n#### Terminal Syntax Highlighting Theme\n\n`nb` displays files with syntax highlighting when\n[`bat`](https://github.com/sharkdp/bat),\n[`highlight`](http://www.andre-simon.de/doku/highlight/en/highlight.php),\nor\n[Pygments](https://pygments.org/)\nis installed.\n\nWhen `bat` is installed, syntax highlighting\ncolor themes are available for both light and dark terminal backgrounds.\nTo view a list of available themes\nand set the syntax highlighting color theme,\nuse [`nb set syntax_theme`](#syntax_theme).\n\n#### GUI Web Syntax Highlighting\n\nSyntax highlighting is also available when\nviewing and editing items in text formats with\n[`nb browse --gui`](#browse---gui),\nwhich incorporates the color theme's primary color into the syntax theme:\n\n<div align=\"center\">\n <img src=\"https://xwmx.github.io/misc/nb/images/nb-web-pandoc-ruby-utility.png\"\n alt=\"nb syntax highlighting\"\n width=\"500\">\n</div>\n\n#### Indicators\n\n`nb` uses emoji characters to represent information about files in lists.\nThese characters are referred to internally as \"indicators\"\nand can be customized by assigning a different character to\nthe indicator's environment variable in your `~/.nbrc` file,\nwhich can be opened with [`nb settings edit`](#settings).\n\nFor example, to use a different indicator for pinned items,\nadd a line like the following to your `~/.nbrc` file:\n\n```bash\nexport NB_INDICATOR_PINNED=\"✨\"\n```\n\nTo turn off an indicator, assign the variable to an empty string:\n\n```bash\nexport NB_INDICATOR_PINNED=\"\"\n```\n\nAvailable indicator [variables](#-variables) with default values:\n\n```bash\nexport NB_INDICATOR_AUDIO=\"🔉\"\nexport NB_INDICATOR_BOOKMARK=\"🔖\"\nexport NB_INDICATOR_DOCUMENT=\"📄\"\nexport NB_INDICATOR_EBOOK=\"📖\"\nexport NB_INDICATOR_ENCRYPTED=\"🔒\"\nexport NB_INDICATOR_FOLDER=\"📂\"\nexport NB_INDICATOR_IMAGE=\"🌄\"\nexport NB_INDICATOR_PINNED=\"📌\"\nexport NB_INDICATOR_TODO=\"✔️ \"\nexport NB_INDICATOR_TODO_DONE=\"✅\"\nexport NB_INDICATOR_VIDEO=\"📹\"\n```\n\n### $ Shell Theme Support\n\n- [`astral` Zsh Theme](https://github.com/xwmx/astral) - Displays the\n current notebook name in the context line of the prompt.\n\n### 🔌 Plugins\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#plugin-help\">Plugin Help</a>,\n <a href=\"#plugins\"><code>nb plugins</code></a>\n </sup>\n</p>\n\n`nb` includes support for plugins, which can be used to create new\nsubcommands, design themes, and otherwise extend the functionality of `nb`.\n\n`nb` supports two types of plugins, identified by their file extensions:\n\n<dl>\n <dt><code>.nb-theme</code></dt>\n <dd>Plugins defining <a href=\"#custom-color-themes\">color themes</a>.</dd>\n <dt><code>.nb-plugin</code></dt>\n <dd>Plugins defining new subcommands and adding functionality.</dd>\n</dl>\n\nPlugins are managed with the [`nb plugins`](#plugins) subcommand and\nare installed in the `${NB_DIR}/.plugins` directory.\n\nPlugins can be installed from either a URL or a path using the\n[`nb plugins install`](#plugins) subcommand.\n\n```bash\n# install a plugin from a URL\nnb plugins install https://raw.githubusercontent.com/xwmx/nb/master/plugins/clip.nb-plugin\n\n# install a plugin from a standard GitHub URL\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/example.nb-plugin\n\n# install a theme from a standard GitHub URL\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/turquoise.nb-theme\n\n# install a plugin from a path\nnb plugins install plugins/example.nb-plugin\n```\n\nThe `<url>` should be the full URL to the plugin file.\n`nb` also recognizes regular GitHub URLs,\nwhich can be used interchangeably with raw GitHub URLs.\n\nInstalled plugins can be listed with [`nb plugins`](#plugins),\nwhich optionally takes a name and prints full paths:\n\n```bash\n❯ nb plugins\nclip.nb-plugin\nexample.nb-plugin\nturquoise.nb-theme\n\n❯ nb plugins clip.nb-plugin\nclip.nb-plugin\n\n❯ nb plugins --paths\n/home/example/.nb/.plugins/clip.nb-plugin\n/home/example/.nb/.plugins/example.nb-plugin\n/home/example/.nb/.plugins/turquoise.nb-theme\n\n❯ nb plugins turquoise.nb-theme --paths\n/home/example/.nb/.plugins/turquoise.nb-theme\n```\n\nUse [`nb plugins uninstall`](#plugins) to uninstall a plugin:\n\n```bash\n❯ nb plugins uninstall example.nb-plugin\nPlugin successfully uninstalled:\n/home/example/.nb/.plugins/example.nb-plugin\n```\n\n#### Creating Plugins\n\nPlugins are written in a Bash-compatible shell scripting language\nand have an `.nb-plugin` extension.\n\n`nb` includes a few example plugins:\n\n- [`example.nb-plugin`](https://github.com/xwmx/nb/blob/master/plugins/example.nb-plugin)\n- [`clip.nb-plugin`](https://github.com/xwmx/nb/blob/master/plugins/clip.nb-plugin)\n- [`ebook.nb-plugin`](https://github.com/xwmx/nb/blob/master/plugins/ebook.nb-plugin)\n\nCreate a new subcommand in three easy steps:\n\n##### 1. Add the new subcommand name with `_subcommands add <name>`:\n\n```bash\n_subcommands add \"example\"\n```\n\n##### 2. Define help and usage text with `_subcommands describe <subcommand> <usage>`:\n\n```bash\n_subcommands describe \"example\" <<HEREDOC\nUsage:\n nb example\n\nDescription:\n Print \"Hello, World!\"\nHEREDOC\n```\n\n##### 3. Define the subcommand as a function, named with a leading underscore:\n\n```bash\n_example() {\n printf \"Hello, World!\\\\n\"\n}\n```\n\nThat's it! 🎉\n\nView the complete plugin:\n[`plugins/example.nb-plugin`](https://github.com/xwmx/nb/blob/master/plugins/example.nb-plugin)\n\nWith `example.nb-plugin` installed, `nb` includes an `nb example` subcommand\nthat prints \"Hello, World!\"\n\nFor a full example,\n[`clip.nb-plugin`](https://github.com/xwmx/nb/blob/master/plugins/clip.nb-plugin)\nadd clipboard functionality to `nb` and demonstrates how to create a\nplugin using `nb` subcommands and simple shell scripting.\n\nYou can install any plugin you create locally with\n[`nb plugins install <path>`](#plugins),\nand you can publish it on GitHub, GitLab,\nor anywhere else online and install it with\n[`nb plugins install <url>`](#plugins).\n\n#### API\n\nThe `nb` API is the [command line interface](#nb-help), which is designed for\ncomposability and provides a variety of powerful options for interacting with\nnotes, bookmarks, notebooks, and `nb` functionality. Within plugins,\nsubcommands can be called using their function names, which are named with\nleading underscores. Options can be used to output information in formats\nsuitable for parsing and processing:\n\n```bash\n# print the content of note 3 to standard output with no color\n_show 3 --print --no-color\n\n# list all unarchived global notebook names\n_notebooks --names --no-color --unarchived --global\n\n# list all filenames in the current notebook\n_list --filenames --no-id --no-indicator\n\n# print the path to the current notebook\n_notebooks current --path\n```\n\n`nb` automatically scans arguments for\n[selectors](#-selectors) with notebook names\nand updates the current notebook if a valid one is found.\n\nIdentifier selectors are passed to subcommands as arguments along with\nany subcommand options. Use [`show <selector>`](#show) to query\ninformation about the file specified in the selector. For example, to\nobtain the filename of a selector-specified file, use\n[`show <selector> --filename`](#show):\n\n```bash\n_example() {\n local _selector=\"${1:-}\"\n [[ -z \"${_selector:-}\" ]] && printf \"Usage: example <selector>\\\\n\" && exit 1\n\n # Get the filename using the selector.\n local _filename=\n _filename=\"$(_show \"${_selector}\" --filename)\"\n\n # Rest of subcommand function...\n}\n```\n\n[`notebooks current --path`](#notebooks) returns the path to the current\nnotebook:\n\n```bash\n# _example() continued:\n\n# get the notebook path\nlocal _notebook_path=\n_notebook_path=\"$(_notebooks current --path)\"\n\n# print the file at \"${_notebook_path}/${_filename}\" to standard output\ncat \"${_notebook_path}/${_filename}\"\n```\n\nSee\n[`clip.nb-plugin`](https://github.com/xwmx/nb/blob/master/plugins/clip.nb-plugin)\nfor a practical example using both [`show <selector>`](#show) and\n[`notebooks current --path`](#notebooks) along with other\nsubcommands called using their underscore-prefixed function names.\n\n### `:/` Selectors\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a>\n </sup>\n</p>\n\nItems in `nb` are primarily identified using structured arguments called\n\"selectors.\" Selectors are like addresses for notebooks, folders, and items.\nA selector can be as simple as an id like `123` or folder path like `example/`,\nor it can combine multiple elements to identify\nan item in a nested folder within a particular notebook, such as:\n\n```bash\ncli:tools/shellcheck/home-page.bookmark.md\n```\n\nAn item, folder, or notebook selector is constructed by specifying the\nnotebook name, folder path, and / or item identifier\nin the following pattern:\n\n```text\nnotebook:folder/path/item-idenitifer\n```\n\nRepresented in a [docopt](http://docopt.org/)-like format:\n\n```text\n[<notebook>:][<folder-path>/][<id> | <filename> | <title>]\n```\n\nNotebooks are identified by the notebook name followed by a colon.\nFolder and item identifiers without a notebook name refer to\nitems within the current notebook.\nWhen a selector consists of notebook name and colon\nwith no folder path or item identifier,\nthe command runs in the root folder of the notebook:\n\n```bash\n# list items in the \"example\" notebook\nnb example:\n\n# add a new note named \"Example Title\" to the \"example\" notebook\nnb add example: --title \"Example Title\"\n\n# edit item with id \"123\" in the notebook \"example\"\nnb edit example:123\n```\n\nA notebook selector can be combined with a subcommand name to\nrun the command within the notebook:\n\n```bash\n# list all items in the \"example\" notebook and display excerpts\nnb example:list -e\n\n# edit item with id \"123\" in the \"example\" notebook\nnb example:edit 123\n\n# show the git history for the notebook named \"example\"\nnb example:history\n```\n\nFolders are identified by relative path from the notebook root.\nFolders can be referenced by either id or name, and segments\nin nested paths can mix and match names and ids:\n\n```bash\n# list items in the folder named \"sample\" in the folder named demo\"\nnb sample/demo/\n\n# add a new item to the folder named \"demo\" in the folder with id \"3\"\nnb add 3/demo/\n\n# show the history of the folder with id \"4\" in the folder named\n# \"sample\" in the notebook named \"example\"\nnb history example:sample/4/\n```\n\nA trailing slash indicates that the command is expected to operate on\nthe contents of the folder. When a trailing slash is omitted, the\nselector refers to the folder itself:\n\n```bash\n❯ nb list sample\n[1] 📂 sample\n\n❯ nb list sample/\n[sample/3] Title Three\n[sample/2] Title Two\n[sample/1] Title One\n```\n\nFor more information about folders, see [Folders](#-folders).\n\nAn item is identified by id, filename, or title, optionally preceded by\nnotebook name or folder path:\n\n```bash\n# edit item with id \"123\"\nnb edit 123\n\n# open the item titled \"demo title\" in the folder with id \"3\"\nnb open 3/demo\\ title\n\n# show \"file.md\" in the \"sample\" folder in the \"example\" notebook\nnb show example:sample/file.md\n```\n\nItems can also be specified using the full path:\n\n```bash\n# edit \"demo.md\" in the \"sample\" folder in the \"home\" notebook\nnb edit /home/example/.nb/home/sample/demo.md\n```\n\n##### Examples\n\n*Idenitifer Selectors*\n\n```text\n123\nexample.md\ntitle\nrelative/path/to/123\nrelative/path/to/demo.md\nrelative/path/to/title\n/full/path/to/sample.md\nnotebook:123\nnotebook:example.md\nnotebook:title\nnotebook:relative/path/to/123\nnotebook:relative/path/to/demo.md\nnotebook:relative/path/to/title\n```\n\n*Subcommand Selectors*\n\n```text\nnotebook:\nnotebook:show\nnotebook:history\nnotebook:a\nnotebook:q\n```\n\n### `01` Metadata\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#show\"><code>nb show</code></a>\n </sup>\n</p>\n\nMetadata in `nb` is primarily derived from git, the filesystem, and file\ncontent. For example, displayed timestamps are derived from\n[`git log`](https://git-scm.com/docs/git-log), with [`nb show --added`](#show)\ndisplaying the datetime of the first commit containing the file and\n[`nb show --updated`](#show) displaying the datetime of the last commit in\nwhich the file was modified. Meanwhile, the file system's modified\ntimestamp is used for sorting.\n\n`nb` also uses plain text files to store ids and state information in\ngit, including\n[`.index` files](#index-files),\n[`.pindex` files](#pindex-files),\nand [`.archived` files](#archived-notebooks).\n\n#### Front Matter\n\nUser-defined metadata can be added to notes in `nb` using [front\nmatter](https://jekyllrb.com/docs/front-matter/). Front matter is a\nsimple, human accessible, and future-friendly method for defining metadata\nfields in plain text and is well supported in tools for working with\nMarkdown.\n\nFront matter is defined within a Markdown file with triple-dashed lines\n(`---`) indicating the start and end of the block, with each field represented\nby a key name with a colon followed by the value:\n\n```markdown\n---\ntitle: Example Title\nauthor: xwmx\nyear: 2021\n---\n\nExample content.\n\nMore example content:\n\n- one\n- two\n- three\n```\n\nAny metadata can be placed in the front matter block. `nb` uses the\n`title:` field for listing, filtering, and selecting items, if one is\npresent, and ignores any other fields.\n\nThe simple `key: value` syntax is suitable for many metadata fields.\nMore complex data can be defined using additional\n[YAML](https://en.wikipedia.org/wiki/YAML)\ncapabilities.\n\n### `❯` Interactive Shell\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#shell\"><code>nb shell</code></a>\n </sup>\n</p>\n\n`nb` has an interactive shell that can be started with\n[`nb shell`](#shell), [`nb -i`](#nb-help), or [`nb --interactive`](#nb-help):\n\n```bash\n$ nb shell\n__ _\n\\ \\ _ __ | |__\n \\ \\ | '_ \\| '_ \\\n / / | | | | |_) |\n/_/ |_| |_|_.__/\n------------------\nnb shell started. Enter ls to list notes and notebooks.\nEnter help for usage information. Enter exit to exit.\nnb❯ ls\nhome\n----\n[3] Example\n[2] Sample\n[1] Demo\n\nnb❯ edit 3 --content \"New content.\"\nUpdated: [3] Example\n\nnb❯ bookmark https://example.com\nAdded: [4] 🔖 example.bookmark.md \"Example Title (example.com)\"\n\nnb❯ ls\nhome\n----\n[4] 🔖 Example Title (example.com)\n[3] Example\n[2] Sample\n[1] Demo\n\nnb❯ bookmark url 4\nhttps://example.com\n\nnb❯ search \"example\"\n[4] example.bookmark.md \"Example (example.com)\"\n-----------------------------------------------\n1:# Example (example.com)\n\n3:<https://example.com>\n\n[3] example.md \"Example\"\n------------------------\n1:# Example\n\nnb❯ exit\n$\n```\n\nThe `nb` shell recognizes all `nb` subcommands and options,\nproviding a streamlined, distraction-free approach for working with `nb`.\n\n### Shortcut Aliases\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a>\n </sup>\n</p>\n\nSeveral core `nb` subcommands have shortcut aliases to make\nthem faster to work with:\n\n```bash\n# `a` (add): add a new note named \"example.md\"\nnb a example.md\n\n# `+` (add): add a new note titled \"Example Title\"\nnb + --title \"Example Title\"\n\n# `b` (browse): open the folder named \"sample\" in the web browser\nnb b sample/\n\n# `o` (open): open the URL from bookmark 12 in your web browser\nnb o 12\n\n# `p` (peek): open the URL from bookmark 6 in your terminal browser\nnb p 6\n\n# `e` (edit): edit note 5\nnb e 5\n\n# `d` (delete): delete note 19\nnb d 19\n\n# `d` (delete): delete note 123 in the notebook named \"example:\"\nnb - example:123\n\n# `s` (show): show note 27\nnb s 27\n\n# `q` (search): search notes for \"example query\"\nnb q \"example query\"\n\n# `h` (help): display the help information for the `add` subcommand\nnb h add\n\n# `u` (use): switch to example-notebook\nnb u example-notebook\n```\n\nFor more commands and options, run\n[`nb help`](#nb-help) or\n[`nb help <subcommand>`](#subcommands)\n\n<div align=\"center\">\n <img src=\"https://xwmx.github.io/misc/nb/images/gui-browse-themes.png\"\n alt=\"nb browse themes\"\n width=\"700\">\n</div>\n\n### `?` Help\n\n<div align=\"center\">\n <a href=\"#nb-help\">nb</a> ·\n <a href=\"#bookmark-help\">bookmark</a> ·\n <a href=\"#subcommands\">subcommands</a> ·\n <a href=\"#plugin-help\">plugins</a>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n<div align=\"center\">\n <a href=\"#add\">add</a> ·\n <a href=\"#archive\">archive</a> ·\n <a href=\"#bookmark\">bookmark</a> ·\n <a href=\"#browse\">browse</a> ·\n <a href=\"#completions\">completions</a> ·\n <a href=\"#copy\">copy</a> ·\n <a href=\"#count\">count</a> ·\n <a href=\"#delete\">delete</a> ·\n <a href=\"#do\">do</a> ·\n <a href=\"#edit\">edit</a> ·\n <a href=\"#env\">env</a> ·\n <a href=\"#export\">export</a> ·\n <a href=\"#folders\">folders</a> ·\n <a href=\"#git\">git</a> ·\n <a href=\"#help\">help</a> ·\n <a href=\"#history\">history</a> ·\n <a href=\"#import\">import</a> ·\n <a href=\"#init\">init</a> ·\n <a href=\"#list\">list</a> ·\n <a href=\"#ls\">ls</a> ·\n <a href=\"#move\">move</a> ·\n <a href=\"#notebooks\">notebooks</a> ·\n <a href=\"#open\">open</a> ·\n <a href=\"#peek\">peek</a> ·\n <a href=\"#pin\">pin</a> ·\n <a href=\"#plugins\">plugins</a> ·\n <a href=\"#remote\">remote</a> ·\n <a href=\"#run\">run</a> ·\n <a href=\"#search\">search</a> ·\n <a href=\"#settings\">settings</a> ·\n <a href=\"#shell\">shell</a> ·\n <a href=\"#show\">show</a> ·\n <a href=\"#status\">status</a> ·\n <a href=\"#subcommands-1\">subcommands</a> ·\n <a href=\"#sync\">sync</a> ·\n <a href=\"#tasks\">tasks</a> ·\n <a href=\"#todo\">todo</a> ·\n <a href=\"#unarchive\">unarchive</a> ·\n <a href=\"#undo\">undo</a> ·\n <a href=\"#unpin\">unpin</a> ·\n <a href=\"#unset\">unset</a> ·\n <a href=\"#update\">update</a> ·\n <a href=\"#use\">use</a> ·\n <a href=\"#version\">version</a>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n<div align=\"center\">\n <a href=\"#overview\"> ↑ </a>\n</div>\n\n#### `nb help`\n\n[↑](#-help) · See also:\n[`help`](#help)\n\n```text\n__ _\n\\ \\ _ __ | |__\n \\ \\ | '_ \\| '_ \\\n / / | | | | |_) |\n/_/ |_| |_|_.__/\n\n[nb] Command line and local web note-taking, bookmarking, and archiving with\nplain text data storage, encryption, filtering and search, pinning, #tagging,\nGit-backed versioning and syncing, Pandoc-backed conversion, global and local\nnotebooks, customizable color themes, [[wiki-style linking]], plugins, and more\nin a single portable, user-friendly script.\n\nHelp:\n nb help Display this help information.\n nb help <subcommand> View help information for <subcommand>.\n nb help --colors View information about color settings.\n nb help --readme View the `nb` README file.\n\nUsage:\n nb\n nb [<ls-options>...] [<id> | <filename> | <path> | <title> | <notebook>]\n nb [<url>] [<bookmark options>...]\n nb add [<notebook>:][<folder-path>/][<filename>] [<content>]\n [-b | --browse] [-c <content> | --content <content>] [--edit]\n [-e | --encrypt] [-f <filename> | --filename <filename>]\n [--folder <folder-path>] [--no-template] [--tags <tag1>,<tag2>...]\n [--template <template>] [-t <title> | --title <title>] [--type <type>]\n nb add bookmark [<bookmark-options>...]\n nb add folder [<name>]\n nb add todo [<todo-options>...]\n nb archive [<notebook>]\n nb bookmark [<ls-options>...]\n nb bookmark [<notebook>:][<folder-path>/] <url>...\n [-c <comment> | --comment <comment>] [--edit] [-e | --encrypt]\n [-f <filename> | --filename <filename>] [--no-request]\n [-q <quote> | --quote <quote>] [--save-source]\n [-r (<url> | <selector>) | --related (<url> | <selector>)]...\n [-t <tag1>,<tag2>... | --tags <tag1>,<tag2>...] [--title <title>]\n nb bookmark [list [<list-options>...]]\n nb bookmark (open | peek | url) (<id> | <filename> | <path> | <title>)\n nb bookmark (edit | delete) (<id> | <filename> | <path> | <title>)\n nb bookmark search <query>\n nb browse [<notebook>:][<folder-path>/][<id> | <filename> | <title>] [--daemon]\n [-g | --gui] [-n | --notebooks] [-p | --print] [-q | --query <query>]\n [-s | --serve] [-t <tag> | --tag <tag> | --tags <tag1>,<tag2>...]\n nb browse add [<notebook>:][<folder-path>/][<filename>]\n [-c <content> | --content <content>] [--tags <tag1>,<tag2>...]\n [-t <title> | --title <title>]\n nb browse delete ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb browse edit ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb completions (check | install [-d | --download] | uninstall)\n nb copy ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [[<notebook>:][<folder-path>/]<filename>]\n nb count [<notebook>:][<folder-path>/]\n nb delete ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])...\n [-f | --force]\n nb do ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [<task-number>]\n nb edit ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [-c <content> | --content <content>] [--edit]\n [-e <editor> | --editor <editor>] [-l | --last] [--overwrite]\n [--prepend]\n nb env [-l | --long]\n nb env [install | update] [--ace | --mathjax]\n nb export ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n <path> [-f | --force] [<pandoc options>...]\n nb export notebook <name> [<path>]\n nb export pandoc ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [<pandoc options>...]\n nb folders (add | delete) [<notebook>:][<folder-path>/]<folder-name>\n nb folders <list-options>...\n nb git [checkpoint [<message>] | dirty]\n nb git <git-options>...\n nb help [<subcommand>] [-p | --print]\n nb help [-c | --colors] | [-r | --readme] | [-s | --short] [-p | --print]\n nb history [<notebook>:][<folder-path>/][<id> | <filename> | <title>]\n nb import [bookmarks | copy | download | move] (<path>... | <url>)\n [--convert] [<notebook>:][<folder-path>/][<filename>]\n nb import notebook <path> [<name>]\n nb init [<remote-url> [<branch>]] [--author] [--email <email>]\n [--name <name>]\n nb list [-e [<length>] | --excerpt [<length>]] [--filenames]\n [-f | --folders-first] [-n <limit> | --limit <limit> | --<limit>]\n [--no-id] [--no-indicator] [-p <number> | --page <number>] [--pager]\n [--paths] [-s | --sort] [-r | --reverse] [--tags]\n [-t <type> | --type <type> | --<type>]\n [<notebook>:][<folder-path>/][<id> | <filename> | <path> | <query>]\n nb ls [-a | --all] [-b | --browse] [-e [<length>] | --excerpt [<length>]]\n [--filenames] [-f | --folders-first] [-g | --gui]\n [-n <limit> | --limit <limit> | --<limit>] [--no-footer] [--no-header]\n [--no-id] [--no-indicator] [-p <number> | --page <number>] [--pager]\n [--paths] [-s | --sort] [-r | --reverse] [--tags]\n [-t <type> | --type <type> | --<type>]\n [<notebook>:][<folder-path>/][<id> | <filename> | <path> | <query>]\n nb move ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n ([<notebook>:][<path>] | --reset | --to-bookmark | --to-note |\n --to-title | --to-todo) [-f | --force]\n nb notebooks [<name> | <query>] [--ar | --archived] [--global] [--local]\n [--names] [--paths] [--unar | --unarchived]\n nb notebooks add ([<name>] [<remote-url> [<branch>... | --all]]) [--author]\n [--email <email>] [--name <name>]\n nb notebooks (archive | open | peek | status | unarchive) [<name>]\n nb notebooks author [<name> | <path>] [--email <email>] [--name <name>]\n nb notebooks current [--path | --selected | --filename [<filename>]]\n [--global | --local]\n nb notebooks delete <name> [-f | --force]\n nb notebooks (export <name> [<path>] | import <path>)\n nb notebooks init [<path> [<remote-url> [<branch>]]] [--author]\n [--email <email>] [--name <name>]\n nb notebooks rename <old-name> <new-name>\n nb notebooks select <selector>\n nb notebooks show (<name> | <path> | <selector>) [--ar | --archived]\n [--escaped | --name | --path | --filename [<filename>]]\n nb notebooks use <name>\n nb open ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb peek ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb pin ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb plugins [<name>] [--paths]\n nb plugins install [<path> | <url>] [--force]\n nb plugins uninstall <name> [--force]\n nb remote [branches [<url>] | remove | rename [<branch-name>] <name>]\n nb remote [delete <branch-name> | reset <branch-name>]\n nb remote set <url> [<branch-name>]\n nb run <command> [<arguments>...]\n nb search ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n <query>... [-a | --all] [--and <query>] [--not <query>] [--or <query>]\n [-l | --list] [--path] [-t <tag1>,<tag2>... | --tag <tag1>,<tag2>...]\n [-t | --tags] [--type <type> | --<type>] [--utility <name>]\n nb set [<name> [<value>] | <number> [<value>]]\n nb settings [colors [<number> | themes] | edit | list [--long]]\n nb settings (get | show | unset) (<name> | <number>)\n nb settings set (<name> | <number>) <value>\n nb shell [<subcommand> [<options>...] | --clear-history]\n nb show ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [[-a | --added] | [--authors] | [-b | --browse] | --filename | --id |\n --info-line | --path | [-p | --print] | --relative-path | [-r |\n --render] | --title | --type [<type>] | [-u | --updated]] [--no-color]\n nb show <notebook>\n nb status [<notebook>]\n nb subcommands [add <name>...] [alias <name> <alias>]\n [describe <name> <usage>]\n nb sync [-a | --all]\n nb tasks ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [open | closed]\n nb todo add [<notebook>:][<folder-path>/][<filename>] <title>\n [--description <description>] [--due <date>]\n [-r (<url> | <selector>) | --related (<url> | <selector>)]\n [--tags <tag1>,<tag2>...] [--task <title>...]\n nb todo do ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [<task-number>]\n nb todo undo ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [<task-number>]\n nb todos [<notebook>:][<folder-path>/] [open | closed] [--pager]\n [--tags <tag1>,<tag2>...]\n nb todos tasks ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [open | closed] [--pager]\n nb unarchive [<notebook>]\n nb undo ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [<task-number>]\n nb unpin ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb unset (<name> | <number>)\n nb update\n nb use <notebook>\n nb -h | --help | help [<subcommand> | --readme]\n nb -i | --interactive [<subcommand> [<options>...]]\n nb --no-color\n nb --version | version\n\nSubcommands:\n (default) List notes and notebooks. This is an alias for `nb ls`.\n When a <url> is provided, create a new bookmark.\n add Add a note, folder, or file.\n archive Archive the current or specified notebook.\n bookmark Add, open, list, and search bookmarks.\n browse Browse and manage linked items in terminal and GUI web browsers.\n completions Install and uninstall completion scripts.\n copy Copy or duplicate an item.\n count Print the number of items in a notebook or folder.\n delete Delete a note.\n do Mark a todo or task as done.\n edit Edit a note.\n env Print environment information and install dependencies.\n export Export a note to a variety of different formats.\n folders Add, delete, and list folders.\n git Run `git` commands within the current notebook.\n help View help information for the program or a subcommand.\n history View git history for the current notebook or a note.\n import Import a file into the current notebook.\n init Initialize the first notebook.\n list List notes in the current notebook.\n ls List notebooks and notes in the current notebook.\n move Move or rename a note.\n notebooks Manage notebooks.\n open Open a bookmarked web page or notebook folder, or edit a note.\n peek View a note, bookmarked web page, or notebook in the terminal.\n pin Pin an item so it appears first in lists.\n plugins Install and uninstall plugins and themes.\n remote Configure the remote URL and branch for the notebook.\n run Run shell commands within the current notebook.\n search Search notes.\n settings Edit configuration settings.\n shell Start the `nb` interactive shell.\n show Show a note or notebook.\n status Run `git status` in the current notebook.\n subcommands List, add, alias, and describe subcommands.\n status Print notebook status information.\n sync Sync local notebook with the remote repository.\n tasks List tasks in todos, notebooks, folders, and other items.\n todo Manage todos and tasks.\n unarchive Unarchive the current or specified notebook.\n undo Mark a todo or task as not done.\n unpin Unpin a pinned item.\n unset Return a setting to its default value.\n update Update `nb` to the latest version.\n use Switch to a notebook.\n version Display version information.\n\nNotebook Usage:\n nb <notebook>:[<subcommand>] [<identifier>] [<options>...]\n nb <subcommand> <notebook>:<identifier> [<options>...]\n\nProgram Options:\n -h, --help Display this help information.\n -i, --interactive Start the `nb` interactive shell.\n --no-color Print without color highlighting.\n --version Display version information.\n\nMore Information:\n https://github.com/xwmx/nb\n```\n\n#### `bookmark help`\n\n[↑](#-help) · See also:\n[Bookmarks](#-bookmarks),\n[`bookmark`](#bookmark),\n[`browse`](#browse)\n\n```text\n __ __ __\n / /_ ____ ____ / /______ ___ ____ ______/ /__\n / __ \\/ __ \\/ __ \\/ //_/ __ `__ \\/ __ `/ ___/ //_/\n / /_/ / /_/ / /_/ / ,< / / / / / / /_/ / / / ,<\n/_.___/\\____/\\____/_/|_/_/ /_/ /_/\\__,_/_/ /_/|_|\n\nbookmark -- Command line bookmarking with tagging, encryption,\nfull-text page content search with regular expression support,\nGUI and terminal browser support, and data stored in plain text\nMarkdown files with Git-backed versioning and syncing.\n\nUsage:\n bookmark [<ls-options>...]\n bookmark [<notebook>:][<folder-path>] <url>\n [-c <comment> | --comment <comment>] [--edit] [-e | --encrypt]\n [-f <filename> | --filename <filename>] [--no-request]\n [-q <quote> | --quote <quote>] [--save-source]\n [-r (<url> | <selector>) | --related (<url> | <selector>)]...\n [-t <tag1>,<tag2>... | --tags <tag1>,<tag2>...] [--title <title>]\n bookmark (edit | delete | open | peek | url)\n ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n bookmark search <query>\n\nOptions:\n -c, --comment <comment> A comment or description for this bookmark.\n --edit Open the bookmark in your editor before saving.\n -e, --encrypt Encrypt the bookmark with a password.\n -f, --filename <filename> The filename for the bookmark. It is\n recommended to omit the extension so the\n default bookmark extension is used.\n --no-request Don't request or download the target page.\n -q, --quote <quote> A quote or excerpt from the saved page.\n Alias: `--excerpt`\n -r, --related <selector> A selector for an item related to the\n bookmarked page.\n -r, --related <url> A URL for a page related to the bookmarked page.\n Multiple `--related` flags can be used in a\n command to save multiple related URLs.\n --save-source Save the page source as HTML.\n -t, --tags <tag1>,<tag2>... A comma-separated list of tags.\n --title <title> The bookmark title. When not specified,\n `nb` will use the html <title> tag.\n\nSubcommands:\n (default) Add a new bookmark for <url>, or list bookmarks.\n Bookmarks can also be added with `nb <url>`\n delete Delete a bookmark.\n edit Edit a bookmark.\n list List bookmarks in the current notebook.\n Shortcut Alias: `ls`\n open Open the bookmarked page in your system's primary web browser.\n Shortcut Alias: `o`\n peek Open the bookmarked page in your terminal web browser.\n Alias: `preview`\n Shortcut Alias: `p`\n search Search bookmarks for <query>.\n Shortcut Alias: `q`\n url Print the URL for the specified bookmark.\n\nDescription:\n Create, view, search, edit, and delete bookmarks.\n\n By default, the html page content is saved within the bookmark, making the\n bookmarked page available for full-text search. When Pandoc [1] is\n installed, the HTML content is converted to Markdown before saving.\n When readability-cli [2] is install, markup is cleaned up to focus on\n content.\n\n `peek` opens the page in `w3m` [3] or `links` [4] when available.\n To specify a preferred browser, set the `$BROWSER` environment variable\n in your .bashrc, .zshrc, or equivalent, e.g.: export BROWSER=\"lynx\"\n\n Bookmarks are identified by the `.bookmark.md` file extension. The\n bookmark URL is the first URL in the file within \"<\" and \">\" characters:\n\n <https://www.example.com>\n\n 1. https://pandoc.org/\n 2. https://gitlab.com/gardenappl/readability-cli\n 3. https://en.wikipedia.org/wiki/W3m\n 4. https://en.wikipedia.org/wiki/Links_(web_browser)\n\nRead More:\n https://github.com/xwmx/nb#-bookmarks\n\nSee Also:\n nb help browse\n nb help open\n nb help peek\n nb help show\n\nExamples:\n bookmark https://example.com\n bookmark https://example.com --encrypt\n bookmark https://example.com --tags example,sample,demo\n bookmark https://example.com/about -c \"Example comment.\"\n bookmark https://example.com/faqs -f example-filename\n bookmark https://example.com --quote \"Example quote or excerpt.\"\n bookmark list\n bookmark search \"example query\"\n bookmark open 5\n\n------------------------------------------\nPart of `nb` (https://github.com/xwmx/nb).\nFor more information, see: `nb help`.\n```\n\n### Subcommands\n\n<div align=\"center\">\n <a href=\"#add\">add</a> ·\n <a href=\"#archive\">archive</a> ·\n <a href=\"#bookmark\">bookmark</a> ·\n <a href=\"#browse\">browse</a> ·\n <a href=\"#completions\">completions</a> ·\n <a href=\"#copy\">copy</a> ·\n <a href=\"#count\">count</a> ·\n <a href=\"#delete\">delete</a> ·\n <a href=\"#do\">do</a> ·\n <a href=\"#edit\">edit</a> ·\n <a href=\"#env\">env</a> ·\n <a href=\"#folders\">folders</a> ·\n <a href=\"#export\">export</a> ·\n <a href=\"#git\">git</a> ·\n <a href=\"#help\">help</a> ·\n <a href=\"#history\">history</a> ·\n <a href=\"#import\">import</a> ·\n <a href=\"#init\">init</a> ·\n <a href=\"#list\">list</a> ·\n <a href=\"#ls\">ls</a> ·\n <a href=\"#move\">move</a> ·\n <a href=\"#notebooks\">notebooks</a> ·\n <a href=\"#open\">open</a> ·\n <a href=\"#peek\">peek</a> ·\n <a href=\"#pin\">pin</a> ·\n <a href=\"#plugins\">plugins</a> ·\n <a href=\"#remote\">remote</a> ·\n <a href=\"#run\">run</a> ·\n <a href=\"#search\">search</a> ·\n <a href=\"#settings\">settings</a> ·\n <a href=\"#shell\">shell</a> ·\n <a href=\"#show\">show</a> ·\n <a href=\"#status\">status</a> ·\n <a href=\"#subcommands-1\">subcommands</a> ·\n <a href=\"#sync\">sync</a> ·\n <a href=\"#tasks\">tasks</a> ·\n <a href=\"#todo\">todo</a> ·\n <a href=\"#unarchive\">unarchive</a> ·\n <a href=\"#undo\">undo</a> ·\n <a href=\"#unpin\">unpin</a> ·\n <a href=\"#unset\">unset</a> ·\n <a href=\"#update\">update</a> ·\n <a href=\"#use\">use</a> ·\n <a href=\"#version\">version</a>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n<div align=\"center\">\n <a href=\"#overview\"> ↑ </a>\n</div>\n\n#### `add`\n\n[↑](#-help) · See also:\n[Adding](#adding),\n[`bookmark`](#bookmark),\n[`browse`](#browse),\n[`delete`](#delete),\n[`edit`](#edit),\n[`folders`](#folders),\n[`import`](#import),\n[`show`](#show),\n[`todo`](#todo)\n\n```text\nUsage:\n nb add [<notebook>:][<folder-path>/][<filename>] [<content>]\n [-b | --browse] [-c <content> | --content <content>] [--edit]\n [-e | --encrypt] [-f <filename> | --filename <filename>]\n [--folder <folder-path>] [--no-template] [--tags <tag1>,<tag2>...]\n [--template <template>] [-t <title> | --title <title>] [--type <type>]\n nb add bookmark [<bookmark-options>...]\n nb add folder [<name>]\n nb add todo [<todo-options>...]\n\nOptions:\n -b, --browse Add using a terminal or GUI web browser.\n -c, --content <content> The content for the new note.\n --edit Open the note in the editor before saving when\n content is piped or passed as an argument.\n -e, --encrypt Encrypt the note with a password.\n -f, --filename <filename> The filename for the new note.\n --folder <folder-path> Add within the folder located at <folder-path>.\n --no-template Skip the template when one is assigned.\n --tags <tag1>,<tag2>... A comma-separated list of tags.\n --template <template> A string template or path to a template file.\n -t, --title <title> The title for a new note. If `--title` is\n present, the filename is derived from the\n title, unless `--filename` is specified.\n --type <type> The file type for the new note, as a file\n extension.\n\nDescription:\n Create a new note or folder.\n\n If no arguments are passed, a new blank note file is opened with `$EDITOR`,\n currently set to: example\n\n If a non-option argument is passed, `nb` will treat it as a <filename≥\n if a file extension is found. If no file extension is found, `nb` will\n treat the string as <content> and will create a new note without opening the\n editor. `nb add` can also create a new note with piped content.\n\n `nb` creates Markdown files by default. To create a note with a\n different file type, use the extension in the filename or use the `--type`\n option. To change the default file type, use `nb set default_extension`.\n\n When the `-e` / `--encrypt` option is used, `nb` will encrypt the\n note with AES-256 using OpenSSL by default, or GPG, if configured in\n `nb set encryption_tool`.\n\nRead More:\n https://github.com/xwmx/nb#adding\n\nSee Also:\n nb help bookmark\n nb help browse\n nb help delete\n nb help edit\n nb help folders\n nb help import\n nb help show\n nb help todo\n\nExamples:\n nb add\n nb add example.md\n nb add \"Note content.\"\n nb add example.md --title \"Example Title\" --content \"Example content.\"\n echo \"Note content.\" | nb add\n nb add -t \"Secret Document\" --encrypt\n nb add example/document.md\n nb add folder sample/demo\n nb example:add\n nb example:add -t \"Title\"\n nb a\n nb a \"Note content.\"\n nb example:a\n nb example:a -t \"Title\"\n\nAliases:\n nb create\n nb new\n\nShortcut Aliases:\n nb a\n nb +\n```\n\n#### `archive`\n\n[↑](#-help) · See also:\n[Archiving Notebooks](#archiving-notebooks),\n[`notebooks`](#notebooks),\n[`status`](#status),\n[`unarchive`](#unarchive)\n\n```text\nUsage:\n nb archive [<name>]\n\nDescription:\n Set the current notebook or notebook <name> to \"archived\" status.\n\n This is an alias for `nb notebooks archive`.\n\nRead More:\n https://github.com/xwmx/nb#archiving-notebooks\n\nSee Also:\n nb help notebooks\n nb help status\n nb help unarchive\n\nExamples:\n nb archive\n nb archive example\n\nShortcut Alias:\n nb ar\n```\n\n#### `bookmark`\n\n[↑](#-help) · See also:\n[Bookmarks](#-bookmarks),\n[`browse`](#browse),\n[`open`](#open),\n[`peek`](#peek),\n[`show`](#show)\n\n```text\nUsage:\n nb bookmark [<ls-options>...]\n nb bookmark [<notebook>:][<folder-path>/] <url>...\n [-c <comment> | --comment <comment>] [--edit] [-e | --encrypt]\n [-f <filename> | --filename <filename>] [--no-request]\n [-q <quote> | --quote <quote>] [--save-source]\n [-r (<url> | <selector>) | --related (<url> | <selector>)]...\n [-t <tag1>,<tag2>... | --tags <tag1>,<tag2>...] [--title <title>]\n nb bookmark list [<list-options>...]\n nb bookmark (edit | delete | open | peek | url)\n ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb bookmark search <query>\n\nOptions:\n -c, --comment <comment> A comment or description for this bookmark.\n --edit Open the bookmark in your editor before saving.\n -e, --encrypt Encrypt the bookmark with a password.\n -f, --filename <filename> The filename for the bookmark. It is\n recommended to omit the extension so the\n default bookmark extension is used.\n --no-request Don't request or download the target page.\n -q, --quote <quote> A quote or excerpt from the saved page.\n Alias: `--excerpt`\n -r, --related <selector> A selector for an item related to the\n bookmarked page.\n -r, --related <url> A URL for a page related to the bookmarked page.\n Multiple `--related` flags can be used in a\n command to save multiple related URLs.\n --save-source Save the page source as HTML.\n -t, --tags <tag1>,<tag2>... A comma-separated list of tags.\n --title <title> The bookmark title. When not specified,\n `nb` will use the html <title> tag.\n\nSubcommands:\n (default) Add a new bookmark for <url>, or list bookmarks.\n Bookmarks can also be added with `nb <url>`\n delete Delete a bookmark.\n edit Edit a bookmark.\n list List bookmarks in the current notebook.\n Shortcut Alias: `ls`\n open Open the bookmarked page in your system's primary web browser.\n Shortcut Alias: `o`\n peek Open the bookmarked page in your terminal web browser.\n Alias: `preview`\n Shortcut Alias: `p`\n search Search bookmarks for <query>.\n Shortcut Alias: `q`\n url Print the URL for the specified bookmark.\n\nDescription:\n Create, view, search, edit, and delete bookmarks.\n\n By default, the html page content is saved within the bookmark, making the\n bookmarked page available for full-text search. When Pandoc [1] is\n installed, the HTML content is converted to Markdown before saving.\n When readability-cli [2] is install, markup is cleaned up to focus on\n content.\n\n `peek` opens the page in `w3m` [3] or `links` [4] when available.\n To specify a preferred browser, set the `$BROWSER` environment variable\n in your .bashrc, .zshrc, or equivalent, e.g.: export BROWSER=\"lynx\"\n\n Bookmarks are identified by the `.bookmark.md` file extension. The\n bookmark URL is the first URL in the file within \"<\" and \">\" characters:\n\n <https://www.example.com>\n\n 1. https://pandoc.org/\n 2. https://gitlab.com/gardenappl/readability-cli\n 3. https://en.wikipedia.org/wiki/W3m\n 4. https://en.wikipedia.org/wiki/Links_(web_browser)\n\nRead More:\n https://github.com/xwmx/nb#-bookmarks\n\nSee Also:\n nb help browse\n nb help open\n nb help peek\n nb help show\n\nExamples:\n nb https://example.com\n nb example: https://example.com\n nb https://example.com --encrypt\n nb https://example.com --tags example,sample,demo\n nb https://example.com/about -c \"Example comment.\"\n nb https://example.com/faqs -f example-filename\n nb https://example.com --quote \"Example quote or excerpt.\"\n nb bookmark list\n nb bookmark search \"example query\"\n nb bookmark open 5\n nb bk\n\nShortcut Aliases:\n nb bk\n nb bm\n```\n\n#### `browse`\n\n[↑](#-help) · See also:\n[Browsing](#-browsing),\n[Images](#-images),\n[Linking](#-linking),\n[`add`](#add),\n[`delete`](#delete),\n[`edit`](#edit),\n[`list`](#list),\n[`ls`](#ls),\n[`open`](#open),\n[`peek`](#peek),\n[`pin`](#pin),\n[`search`](#search),\n[`show`](#show)\n\n```text\nUsage:\n nb browse [<notebook>:][<folder-path>/][<id> | <filename> | <title>] [--daemon]\n [-g | --gui] [-n | --notebooks] [-p | --print] [-q | --query <query>]\n [-s | --serve] [-t <tag> | --tag <tag> | --tags <tag1>,<tag2>...]\n nb browse add [<notebook>:][<folder-path>/][<filename>]\n [-c <content> | --content <content>] [--tags <tag1>,<tag2>...]\n [-t <title> | --title <title>]\n nb browse delete ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb browse edit ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n\nSubcommands:\n (default) Open a notebook, folder, or item in the terminal or GUI web browser.\n add Open the add view in the browser.\n Shortcut Aliases: `a`, `+`\n delete Open the delete view in the browser.\n Shortcut Aliases: `d`, `-`\n edit Open the edit view in the browser.\n Shortcut Alias: `e`\n\nOptions:\n -c, --content <content> Add content to the new note.\n --daemon Start the web server. Close with <CTRL-C>.\n -g, --gui Open in the system's primary GUI web browser.\n -n, --notebooks Browse notebooks.\n -p, --print Print to standard output.\n -q, --query <query> Open to the search results for <query>.\n -s, --serve Start the web server. Close with any key.\n -t, --tag <tag> Search for a tag.\n --tags <tag1>,<tag2>... A comma-separated list of tags.\n -t, --title <title> Add a title to the new note.\n\nDescription:\n Browse, view, and edit linked notes, bookmarks, notebooks, folders, and\n other items using terminal and GUI web browsers.\n\n `browse` includes an embedded web application designed for terminal\n and GUI web browsers that renders [[wiki-style links]] and #tags as\n internal links, providing the ability to browse notes and notebooks,\n as well as seamlessly browse to and from the offsite links in\n bookmarks and notes.\n\n To link to a note or bookmark from another, include the selector for the\n target item within double square brackets anywhere in the linking document:\n\n # link to item 123 in the \"sample\" folder in the \"example\" notebook\n [[example:sample/123]]\n\n # link to the item titled \"Example Title\" in the \"demo\" notebook\n [[demo:Example Title]]\n\n `browse` supports `w3m` [1] and `links` [2], and depends on\n `ncat` [3] or `socat` [4] and `pandoc` [5]:\n\n 1. https://en.wikipedia.org/wiki/W3m\n 2. https://en.wikipedia.org/wiki/Links_(web_browser)\n 3. https://nmap.org/ncat/\n 4. https://www.kali.org/tools/socat/\n 5. https://pandoc.org/\n\nRead More:\n https://github.com/xwmx/nb#-browsing\n\nSee Also:\n nb help add\n nb help delete\n nb help edit\n nb help list\n nb help ls\n nb help open\n nb help peek\n nb help pin\n nb help search\n nb help show\n nb help unpin\n\nExamples:\n nb browse\n nb browse example:\n nb browse Example\\ Folder/\n nb browse 123\n nb browse demo:456\n nb br\n\nShortcut Alias:\n nb b\n```\n\n#### `completions`\n\n[↑](#-help) · See also:\n[Tab Completion](https://github.com/xwmx/nb/tree/master/etc),\n[`env`](#env)\n\n```text\nUsage:\n nb completions (check | install [-d | --download] | uninstall)\n\nOptions:\n -d, --download Download the completion scripts and install.\n\nDescription:\n Manage completion scripts.\n\nRead More:\n https://github.com/xwmx/nb/blob/master/etc/README.md\n\nSee Also:\n nb help env\n```\n\n#### `copy`\n\n[↑](#-help) · See also:\n[Moving & Renaming](#-moving--renaming),\n[`move`](#move)\n\n```text\nUsage:\n nb copy ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [[<notebook>:][<folder-path>/]<filename>]\n\nDescription:\n Copy or duplicate an item.\n\nRead More:\n https://github.com/xwmx/nb#-moving--renaming\n\nSee Also:\n nb help move\n\nExamples:\n nb copy 321\n nb copy 456 example:\n nb copy sample/demo.md\n\nAlias:\n nb duplicate\n```\n\n#### `count`\n\n[↑ ](#-help)\n\n```text\nUsage:\n nb count [<notebook>:][<folder-path>/]\n\nDescription:\n Print the number of items in the first level of the current notebook,\n <notebook>, or the folder at <folder-path>.\n```\n\n#### `delete`\n\n[↑](#-help) · See also:\n[Deleting](#deleting),\n[`add`](#add),\n[`browse`](#browse),\n[`edit`](#edit),\n[`move`](#move),\n[`show`](#show)\n\n```text\nUsage:\n nb delete ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])...\n [-f | --force]\n\nOptions:\n -f, --force Skip the confirmation prompt.\n\nDescription:\n Delete one or more items.\n\nRead More:\n https://github.com/xwmx/nb#deleting\n\nSee Also:\n nb help add\n nb help browse\n nb help edit\n nb help move\n nb help show\n\nExamples:\n nb delete 3\n nb delete example.md\n nb delete \"A Document Title\"\n nb 3 delete --force\n nb example:delete 12\n nb delete example:12\n nb example:12 delete\n nb d 3\n nb 3 d\n nb d example:12\n nb example:12 d\n\nAliases:\n nb rm\n nb trash\n\nShortcut Aliases:\n nb d\n nb -\n```\n\n#### `do`\n\n[↑](#-help) · See also:\n[Todos](#-todos),\n[Tasks](#%EF%B8%8F-tasks),\n[`tasks`](#tasks),\n[`todo`](#todo),\n[`undo`](#undo)\n\n```text\nUsage:\n nb do ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [<task-number>]\n\nDescription:\n Mark a todo or task as done.\n\nRead More:\n https://github.com/xwmx/nb#-todos\n\nSee Also:\n nb help tasks\n nb help todo\n nb help undo\n\nExamples:\n nb do 123\n nb do example:sample/321\n nb do 543 7\n```\n\n#### `edit`\n\n[↑](#-help) · See also:\n[Editing](#editing),\n[`add`](#add),\n[`browse`](#browse),\n[`delete`](#delete),\n[`move`](#move),\n[`show`](#show)\n\n```text\nUsage:\n nb edit ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [-c <content> | --content <content>] [--edit]\n [-e <editor> | --editor <editor>] [-l | --last] [--overwrite]\n [--prepend]\n\nOptions:\n -c, --content <content> Content to add to the item.\n --edit Open the note in the editor before saving when\n content is piped or passed as an argument.\n -e, --editor <editor> Edit the note with <editor>, overriding the editor\n specified in the `$EDITOR` environment variable.\n -l, --last Edit the last modified item.\n --overwrite Overwrite existing content with <content> and\n standard input.\n --prepend Prepend <content> and standard input before\n existing content.\n\nDescription:\n Open the specified note in `$EDITOR` or <editor> if specified.\n Content piped to `nb edit` or passed using the `--content` option\n is appended to the file without opening it in the editor,\n unless the `--edit` flag is specified.\n\n Non-text files are opened in your system's preferred app or program for\n that file type.\n\nRead More:\n https://github.com/xwmx/nb#editing\n\nSee Also:\n nb help add\n nb help browse\n nb help delete\n nb help move\n nb help show\n\nExamples:\n nb edit 3\n nb edit example.md\n nb edit \"A Document Title\"\n echo \"Content to append.\" | nb edit 1\n nb 3 edit\n nb example:edit 12\n nb edit example:12\n nb example:12 edit\n nb e 3\n nb 3 e\n nb e example:12\n nb example:12 e\n\nShortcut Alias:\n nb e\n```\n\n#### `env`\n\n[↑](#-help) · See also:\n[Installation](#installation),\n[`completions`](#completions),\n[`init`](#init),\n[`update`](#update),\n[`version`](#version)\n\n```text\nUsage:\n nb env [-l | --long]\n nb env [install | update] [--ace | --mathjax]\n\nSubcommands:\n (default) Print environment and configuration information.\n install Install dependencies on supported systems.\n update Update dependencies.\n\nOptions:\n --ace Install or update Ace editor [1][2].\n -l, --long Print additional environmental information.\n --mathjax Install or update MathJax [3].\n\n 1. https://github.com/ajaxorg/ace\n 2. https://github.com/ajaxorg/ace-builds\n 3. https://github.com/mathjax/MathJax\n\nDescription:\n Print program environment and configuration information, or install\n dependencies.\n\nRead More:\n https://github.com/xwmx/nb#installation\n\nSee Also:\n nb help completions\n nb help init\n nb help update\n nb help version\n```\n\n#### `export`\n\n[↑](#-help) · See also:\n[Import / Export](#%EF%B8%8F-import--export),\n[`browse`](#browse),\n[`import`](#import)\n\n```text\nUsage:\n nb export ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n <path> [-f | --force] [<pandoc options>...]\n nb export notebook <name> [<path>]\n nb export pandoc ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [<pandoc options>...]\n\nOptions:\n -f, --force Skip the confirmation prompt when overwriting an existing file.\n\nSubcommands:\n (default) Export a file to <path>. If <path> has a different extension\n than the source note, convert the note using `pandoc`.\n notebook Export the notebook <name> to the current directory or <path>.\n Alias for `nb notebooks export`.\n pandoc Export the file to standard output or a file using `pandoc`.\n `export pandoc` prints to standard output by default.\n\nDescription:\n Export a file or notebook.\n\n If Pandoc [1] is available, convert the note from its current format\n to the format of the output file as indicated by the file extension\n in <path>. Any additional arguments are passed directly to Pandoc.\n See the Pandoc help information for available options.\n\n 1. https://pandoc.org/\n\nRead More:\n https://github.com/xwmx/nb#%EF%B8%8F-import--export\n\nSee Also:\n nb help browse\n nb help import\n\nExamples:\n # Export an Org note\n nb export example.org /path/to/example.org\n\n # Export a Markdown note to HTML and print to standard output\n nb export pandoc example.md --from=markdown_strict --to=html\n\n # Export a Markdown note to a .docx Microsoft Office Word document\n nb export example.md /path/to/example.docx\n\n # Export note 12 in the \"sample\" notebook to HTML\n nb export sample:12 /path/to/example.html\n```\n\n#### `folders`\n\n[↑](#-help) · See also:\n[Folders](#-folders),\n[`add`](#add),\n[`delete`](#delete),\n[`list`](#list),\n[`ls`](#ls)\n\n```text\nUsage:\n nb folders add [<notebook>:][<folder-path>/]<folder-name>\n nb folders delete [<notebook>:][<folder-path>/]<folder-name>\n nb folders <list-options>...\n\nSubcommands:\n (default) List folders.\n add Add a new folder.\n delete Delete a folder.\n\nDescription:\n Add, delete, and list folders.\n\nRead More:\n https://github.com/xwmx/nb#-folders\n\nSee Also:\n nb help add\n nb help delete\n nb help list\n nb help ls\n\nExamples:\n nb folders\n nb folders add example\n nb folders delete example:sample\n\nAlias:\n nb folder\n\nShortcut Alias:\n nb f\n```\n\n#### `git`\n\n[↑](#-help) · See also:\n[Git Sync](#-git-sync),\n[History](#-revision-history),\n[`history`](#history),\n[`remote`](#remote),\n[`run`](#run),\n[`status`](#status),\n[`sync`](#sync)\n\n```text\nUsage:\n nb git [checkpoint [<message>] | dirty]\n nb git <git-options>...\n\nSubcommands:\n checkpoint Create a new git commit in the current notebook and sync with\n the remote if `nb set auto_sync` is enabled.\n dirty 0 (success, true) if there are uncommitted changes in the\n current notebook. 1 (error, false) if the notebook is clean.\n\nDescription:\n Run `git` commands within the current notebook directory.\n\nRead More:\n https://github.com/xwmx/nb#-git-sync\n https://github.com/xwmx/nb#-revision-history\n\nSee Also:\n nb help history\n nb help remote\n nb help run\n nb help status\n nb help sync\n\nExamples:\n nb git status\n nb git diff\n nb git log\n nb example:git status\n```\n\n#### `help`\n\n[↑](#-help) · See also:\n[`nb help`](#nb-help)\n\n```text\nUsage:\n nb help [<subcommand>] [-p | --print]\n nb help [-c | --colors] | [-r | --readme] | [-s | --short] [-p | --print]\n\nOptions:\n -c, --colors View information about color themes and color settings.\n -p, --print Print to standard output / terminal.\n -r, --readme View the `nb` README file.\n -s, --short Print shorter help without subcommand descriptions.\n\nDescription:\n Print the program help information. When a subcommand name is passed, print\n the help information for the subcommand.\n\nExamples:\n nb help\n nb help add\n nb help import\n nb h notebooks\n nb h e\n\nShortcut Alias:\n nb h\n```\n\n#### `history`\n\n[↑](#-help) · See also:\n[History](#-revision-history),\n[Git Sync](#-git-sync),\n[`git`](#git),\n[`remote`](#remote),\n[`status`](#status),\n[`sync`](#sync)\n\n```text\nUsage:\n nb history [<notebook>:][<folder-path>/][<id> | <filename> | <title>]\n\nDescription:\n Display notebook history using `tig` [1] (if available) or `git log`.\n When a note is specified, the history for that note is displayed.\n\n 1. https://github.com/jonas/tig\n\nRead More:\n https://github.com/xwmx/nb#-revision-history\n https://github.com/xwmx/nb#-git-sync\n\nSee Also:\n nb help git\n nb help remote\n nb help status\n nb help sync\n\nExamples:\n nb history\n nb history example.md\n nb 3 history\n nb history example:\n nb example:history\n nb example:history 12\n nb history example:12\n nb example:12 history\n```\n\n#### `import`\n\n[↑](#-help) · See also:\n[Import / Export](#%EF%B8%8F-import--export),\n[Images](#-images),\n[`add`](#add),\n[`export`](#export)\n\n```text\nUsage:\n nb import [bookmarks | copy | download | move] (<path>... | <url>)\n [--convert] [<notebook>:][<folder-path>/][<filename>]\n nb import notebook <path> [<name>]\n\nOptions:\n --convert Convert HTML content to Markdown.\n\nSubcommands:\n (default) Copy or download the file(s) at <path> or <url>.\n bookmarks Import bookmarks from a Chrome, Firefox, or Edge export file.\n copy Copy the file(s) at <path> into the current notebook.\n download Download the file at <url> into the current notebook.\n move Move the file(s) at <path> into the current notebook.\n notebook Import the local notebook at <path> to make it global.\n\nDescription:\n Copy, move, or download files into `nb`, import bookmarks, or import\n a local notebook to make it global.\n\nDescription:\n Copy, move, or download files into the current notebook or import\n a local notebook to make it global.\n\nRead More:\n https://github.com/xwmx/nb#%EF%B8%8F-import--export\n\nSee Also:\n nb help add\n nb help export\n\nExamples:\n nb import ~/Pictures/example.png\n nb import ~/Documents/example.docx\n nb import https://example.com/example.pdf\n nb example:import https://example.com/example.jpg\n nb import ./*\n nb import ./*.md\n nb import ~/Pictures/example.png example-notebook:\n nb import ~/Documents/example.docx example-folder/\n\nShortcut Alias:\n nb i\n```\n\n#### `init`\n\n[↑](#-help) · See also: [`notebooks`](#notebooks)\n\n```text\nUsage:\n nb init [<remote-url> [<branch>]] [--author] [--email <email>]\n [--name <name>]\n\nOptions:\n --author Display the local email and name config prompt.\n --email <email> Set the local commit author email address to <email>.\n --name <name> Set the local commit author name to <name>.\n\nDescription:\n Initialize the initial \"home\" notebook and generate a configuration file at:\n\n ~/.nbrc\n\n Pass optional <remote-url> and <branch> arguments to create the initial\n \"home\" notebook using a clone of an existing notebook.\n\nSee Also:\n nb help notebooks\n\nExamples:\n nb init\n nb init https://github.com/example/example.git\n nb init https://github.com/example/example.git example-branch\n```\n\n#### `list`\n\n[↑](#-help) · See also:\n[Listing & Filtering](#listing--filtering),\n[`browse`](#browse),\n[`ls`](#ls),\n[`pin`](#pin),\n[`search`](#search),\n[`unpin`](#unpin)\n\n```text\nUsage:\n nb list [-e [<length>] | --excerpt [<length>]] [--filenames]\n [-f | --folders-first] [-n <limit> | --limit <limit> | --<limit>]\n [--no-id] [--no-indicator] [-p <number> | --page <number>] [--pager]\n [--paths] [-s | --sort] [-r | --reverse] [--tags]\n [-t <type> | --type <type> | --<type>]\n [<notebook>:][<folder-path>/][<id> | <filename> | <path> | <query>]\n\nOptions:\n -e, --excerpt [<length>] Print an excerpt <length> lines long under\n each note's filename [default: 3].\n --filenames Print the filename for each note.\n -f, --folders-first Print folders before other items.\n -n, --limit <limit>, --<limit> The maximum number of notes to list.\n --no-id Don't include the id in list items.\n --no-indicator Don't include the indicator in list items.\n -p, --page <number> The page to view in the list paginated by\n a <limit> option or `nb set limit`.\n --pager Display output in the pager.\n --paths Print the full path to each item.\n -s, --sort Order notes by id.\n -r, --reverse List items in reverse order.\n --tags List tags in the notebook or folder.\n -t, --type <type>, --<type> List items of <type>. <type> can be a file\n extension or one of the following types:\n archive, audio, book, bookmark, document,\n folder, image, note, text, video\n\nDescription:\n List notes in the current notebook.\n\n When <id>, <filename>, <path>, or <title> are present, the listing for the\n matching note is displayed. When no match is found, titles and filenames\n are searched for any that match <query> as a case-insensitive regular\n expression.\n\nRead More:\n https://github.com/xwmx/nb#listing--filtering\n\nIndicators:\n 🔉 Audio\n 📖 Book\n 🔖 Bookmark\n 🔒 Encrypted\n 📂 Folder\n 🌄 Image\n 📄 PDF, Word, or Open Office document\n 📹 Video\n\nSee Also:\n nb help browse\n nb help ls\n nb help pin\n nb help search\n nb help unpin\n\nExamples:\n nb list\n nb list example.md -e 10\n nb list --excerpt --no-id\n nb list --filenames --reverse\n nb list \"^Example.*\"\n nb list --10\n nb list --type document\n nb example:list\n```\n\n#### `ls`\n\n[↑](#-help) · See also:\n[Listing & Filtering](#listing--filtering),\n[`browse`](#browse),\n[`list`](#list),\n[`pin`](#pin),\n[`search`](#search),\n[`unpin`](#unpin)\n\n```text\nUsage:\n nb ls [-a | --all] [-b | --browse] [-e [<length>] | --excerpt [<length>]]\n [--filenames] [-f | --folders-first] [-g | --gui]\n [-n <limit> | --limit <limit> | --<limit>] [--no-footer] [--no-header]\n [--no-id] [--no-indicator] [-p <number> | --page <number>] [--pager]\n [--paths] [-s | --sort] [-r | --reverse] [--tags]\n [-t <type> | --type <type> | --<type>]\n [<notebook>:][<folder-path>/][<id> | <filename> | <path> | <query>]\n\nOptions:\n -a, --all Print all items in the notebook. Equivalent\n to no limit.\n -b, --browse Open the specified item or current notebook\n with `browse` in a terminal web browser.\n -e, --excerpt [<length>] Print an excerpt <length> lines long under\n each note's filename [default: 3].\n --filenames Print the filename for each note.\n -f, --folders-first Print folders before other items.\n -g, --gui Open the specified item or current notebook\n with `browse` in a GUI web browser.\n -n, --limit <limit>, --<limit> The maximum number of listed items.\n [default: 15]\n --no-footer Print without footer.\n --no-header Print without header.\n --no-id Don't include the id in list items.\n --no-indicator Don't include the indicator in list items.\n -p, --page <number> The page to view in the list paginated by\n a <limit> option or `nb set limit`.\n --pager Display output in the pager.\n --paths Print the full path to each item.\n -s, --sort Order notes by id.\n -r, --reverse List items in reverse order.\n --tags List tags in the notebook or folder.\n -t, --type <type>, --<type> List items of <type>. <type> can be a file\n extension or one of the following types:\n archive, audio, book, bookmark, document,\n folder, image, note, text, video\n\nDescription:\n List notebooks and notes in the current notebook, displaying note titles\n when available. `nb ls` is a combination of `nb notebooks` and\n `nb list` in one view.\n\n When <id>, <filename>, <path>, or <title> are present, the listing for the\n matching note is displayed. When no match is found, titles and filenames\n are searched for any that match <query> as a case-insensitive regular\n expression.\n\n Options are passed through to `list`. For more information, see\n `nb help list`.\n\nRead More:\n https://github.com/xwmx/nb#listing--filtering\n\nIndicators:\n 🔉 Audio\n 📖 Book\n 🔖 Bookmark\n 🔒 Encrypted\n 📂 Folder\n 🌄 Image\n 📄 PDF, Word, or Open Office document\n 📹 Video\n\nSee Also:\n nb help browse\n nb help list\n nb help pin\n nb help search\n nb help unpin\n\nExamples:\n nb\n nb --all\n nb ls\n nb ls example.md -e 10\n nb ls --excerpt --no-id\n nb ls --reverse\n nb ls \"^Example.*\"\n nb ls --10\n nb ls --type document\n nb example:\n nb example: -ae\n nb example:ls\n\nShortcut Alias:\n nb\n```\n\n#### `move`\n\n[↑](#-help) · See also:\n[Moving & Renaming](#-moving--renaming),\n[`copy`](#copy),\n[`delete`](#delete),\n[`edit`](#edit)\n\n```text\nUsage:\n nb move ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n ([<notebook>:][<path>] | --reset | --to-bookmark | --to-note |\n --to-title | --to-todo) [-f | --force]\n\nOptions:\n -f, --force Skip the confirmation prompt.\n --reset Reset the filename to the last modified timestamp.\n --to-bookmark Preserve the existing filename and replace the extension\n with \".bookmark.md\" to convert the note to a bookmark.\n --to-note Preserve the existing filename and replace the bookmark's\n \".bookmark.md\" extension with \".md\" to convert the bookmark\n to a Markdown note.\n --to-title Set the filename to the note title, lowercased with spaces\n and disallowed filename characters replaced with underscores.\n --to-todo Preserve the existing filename and replace the extension\n with \".todo.md\" to convert the note to a todo.\n\nDescription:\n Move or rename a note. Move the note to <path> or change the file type.\n When the file extension is omitted, the existing extension is used.\n When only a file extension is specified, only the extension will be updated.\n\n `nb move` and `nb rename` are aliases and can be used interchangeably.\n\nRead More:\n https://github.com/xwmx/nb#-moving--renaming\n\nSee Also:\n nb help copy\n nb help delete\n nb help edit\n\nExamples:\n # move \"example.md\" to \"sample.org\"\n nb move example.md sample.org\n\n # rename note 3 (\"example.md\") to \"New Name.md\"\n nb rename 3 \"New Name\"\n\n # rename \"example.bookmark.md\" to \"New Name.bookmark.md\"\n nb move example.bookmark.md \"New Name\"\n\n # rename note 3 (\"example.md\") to a bookmark named \"example.bookmark.md\"\n nb rename 3 --to-bookmark\n\n # move note 12 into \"Sample Folder\" in the \"demo\" notebook\n nb move example:12 demo:Sample\\ Folder/\n\n # rename note 12 in the \"example\" notebook to \"sample.md\"\n nb rename example:12 \"sample.md\"\n\n # change the file extension of note 5 to .org\n nb rename 5 .org\n\nAlias:\n nb rename\n\nShortcut Alias:\n nb mv\n```\n\n#### `notebooks`\n\n[↑](#-help) · See also:\n[Notebooks](#-notebooks),\n[`archive`](#archive),\n[`history`](#history),\n[`move`](#move),\n[`remote`](#remote),\n[`status`](#status),\n[`sync`](#sync),\n[`unarchive`](#unarchive),\n[`use`](#use)\n\n```text\nUsage:\n nb notebooks [<name> | <query>] [--ar | --archived] [--global] [--local]\n [--names] [--paths] [--unar | --unarchived]\n nb notebooks add ([<name>] [<remote-url> [<branch>... | --all]]) [--author]\n [--email <email>] [--name <name>]\n nb notebooks (archive | open | peek | status | unarchive) [<name>]\n nb notebooks author [<name> | <path>] [--email <email>] [--name <name>]\n nb notebooks current [--path | --selected | --filename [<filename>]]\n [--global | --local]\n nb notebooks delete <name> [-f | --force]\n nb notebooks (export <name> [<path>] | import <path>)\n nb notebooks init [<path> [<remote-url> [<branch>]]] [--author]\n [--email <email>] [--name <name>]\n nb notebooks rename <old-name> <new-name>\n nb notebooks select <selector>\n nb notebooks show (<name> | <path> | <selector>) [--ar | --archived]\n [--escaped | --name | --path | --filename [<filename>]]\n nb notebooks use <name>\n\nOptions:\n --all Add notebooks from all remote branches.\n --ar, --archived List archived notebooks, or return archival status\n with `show`.\n --author Set the notebook's commit author email and name.\n --email <email> Set the notebook's commit author email to <email>.\n --escaped Print the notebook name with spaces escaped.\n --filename [<filename>] Print an available filename for the notebooks. When\n <filename> is provided, check for an existing file\n and provide a filename with an appended sequence\n number for uniqueness.\n -f, --force Skip the confirmation prompt.\n --global List global notebooks or the notebook set globally\n with `use`.\n --local Exit with 0 if current within a local notebook,\n otherwise exit with 1.\n --name, --names Print the notebook name.\n --name <name> Set the notebook's commit author name to <name>.\n --path, --paths Print the notebook path.\n --selected Exit with 0 if the current notebook differs from\n the current global notebook, otherwise exit with 1.\n --unar, --unarchived Only list unarchived notebooks.\n\nSubcommands:\n (default) List notebooks.\n add Create a new global notebook. When <remote-url> is specified,\n create one or more new global notebook by cloning selected\n or specified <branch>es from <remote-url>.\n Aliases: `nb notebooks create`, `nb notebooks new`\n archive Set the current notebook or notebook <name> to \"archived\" status.\n author Configure the commit author email and name for the notebook.\n current Print the current notebook name or path.\n delete Delete a notebook.\n export Export the notebook <name> to the current directory or <path>,\n making it usable as a local notebook.\n import Import the local notebook at <path> to make it global.\n init Create a new local notebook. Specify a <path> or omit to\n initialize the current working directory as a local notebook.\n Specify <remote-url> to clone an existing notebook.\n open Open the current notebook directory or notebook <name> in the\n file browser, explorer, or finder.\n Shortcut Alias: `o`\n peek Open the current notebook directory or notebook <name> in the\n first tool found in the following list:\n `ranger` [1], `mc` [2], `vifm` [3], `joshuto` [4], `lsd` [5],\n `eza` [6], or `ls`.\n Shortcut Alias: `p`\n rename Rename a notebook. Aliases: `move`, `mv`\n select Set the current notebook from a colon-prefixed selector.\n Not persisted. Selection format: <notebook>:<identifier>\n status Print the archival status of the current notebook or\n notebook <name>.\n show Show and return information about a specified notebook.\n unarchive Remove \"archived\" status from the current notebook or notebook <name>.\n use Switch to a notebook.\n\n 1. https://ranger.github.io/\n 2. https://en.wikipedia.org/wiki/Midnight_Commander\n 3. https://vifm.info/\n 4. https://github.com/kamiyaa/joshuto\n 5. https://github.com/lsd-rs/lsd\n 6. https://github.com/eza-community/eza\n\nDescription:\n Manage notebooks.\n\nRead More:\n https://github.com/xwmx/nb#-notebooks\n\nSee Also:\n nb help archive\n nb help history\n nb help move\n nb help remote\n nb help status\n nb help sync\n nb help unarchive\n nb help use\n\nExamples:\n nb notebooks --names\n nb notebooks add sample\n nb notebooks add example https://github.com/example/example.git\n nb nb current --path\n nb nb archive example\n\nShortcut Aliases:\n nb n\n nb nb\n```\n\n#### `open`\n\n[↑](#-help) · See also:\n[Viewing Bookmarks](#viewing-bookmarks),\n[Images](#-images),\n[`bookmark`](#bookmark),\n[`browse`](#browse),\n[`peek`](#peek),\n[`show`](#show)\n\n```text\nUsage:\n nb open ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n\nDescription:\n Open an item or notebook. When the item is a bookmark, open the bookmarked\n page in your system's primary web browser. When the item is in a text format\n or any other file type, `open` is the equivalent of `edit`. `open`\n with a notebook opens the notebook folder in the system's file browser.\n\nRead More:\n https://github.com/xwmx/nb#viewing-bookmarks\n\nSee also:\n nb help bookmark\n nb help browse\n nb help peek\n nb help show\n\nExamples:\n nb open 3\n nb open example.bookmark.md\n nb 3 open\n nb example:open 12\n nb open example:12\n nb example:12 open\n nb o 3\n nb 3 o\n nb o example:12\n nb example:12 o\n\nShortcut Alias:\n nb o\n```\n\n#### `peek`\n\n[↑](#-help) · See also:\n[Viewing Bookmarks](#viewing-bookmarks),\n[`bookmark`](#bookmark),\n[`browse`](#browse),\n[`open`](#open),\n[`show`](#show)\n\n```text\nUsage:\n nb peek ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n\nDescription:\n View an item or notebook in the terminal. When the item is a bookmark, view\n the bookmarked page in your terminal web browser. When the note is in a text\n format or any other file type, `peek` is the equivalent of `show`. When\n used with a notebook, `peek` opens the notebook folder first tool found in\n the following list: `ranger` [1], `mc` [2], `vifm` [3], `joshuto` [4],\n `lsd` [5], eza` [6], or `ls`.\n\n 1. https://ranger.github.io/\n 2. https://en.wikipedia.org/wiki/Midnight_Commander\n 3. https://vifm.info/\n 4. https://github.com/kamiyaa/joshuto\n 5. https://github.com/lsd-rs/lsd\n 6. https://github.com/eza-community/eza\n\nRead More:\n https://github.com/xwmx/nb#viewing-bookmarks\n\nSee also:\n nb help bookmark\n nb help browse\n nb help open\n nb help show\n\nExamples:\n nb peek 3\n nb peek example.bookmark.md\n nb 3 peek\n nb example:peek 12\n nb peek example:12\n nb example:12 peek\n nb p 3\n nb 3 p\n nb p example:12\n nb example:12 p\n\nAlias:\n nb preview\n\nShortcut Alias:\n nb p\n```\n\n#### `pin`\n\n[↑](#-help) · See also:\n[Pinning](#-pinning),\n[`browse`](#browse),\n[`list`](#list),\n[`ls`](#ls),\n[`unpin`](#unpin)\n\n```text\nUsage:\n nb pin ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n\nDescription:\n Pin an item so it appears first in lists.\n\nRead More:\n https://github.com/xwmx/nb#-pinning\n\nSee Also:\n nb help browse\n nb help list\n nb help ls\n nb help unpin\n\nExamples:\n nb pin 123\n nb pin example:sample/321\n```\n\n#### `plugins`\n\n[↑](#-help) · See also:\n[Plugins](#-plugins),\n[Plugin Help](#plugin-help),\n[`subcommands`](#subcommands-1)\n\n```text\nUsage:\n nb plugins [<name>] [--paths] [--force]\n nb plugins install [<path> | <url>] [--force]\n nb plugins uninstall <name>\n\nOptions:\n --paths Print the full path to each plugin.\n\nSubcommands:\n (default) List plugins.\n install Install a plugin from a <path> or <url>.\n uninstall Uninstall the specified plugin.\n\nDescription:\n Manage plugins and themes.\n\nRead More:\n https://github.com/xwmx/nb#-plugins\n\nPlugin Extensions:\n .nb-theme Plugins defining color themes.\n .nb-plugin Plugins defining new subcommands and functionality.\n\nSee Also:\n nb help subcommands\n\nAlias:\n nb plugin\n```\n\n#### `remote`\n\n[↑](#-help) · See also:\n[Git Sync](#-git-sync),\n[History](#-revision-history),\n[`history`](#history),\n[`notebooks`](#notebooks),\n[`status`](#status),\n[`sync`](#sync)\n\n```text\nUsage:\n nb remote\n nb remote branches [<url>]\n nb remote delete <branch-name>\n nb remote remove\n nb remote rename [<branch-name>] <name>\n nb remote reset <branch-name>\n nb remote set <url> [<branch-name>]\n\nSubcommands:\n (default) Print the remote URL and branch for the notebook.\n branches List branches on the current or given remote.\n delete Delete <branch-name> from the remote.\n Caveat: only orphan branches can be deleted.\n remove Remove the remote URL from the notebook.\n Alias: `unset`\n rename Rename the current orphan branch or <branch-name> to <name>.\n Caveat: only orphan branches can be renamed.\n reset Reset <branch-name> on the remote to a blank initial state.\n set Set the remote URL and branch for the notebook.\n\nDescription:\n Configure the remote repository URL and branch for the current notebook.\n\nRead More:\n https://github.com/xwmx/nb#-git-sync\n https://github.com/xwmx/nb#-revision-history\n\nSee Also:\n nb help history\n nb help notebooks\n nb help status\n nb help sync\n\nExamples:\n nb remote set https://github.com/example/example.git\n nb remote remove\n nb example-notebook:remote set https://github.com/example/example.git\n```\n\n#### `run`\n\n[↑](#-help) · See also: [`git`](#git), [`shell`](#shell)\n\n```text\nUsage:\n nb run <command> [<arguments>...]\n\nDescription:\n Run shell commands within the current notebook directory.\n\nSee Also:\n nb help git\n nb help shell\n\nExamples:\n nb run ls -la\n nb run find . -name 'example*'\n nb run rg example\n```\n\n#### `search`\n\n[↑](#-help) · See also:\n[Search](#-search),\n[`browse`](#browse),\n[`list`](#list),\n[`ls`](#ls)\n\n```text\nUsage:\n nb search ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n <query>... [-a | --all] [--and <query>] [--not <query>] [--or <query>]\n [-l | --list] [--path] [-t <tag1>,<tag2>... | --tag <tag1>,<tag2>...]\n [-t | --tags] [--type <type> | --<type>] [--utility <name>]\n\nOptions:\n -a, --all Search all unarchived notebooks.\n --and <query> Add a AND query.\n -l, --list Print the id, filename, and title listing for\n each matching file, without the excerpt.\n --not <query> Add a NOT query.\n --or <query> Add an OR query.\n --path Print the full path for each matching file.\n -t, --tag <tag1>,<tag2>... A comma-separated list of tags.\n -t, --tags List all tags found in the notebook.\n --type <type>, --<type> Search items of <type>. <type> can be a file\n extension or one of the following types:\n archive, audio, book, bookmark, document,\n folder, image, note, text, video\n --utility <name> The name of the search utility to search with.\n\nDescription:\n Perform a full text search.\n\n Multiple query arguments are treated as AND queries, returning items that\n match all queries. AND queries can also be specified with the --and <query>\n option. The --or <query> option can be used to specify an OR query,\n returning items that match at least one of the queries. --not <query>\n excludes items matching <query>.\n\n `nb search` is powered by Git's built-in `git grep` tool. `nb` also\n supports performing searches with alternative search tools using the\n --utility <name> option.\n\n Supported alternative search tools:\n 1. `rga` https://github.com/phiresky/ripgrep-all\n 2. `rg` https://github.com/BurntSushi/ripgrep\n 3. `ag` https://github.com/ggreer/the_silver_searcher\n 4. `ack` https://beyondgrep.com/\n 5. `grep` https://en.wikipedia.org/wiki/Grep\n\nRead More:\n https://github.com/xwmx/nb#-search\n\nSee Also:\n nb help browse\n nb help list\n nb help ls\n\nExamples:\n # search current notebook for \"example query\"\n nb search \"example query\"\n\n # search the notebook \"example\" for \"example query\"\n nb search example: \"example query\"\n\n # search all notebooks for \"example query\" and list matching items\n nb search \"example query\" --all --list\n\n # search for items matching \"Example\" AND \"Demo\"\n nb search \"Example\" \"Demo\"\n nb search \"Example\" --and \"Demo\"\n\n # search for items matching \"Example\" OR \"Sample\"\n nb search \"Example|Sample\"\n nb search \"Example\" --or \"Sample\"\n\n # search for items matching both \"Example\" AND \"Sample\", and NOT \"Demo\"\n nb search \"Example\" --and \"Sample\" --not \"Demo\"\n\n # search with a regular expression\n nb search \"\\d\\d\\d-\\d\\d\\d\\d\"\n\n # search for tags\n nb search --tag tag1 -t tag2\n\n # search the current notebook for \"example query\"\n nb q \"example query\"\n\n # search all notebooks for \"example query\" and list matching items\n nb q -la \"example query\"\n\nShortcut Alias:\n nb q\n```\n\n#### `settings`\n\n[↑](#-help) · See also:\n[`set` & `settings`](#%EF%B8%8F-set--settings),\n[Variables](#-variables),\n[`unset`](#unset)\n\n```text\nUsage:\n nb set [<name> [<value>] | <number> [<value>]]\n nb settings colors [<number> | themes]\n nb settings edit\n nb settings get (<name> | <number>)\n nb settings list [--long]\n nb settings set (<name> | <number>) <value>\n nb settings show (<name> | <number>)\n nb settings unset (<name> | <number>)\n\nSubcommands:\n (default) Open the settings prompt, to <name> or <number>, if present.\n When <value> is also present, assign <value> to the setting.\n colors Print a table of available colors and their xterm color numbers.\n When <number> is provided, print the number in its color.\n `settings colors themes` prints a list of installed themes.\n edit Open the `nb` configuration file in `$EDITOR`.\n get Print the value of a setting.\n list List information about available settings.\n set Assign <value> to a setting.\n show Print the help information and current value of a setting.\n unset Unset a setting, returning it to the default value.\n\nDescription:\n Configure `nb`. Use `nb settings set` to customize a setting and\n `nb settings unset` to restore the default for a setting.\n\n Use the `nb set` alias to quickly assign values to settings:\n\n nb set color_theme blacklight\n nb set limit 40\n\nRead More:\n https://github.com/xwmx/nb#%EF%B8%8F-set--settings\n\nSee Also:\n nb help unset\n\nExamples:\n nb settings\n nb set 5 \"org\"\n nb set color_primary 105\n nb set unset color_primary\n nb set color_secondary unset\n nb settings colors\n nb settings colors 105\n nb set limit 15\n\nAlias:\n nb set\n```\n\n##### `auto_sync`\n\n[↑](#-help) · See also: [Git Sync](#-git-sync)\n\n```text\n[1] auto_sync\n ---------\n By default, operations that trigger a git commit like `add`, `edit`,\n and `delete` will sync notebook changes to the remote repository, if\n the notebook's remote is set. To disable this behavior, set this to \"0\".\n\n • Default Value: 1\n```\n\n##### `color_primary`\n\n[↑](#-help) · See also: [Color Themes](#-color-themes), [Custom Color Themes](#custom-color-themes)\n\n```text\n[2] color_primary\n -------------\n The primary color used to highlight identifiers and messages.\n\n • Supported Values: xterm color numbers 0 through 255.\n • Default Value: 68 (blue) for 256 color terminals,\n 4 (blue) for 8 color terminals.\n```\n\n##### `color_secondary`\n\n[↑](#-help) · See also: [Color Themes](#-color-themes), [Custom Color Themes](#custom-color-themes)\n\n```text\n[3] color_secondary\n ---------------\n The color used for lines and footer elements.\n\n • Supported Values: xterm color numbers 0 through 255.\n • Default Value: 8\n```\n\n##### `color_theme`\n\n[↑](#-help) · See also: [Color Themes](#-color-themes)\n\n```text\n[4] color_theme\n -----------\n The color theme.\n\n To view screenshots of the built-in themes, visit:\n\n https://git.io/nb-docs-color-themes\n\n `nb` supports custom, user-defined themes. To learn more, run:\n\n nb help --colors\n\n To change the syntax highlighting theme, use:\n\n nb set syntax_theme\n\n • Available themes:\n\n blacklight\n console\n desert\n electro\n forest\n nb\n ocean\n raspberry\n smoke\n unicorn\n utility\n\n • Default Value: nb\n```\n\n##### `default_extension`\n\n[↑](#-help) · See also: [Adding](#adding)\n\n```text\n[5] default_extension\n -----------------\n The default extension to use for note files. Change to \"org\" for\n Org files, \"rst\" for reStructuredText, \"txt\" for plain text, or\n whatever you prefer.\n\n • Default Value: md\n```\n\n##### `editor`\n\n[↑](#-help) · See also: [Editing](#editing), [Adding](#adding)\n\n```text\n[6] editor\n ------\n The command line text editor used by `nb`.\n\n • Example Values:\n\n atom\n code\n emacs\n hx\n macdown\n mate\n micro\n nano\n pico\n subl\n vi\n vim\n```\n\n##### `encryption_tool`\n\n[↑](#-help) · See also: [Password-Protected Encrypted Notes and Bookmarks](#password-protected-encrypted-notes-and-bookmarks)\n\n```text\n[7] encryption_tool\n ---------------\n The tool used for encrypting notes.\n\n • Supported Values: openssl, gpg\n • Default Value: openssl\n```\n\n##### `footer`\n\n[↑](#-help) · See also: [Listing & Filtering](#listing--filtering)\n\n```text\n[8] footer\n ------\n By default, `nb` and `nb ls` include a footer with example commands.\n To hide this footer, set this to \"0\".\n\n • Default Value: 1\n```\n\n##### `header`\n\n[↑](#-help) · See also: [Listing & Filtering](#listing--filtering)\n\n```text\n[9] header\n ------\n By default, `nb` and `nb ls` include a header listing available notebooks.\n Set the alignment, or hide the header with \"0\".\n\n • Supported Values:\n\n 0 Hide Header\n 1 Dynamic Alignment\n - Left justified when list is shorter than terminal width.\n - Center aligned when list is longer than terminal width.\n 2 Center Aligned (default)\n 3 Left Justified\n\n • Default Value: 1\n```\n\n##### `limit`\n\n[↑](#-help) · See also: [Listing & Filtering](#listing--filtering)\n\n```text\n[10] limit\n -----\n The maximum number of items included in the `nb` and `nb ls` lists.\n Set to `auto` to automatically limit output to the current terminal height.\n Set a maximum auto limit with `auto^<max>`, e.g., `auto^15`.\n Subtract an auto limit offset for multiline prompts with `auto-<offset>`.\n Add an auto limit offet with `auto+<offset>`.\n Combine both modifiers with `auto-<offset>^<max>` or `auto+<offset>^<max>`.\n\n • Example Values:\n\n 15\n auto\n auto^15\n auto-2\n auto+2\n auto-2^15\n auto+2^15\n\n • Default Value: 15\n```\n\n##### `nb_dir`\n\n[↑ ](#-help)\n\n```text\n[11] nb_dir\n ------\n The location of the directory that contains the notebooks.\n\n For example, to sync all notebooks with Dropbox, create a folder at\n `~/Dropbox/Notes` and run: `nb settings set nb_dir ~/Dropbox/Notes`\n\n • Default Value: ~/.nb\n```\n\n##### `syntax_theme`\n\n[↑](#-help) · See also: [Terminal Syntax Highlighting](#terminal-syntax-highlighting-theme)\n\n```text\n[12] syntax_theme\n ------------\n The syntax highlighting theme. View examples with:\n\n bat --list-themes\n\n • Available themes:\n\n 1337\n DarkNeon\n Dracula\n GitHub\n Monokai Extended\n Monokai Extended Bright\n Monokai Extended Light\n Monokai Extended Origin\n Nord\n OneHalfDark\n OneHalfLight\n Solarized (dark)\n Solarized (light)\n Sublime Snazzy\n TwoDark\n ansi-dark\n ansi-light\n base16\n base16-256\n gruvbox\n gruvbox-light\n gruvbox-white\n zenburn\n\n • Default Value: base16\n```\n\n#### `shell`\n\n[↑](#-help) · See also:\n[Interactive Shell](#-interactive-shell),\n[`run`](#run)\n\n```text\nUsage:\n nb shell [<subcommand> [<options>...] | --clear-history]\n\nOptions:\n --clear-history Clear the `nb` shell history.\n\nDescription:\n Start the `nb` interactive shell. Type \"exit\" to exit.\n\n `nb shell` recognizes all `nb` subcommands and options, providing\n a streamlined, distraction-free approach for working with `nb`.\n\n When <subcommand> is present, the command will run as the shell is opened.\n\nRead More:\n https://github.com/xwmx/nb#-interactive-shell\n\nSee Also:\n nb help run\n\nExample:\n $ nb shell\n nb> ls 3\n [3] Example\n\n nb> edit 3 --content \"New content.\"\n Updated: [3] Example\n\n nb> notebook\n home\n\n nb> exit\n $\n```\n\n#### `show`\n\n[↑](#-help) · See also:\n[Viewing](#viewing),\n[Images](#-images),\n[`browse`](#browse),\n[`open`](#open),\n[`peek`](#peek)\n\n```text\nUsage:\n nb show ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [[-a | --added] | [--authors] | [-b | --browse] | --filename | --id |\n --info-line | --path | [-p | --print] | --relative-path | [-r |\n --render] | --title | --type [<type>] | [-u | --updated]] [--no-color]\n nb show <notebook>\n\nOptions:\n -a, --added Print the date and time when the item was added.\n --authors List the git commit authors of an item.\n -b, --browse Open the item with `nb browse`.\n --filename Print the filename of the item.\n --id Print the id number of the item.\n --info-line Print the id, filename, and title of the item.\n --no-color Show without syntax highlighting.\n --path Print the full path of the item.\n -p, --print Print to standard output / terminal.\n --relative-path Print the item's path relative within the notebook.\n -r, --render Use `pandoc` [1] to render the file to HTML and display\n in the terminal web browser. If either `pandoc` or a\n browser are unavailable, `-r` / `--render` is ignored.\n --title Print the title of the note.\n --type [<type>] Print the file extension or, when <type> is specified,\n return true if the item matches <type>. <type> can be a\n file extension or one of the following types:\n archive, audio, bookmark, document, folder, image,\n text, video\n -u, --updated Print the date and time of the last recorded change.\n\nDescription:\n Show an item or notebook. Notes in text file formats can be rendered or\n printed to standard output. Non-text files are opened in your system's\n preferred app or program for that file type.\n\n By default, the item is opened using `less` or the program configured\n in the `$PAGER` environment variable. Use the following keys to navigate\n in `less` (see `man less` for more information):\n\n Key Function\n --- --------\n mouse scroll Scroll up or down\n arrow up or down Scroll one line up or down\n f Jump forward one window\n b Jump back one window\n d Jump down one half window\n u Jump up one half window\n /<query> Search for <query>\n n Jump to next <query> match\n q Quit\n\n To skip the pager and print to standard output, use the `-p` / `--print`\n option.\n\n `-r` / `--render` automatically uses either `w3m` [2] or `links` [3].\n To specify a preferred browser, set the `$BROWSER` environment variable\n in your .bashrc, .zshrc, or equivalent, e.g.: export BROWSER=\"links\"\n\n If `bat` [4], `highlight` [5], or Pygments [6] is installed, notes are\n printed with syntax highlighting.\n\n 1. https://pandoc.org/\n 2. https://en.wikipedia.org/wiki/W3m\n 3. https://en.wikipedia.org/wiki/Links_(web_browser)\n 4. https://github.com/sharkdp/bat\n 5. http://www.andre-simon.de/doku/highlight/en/highlight.php\n 6. https://pygments.org/\n\nRead More:\n https://github.com/xwmx/nb#viewing\n\nSee Also:\n nb help browse\n nb help open\n nb help peek\n\nExamples:\n nb show 1\n nb show example.md --render\n nb show \"A Document Title\" --print --no-color\n nb 1 show\n nb example:show 12\n nb show example:12\n nb example:12 show\n nb s 1\n nb 1 s\n nb s example:12\n nb example:12 s\n\nAlias:\n nb view\n\nShortcut Alias:\n nb s\n```\n\n#### `status`\n\n[↑](#-help) · See also:\n[Git Sync](#-git-sync),\n[History](#-revision-history),\n[`archive`](#archive),\n[`history`](#history),\n[`notebooks`](#notebooks),\n[`remote`](#remote),\n[`sync`](#sync),\n[`unarchive`](#unarchive)\n\n```text\nUsage:\n nb status [<notebook>]\n\nDescription:\n Print archival, git, and remote status for the current notebook or <notebook>.\n\nRead More:\n https://github.com/xwmx/nb#-git-sync\n https://github.com/xwmx/nb#-revision-history\n\nSee Also:\n nb help archive\n nb help history\n nb help notebooks\n nb help remote\n nb help sync\n nb help unarchive\n\nExamples:\n nb status\n nb status example\n\nShortcut Alias:\n nb st\n```\n\n#### `subcommands`\n\n[↑](#-help) · See also:\n[Plugins](#-plugins),\n[`plugins`](#plugins)\n\n```text\nUsage:\n nb subcommands [add <name>...] [alias <name> <alias>]\n [describe <name> <usage>]\n\nSubcommands:\n add Add a new subcommand.\n alias Create an <alias> of a given subcommand <name>, with linked help.\n Note that aliases must also be added with `subcommands add`.\n describe Set the usage text displayed with `nb help <subcommand>`.\n This can be assigned as a heredoc, which is recommended, or\n as a string argument.\n\nDescription:\n List, add, alias, and describe subcommands. New subcommands, aliases, and\n descriptions are not persisted, so `add`, `alias`, `describe` are\n primarily for plugins.\n\nRead More:\n https://github.com/xwmx/nb#-plugins\n\nSee Also:\n nb help plugins\n```\n\n#### `sync`\n\n[↑](#-help) · See also:\n[Git Sync](#-git-sync),\n[History](#-revision-history),\n[`history`](#history),\n[`notebooks`](#notebooks),\n[`remote`](#remote),\n[`status`](#status)\n\n```text\nUsage:\n nb sync [-a | --all]\n\nOptions:\n -a, --all Sync all unarchived notebooks.\n\nDescription:\n Sync the current notebook with its remote.\n\nPrivate Repositories and Git Credentials:\n Syncing with private repositories requires configuring git to not prompt\n for credentials.\n\n For repositories cloned over HTTPS, credentials can be cached with git.\n For repositories cloned over SSH, keys can be added to the ssh-agent.\n\n More Information:\n https://github.com/xwmx/nb#private-repositories-and-git-credentials\n\nSync Conflict Resolution:\n When `nb sync` encounters a conflict in a text file and can't merge\n overlapping local and remote changes, both versions are saved in the\n file, separated by git conflict markers. Use `nb edit` to remove the\n conflict markers and delete any unwanted text.\n\n When `nb sync` encounters a conflict in a binary file, such as an\n encrypted note or bookmark, both versions of the file are saved in the\n notebook as individual files, one with `--conflicted-copy` appended to\n the filename.\n\n More Information:\n https://github.com/xwmx/nb#sync-conflict-resolution\n\nRead More:\n https://github.com/xwmx/nb#-git-sync\n https://github.com/xwmx/nb#-revision-history\n\nSee Also:\n nb help history\n nb help notebooks\n nb help remote\n nb help status\n\nExamples:\n nb sync\n nb sync --all\n```\n\n#### `tasks`\n\n[↑](#-help) · See also:\n[Tasks](#%EF%B8%8F-tasks),\n[Todos](#-todos),\n[`do`](#do),\n[`todo`](#todo),\n[`undo`](#undo)\n\n```text\nUsage:\n nb tasks ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [open | closed] [--pager]\n\nOptions:\n --pager Display output in the pager.\n\nDescription:\n List tasks in todos, notebooks, folders, and other items.\n\nRead More:\n https://github.com/xwmx/nb#%EF%B8%8F-tasks\n https://github.com/xwmx/nb#-todos\n\nSee Also:\n nb help do\n nb help todo\n nb help undo\n\nExamples:\n nb tasks\n nb tasks open\n nb tasks closed\n nb tasks 123\n nb example:tasks open\n nb tasks closed sample/\n nb tasks closed demo:456\n\nShortcut Alias:\n nb t\n```\n\n#### `todo`\n\n[↑](#-help) · See also:\n[Todos](#-todos),\n[`do`](#do),\n[`tasks`](#tasks),\n[`undo`](#undo)\n\n```text\nUsage:\n nb todo add [<notebook>:][<folder-path>/][<filename>] <title>\n [--description <description>] [--due <date>]\n [-r (<url> | <selector>) | --related (<url> | <selector>)]\n [--tags <tag1>,<tag2>...] [--task <title>...]\n nb todo delete ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb todo do ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [<task-number>]\n nb todo undo ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [<task-number>]\n nb todos [<notebook>:][<folder-path>/] [open | closed] [--pager]\n [--tags <tag1>,<tag2>...]\n nb todos tasks ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [open | closed] [--pager]\n\nOptions:\n --description <description> Description for the todo.\n --due <date> Due date and / or time for the todo.\n --pager Display output in the pager.\n -r, --related (<url> | <selector>) Related URL or selector.\n --tags <tag1>,<tag2>... Comma-separated list of tags.\n --task <title> Task to add to the tasklist.\n\nSubcommands:\n (default) List todos.\n add Add a new todo.\n Shortcut Aliases: `nb todo a`, `nb todo +`\n delete Delete a todo.\n Shortcut Aliases: `nb todo -`\n do Mark a todo or task as done.\n tasks List tasks in todos, notebooks, folders, and other item.\n undo Unmark a todo or task as done.\n\nDescription:\n Manage todos and tasks.\n\nRead More::\n https://github.com/xwmx/nb#-todos\n\nSee Also:\n nb help do\n nb help tasks\n nb help undo\n\nExamples:\n nb todo add \"Example todo title.\"\n nb todo add Example todo title.\n nb todo add \"Sample title.\" --tags tag1,tag2 --related demo:567\n nb todos\n nb todos open\n nb todos closed\n nb example:todos open\n nb todos closed sample/\n\nAlias:\n nb todos\n\nShortcut Alias:\n nb to\n```\n\n#### `unarchive`\n\n[↑](#-help) · See also:\n[Archiving Notebooks](#archiving-notebooks),\n[`archive`](#archive),\n[`notebooks`](#notebooks),\n[`status`](#status)\n\n```text\nUsage:\n nb unarchive [<name>]\n\nDescription:\n Remove \"archived\" status from the current notebook or notebook <name>.\n\n This is an alias for `nb notebooks unarchive`.\n\nRead More:\n https://github.com/xwmx/nb#archiving-notebooks\n\nSee Also:\n nb help archive\n nb help notebooks\n nb help status\n\nExamples:\n nb unarchive\n nb unarchive example\n\nShortcut Alias:\n nb unar\n```\n\n#### `undo`\n\n[↑](#-help) · See also:\n[Todos](#-todos),\n[Tasks](#%EF%B8%8F-tasks),\n[`do`](#do),\n[`tasks`](#tasks),\n[`todo`](#todo)\n\n```text\nUsage:\n nb undo ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [<task-number>]\n\nDescription:\n Mark a todo or task as not done.\n\nRead More:\n https://github.com/xwmx/nb#-todos\n\nSee Also:\n nb help do\n nb help tasks\n nb help todo\n\nExamples:\n nb undo 123\n nb undo example:sample/321\n nb undo 543 7\n```\n\n#### `unpin`\n\n[↑](#-help) · See also:\n[Pinning](#-pinning),\n[`browse`](#browse),\n[`list`](#list),\n[`ls`](#ls),\n[`pin`](#pin)\n\n```text\nUsage:\n nb unpin ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n\nDescription:\n Unpin a pinned item.\n\nRead More:\n https://github.com/xwmx/nb#-pinning\n\nSee Also:\n nb help browse\n nb help list\n nb help ls\n nb help pin\n\nExamples:\n nb unpin 123\n nb unpin example:sample/321\n```\n\n#### `unset`\n\n[↑](#-help) · See also:\n[`set` & `settings`](#%EF%B8%8F-set--settings),\n[`settings`](#settings)\n\n```text\nUsage:\n nb unset (<name> | <number>)\n\nDescription:\n Unset a setting, returning it to the default value.\n\n This is an alias for `nb settings unset`.\n\nRead More:\n https://github.com/xwmx/nb#%EF%B8%8F-set--settings\n\nSee Also:\n nb help settings\n\nExamples:\n nb unset color_primary\n nb unset 2\n\nAlias:\n nb reset\n```\n\n#### `update`\n\n[↑](#-help) · See also:\n[Installation](#installation),\n[`env`](#env),\n[`version`](#version)\n\n```text\nUsage:\n nb update\n\nDescription:\n Update `nb` to the latest version. You will be prompted for\n your password if administrator privileges are required.\n\n If `nb` was installed using a package manager like npm or\n Homebrew, use the package manager's upgrade functionality instead\n of this command.\n\nRead More:\n https://github.com/xwmx/nb#installation\n\nSee Also:\n nb help env\n nb help version\n```\n\n#### `use`\n\n[↑](#-help) · See also:\n[Notebooks](#-notebooks),\n[`notebooks`](#notebooks)\n\n```text\nUsage:\n nb use <notebook>\n\nDescription:\n Switch to the specified notebook. Shortcut for `nb notebooks use`.\n\nRead More:\n https://github.com/xwmx/nb#-notebooks\n\nSee Also:\n nb help notebooks\n\nExample:\n nb use example\n\nShortcut Alias:\n nb u\n```\n\n#### `version`\n\n[↑](#-help) · See also:\n[Installation](#installation),\n[`env`](#env),\n[`update`](#update)\n\n```text\nUsage:\n nb version\n\nDescription:\n Display version information.\n\nSee Also:\n nb help env\n nb help update\n```\n\n### Plugin Help\n\n<p>\n <sup>\n <a href=\"#-help\">↑</a> ·\n <a href=\"#-plugins\">Plugins</a>,\n <a href=\"#plugins\"><code>nb plugins</code></a>\n </sup>\n</p>\n\n<div align=\"center\">\n <a href=\"#backlink\">backlink</a> ·\n <a href=\"#bump\">bump</a> ·\n <a href=\"#clip\">clip</a> ·\n <a href=\"#daily\">daily</a> ·\n <a href=\"#ebook\">ebook</a> ·\n <a href=\"#example\">example</a> ·\n <a href=\"#weather\">weather</a>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n<div align=\"center\">\n <a href=\"#-help\"> ↑ </a>\n</div>\n\n#### `backlink`\n\n[↑ ](#plugin-help)\n\n##### Install\n\n```bash\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/backlink.nb-plugin\n```\n\n##### Help\n\n```text\nUsage:\n nb backlink [--force]\n\nDescription:\n Add backlinks to notes. Crawl notes in a notebook for [[wiki-style links]]\n and append a \"Backlinks\" section to each linked file that lists passages\n referencing the note.\n\n To link to a note from within another note, surround the title of the\n target note in double square brackets:\n\n Example with link to [[Target Note Title]] in content.\n\n Depends on note-link-janitor:\n https://github.com/andymatuschak/note-link-janitor\n\n Requirement: every note in the notebook must have a title.\n```\n\n#### `bump`\n\n[↑ ](#plugin-help)\n\n##### Install\n\n```bash\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/bump.nb-plugin\n```\n\n##### Help\n\n```text\nUsage:\n nb bump [<notebook>:][<folder-path>/][<id>][<filename>][<title>]\n\nDescription:\n Bump an item to the top of the list.\n\n `bump` updates the item's modification timestamp without editing the item\n or creating a new commit.\n\nExamples:\n nb bump 123\n nb bump example:sample/456\n\nAlias:\n nb touch\n```\n\n#### `clip`\n\n[↑ ](#plugin-help)\n\n##### Install\n\n```bash\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/clip.nb-plugin\n```\n\n##### Help\n\n```text\nUsage:\n nb clip [<notebook>:][<id> | <filename> | <path> | <title> | <extension>]\n\nDescription:\n Save the clipboard contents and copy contents of text or markdown items to\n the clipboard.\n\n When called with no arguments or when no matching file is found, the text\n content on the clipboard is saved to a new file, pending a prompt.\n\nExamples:\n # copy the content of item 123 to the clipboard\n nb clip 123\n\n # save the clipboard contents to a new file with a `.js` file extension\n nb clip .js\n\n # save the clipboard contents as a new `.cr` file in the \"snippets\" notebook\n nb snippets:clip .cr\n```\n\n#### `daily`\n\n[↑ ](#plugin-help)\n\n##### Install\n\n```bash\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/daily.nb-plugin\n```\n\n##### Help\n\n```text\nUsage:\n nb daily [<content>] [--prev [<number>]]\n\nOptions:\n --prev [<number>] List previous days and show day by previous <number>.\n\nDescription:\n Add notes to a daily log. When called without arguments, the current day's\n log is displayed. When passed `<content>`, a new timestamped entry is added\n to the current day's log, which is created if it doesn't yet exist.\n\n Previous day's logs can be listed with the `--prev` option. View a previous\n day's log by passing its `<number>` in the list.\n\nExamples:\n nb daily \"Example note content.\"\n nb daily\n nb daily --prev\n nb daily --prev 3\n```\n\n#### `ebook`\n\n[↑ ](#plugin-help)\n\n##### Install\n\n```bash\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/ebook.nb-plugin\n```\n\n##### Help\n\n```text\nUsage:\n nb ebook new <name>\n nb ebook publish\n\nSubcommands:\n ebook new Create a new notebook initialized with placeholder files for\n authoring an ebook.\n ebook publish Generate a .epub file using the current notebook contents.\n\nDescription:\n Ebook authoring with `nb`.\n\n `nb ebook new` creates a notebook populated with initial placeholder files\n for creating an ebook. Edit the title page and chapters using normal `nb`\n commands, then use `nb ebook publish` to generate an epub file.\n\n Chapters are expected to be markdown files with sequential numeric\n filename prefixes for ordering:\n\n 01-example.md\n 02-sample.md\n 03-demo.md\n\n Create new chapters with `nb add`:\n\n nb add --filename \"04-chapter4.md\"\n\n title.txt contains the book metadata in a YAML block. For more information\n about the fields for this file, visit:\n\n https://pandoc.org/MANUAL.html#epub-metadata\n\n stylesheet.css contains base styling for the generated ebook. It can be used\n as it is and can also be edited using `nb edit`.\n\n As with all `nb` notebooks, changes are recorded automatically in git,\n providing automatic version control for all ebook content, source, and\n metadata files.\n\n Generated epub files are saved in the notebook and can be previewed in the\n terminal with `nb show`. Export a generated epub file with `nb export`:\n\n nb export 12 .\n\nMore info:\n https://pandoc.org/epub.html\n```\n\n#### `example`\n\n[↑ ](#plugin-help)\n\n##### Install\n\n```bash\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/example.nb-plugin\n```\n\n##### Help\n\n```text\nUsage:\n nb example\n\nDescription:\n Print \"Hello, World!\"\n```\n\n#### `weather`\n\n[↑ ](#plugin-help)\n\n##### Install\n\n```bash\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/weather.nb-plugin\n```\n\n##### Help\n\n```text\nUsage:\n nb weather [<option>...]\n\nDescription:\n Display weather information from wttr.in.\n\nMore Info:\n https://github.com/chubin/wttr.in\n https://wttr.in\n\nExamples:\n nb weather\n nb weather Tokyo\n nb weather lax\n\nShortcut Alias:\n nb w\n```\n\n### `$` Variables\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#%EF%B8%8F-set--settings\"><code>set</code>&<code>settings</code></a>,\n <a href=\"#settings\"><code>nb settings</code></a>\n </sup>\n</p>\n\n<div align=\"center\">\n <sup>\n <a href=\"#editor-1\"><code>$EDITOR</code></a> ·\n <a href=\"#nb_ace_enabled\"><code>$NB_ACE_ENABLED</code></a> ·\n <a href=\"#nb_ace_md_gutter\"><code>$NB_ACE_MD_GUTTER</code></a> ·\n <a href=\"#nb_ace_relative_line_numbers\"><code>$NB_ACE_RELATIVE_LINE_NUMBERS</code></a> ·\n <a href=\"#nb_ace_soft_tabs\"><code>$NB_ACE_SOFT_TABS</code></a> ·\n <a href=\"#nb_ace_keyboard\"><code>$NB_ACE_KEYBOARD</code></a> ·\n <a href=\"#nb_audio_tool\"><code>$NB_AUDIO_TOOL</code></a> ·\n <a href=\"#nb_auto_sync\"><code>$NB_AUTO_SYNC</code></a> ·\n <a href=\"#nb_auto_sync_seconds\"><code>$NB_AUTO_SYNC_SECONDS</code></a> ·\n <a href=\"#nb_bookmark_content_cleanup_tool\"><code>$NB_BOOKMARK_CONTENT_CLEANUP_TOOL</code></a> ·\n <a href=\"#nb_bookmark_content_conversion_tool\"><code>$NB_BOOKMARK_CONTENT_CONVERSION_TOOL</code></a> ·\n <a href=\"#nb_browse_markdown_reader\"><code>$NB_BROWSE_MARKDOWN_READER</code></a> ·\n <a href=\"#nb_browse_server_tool\"><code>$NB_BROWSE_SERVER_TOOL</code></a> ·\n <a href=\"#nb_browse_support_links\"><code>$NB_BROWSE_SUPPORT_LINKS</code></a> ·\n <a href=\"#nb_browser\"><code>$NB_BROWSER</code></a> ·\n <a href=\"#nb_color_primary\"><code>$NB_COLOR_PRIMARY</code></a> ·\n <a href=\"#nb_color_secondary\"><code>$NB_COLOR_SECONDARY</code></a> ·\n <a href=\"#nb_color_theme\"><code>$NB_COLOR_THEME</code></a> ·\n <a href=\"#nb_custom_css\"><code>$NB_CUSTOM_CSS</code></a> ·\n <a href=\"#nb_custom_css_url\"><code>$NB_CUSTOM_CSS_URL</code></a> ·\n <a href=\"#nb_custom_javascript\"><code>$NB_CUSTOM_JAVASCRIPT</code></a> ·\n <a href=\"#nb_custom_javascript_url\"><code>$NB_CUSTOM_JAVASCRIPT_URL</code></a> ·\n <a href=\"#nb_data_tool\"><code>$NB_DATA_TOOL</code></a> ·\n <a href=\"#nb_default_extension\"><code>$NB_DEFAULT_EXTENSION</code></a> ·\n <a href=\"#nb_default_template\"><code>$NB_DEFAULT_TEMPLATE</code></a> ·\n <a href=\"#nb_dir-1\"><code>$NB_DIR</code></a> ·\n <a href=\"#nb_directory_tool\"><code>$NB_DIRECTORY_TOOL</code></a> ·\n <a href=\"#nb_editor\"><code>$NB_EDITOR</code></a> ·\n <a href=\"#nb_encryption_tool\"><code>$NB_ENCRYPTION_TOOL</code></a> ·\n <a href=\"#nb_folders_first\"><code>$NB_FOLDERS_FIRST</code></a> ·\n <a href=\"#nb_footer\"><code>$NB_FOOTER</code></a> ·\n <a href=\"#nb_gui_browser\"><code>$NB_GUI_BROWSER</code></a> ·\n <a href=\"#nb_header\"><code>$NB_HEADER</code></a> ·\n <a href=\"#nb_image_tool\"><code>$NB_IMAGE_TOOL</code></a> ·\n <a href=\"#nb_indicator_audio\"><code>$NB_INDICATOR_AUDIO</code></a> ·\n <a href=\"#nb_indicator_bookmark\"><code>$NB_INDICATOR_BOOKMARK</code></a> ·\n <a href=\"#nb_indicator_document\"><code>$NB_INDICATOR_DOCUMENT</code></a> ·\n <a href=\"#nb_indicator_ebook\"><code>$NB_INDICATOR_EBOOK</code></a> ·\n <a href=\"#nb_indicator_encrypted\"><code>$NB_INDICATOR_ENCRYPTED</code></a> ·\n <a href=\"#nb_indicator_folder\"><code>$NB_INDICATOR_FOLDER</code></a> ·\n <a href=\"#nb_indicator_image\"><code>$NB_INDICATOR_IMAGE</code></a> ·\n <a href=\"#nb_indicator_pinned\"><code>$NB_INDICATOR_PINNED</code></a> ·\n <a href=\"#nb_indicator_todo\"><code>$NB_INDICATOR_TODO</code></a> ·\n <a href=\"#nb_indicator_todo_done\"><code>$NB_INDICATOR_TODO_DONE</code></a> ·\n <a href=\"#nb_indicator_video\"><code>$NB_INDICATOR_VIDEO</code></a> ·\n <a href=\"#nb_limit\"><code>$NB_LIMIT</code></a> ·\n <a href=\"#nb_mathjax_enabled\"><code>$NB_MATHJAX_ENABLED</code></a> ·\n <a href=\"#nb_markdown_tool\"><code>$NB_MARKDOWN_TOOL</code></a> ·\n <a href=\"#nb_pinned_pattern\"><code>$NB_PINNED_PATTERN</code></a> ·\n <a href=\"#nb_server_host\"><code>$NB_SERVER_HOST</code></a> ·\n <a href=\"#nb_server_port\"><code>$NB_SERVER_PORT</code></a> ·\n <a href=\"#nb_syntax_theme\"><code>$NB_SYNTAX_THEME</code></a> ·\n <a href=\"#nb_user_agent\"><code>$NB_USER_AGENT</code></a> ·\n <a href=\"#nbrc_path\"><code>$NBRC_PATH</code></a>\n </sup>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n<div align=\"center\">\n <a href=\"#overview\"> ↑ </a>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n[Settings](#%EF%B8%8F-set--settings) are set in the `~/.nbrc` configuration\nfile using environment variables. Settings can be set through `nb`\nusing [`set` & `settings`](#%EF%B8%8F-set--settings) or by\nassigning a value to the variable directly in the `~/.nbrc` file, which\ncan be opened in your `$EDITOR` with [`nb settings edit`](#settings).\n\nExample assignment:\n\n```bash\nexport NB_INDICATOR_PINNED=\"🔮\"\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$EDITOR`\n\n```text\nThe terminal editor command for editing items.\n\nSee also: `$NB_EDITOR`\n\nExample Values: 'code', 'emacs', 'hx', 'vim'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_ACE_ENABLED`\n\n```text\nDefault: '0'\n\nExample Values: '0', '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_ACE_MD_GUTTER`\n\n```text\nDefault: '1'\n\nExample Values: '0', '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_ACE_RELATIVE_LINE_NUMBERS`\n\n```text\nDefault: '0'\n\nExample Values: '0', '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_ACE_SOFT_TABS`\n\n```text\nDefault: '0'\n\nExample Values: '0', '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_ACE_KEYBOARD`\n\n```text\nDefault: 'ace'\n\nExample Values: 'emacs', 'sublime', 'vim', 'vscode'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_AUDIO_TOOL`\n\n```text\nDefault: '' (first available)\n\nExample Values: 'mplayer', 'afplay'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_AUTO_SYNC`\n\n```text\nDefault: '1'\n\nWhen set to '1', each `_git checkpoint()` call will automativally run\n`$_ME sync`. To disable this behavior, set the value to '0'.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_AUTO_SYNC_SECONDS`\n\n```text\nDefault: '60'\n\nThe minimum number of seconds between automatic Git sync operations when\n`$NB_AUTO_SYNC` is enabled.\n\nSupported Values: '0' or any positive integer\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_BOOKMARK_CONTENT_CLEANUP_TOOL`\n\n```text\nDefault: 'readability'\n\nThe tool used to clean up HTML content before conversion to markdown\nwhen creating bookmarks.\n\nSupported Tools:\n\n- https://www.npmjs.com/package/readability-cli\n- https://github.com/eafer/rdrview\n\nSupported Values: '', 'rdrview', 'readability'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_BOOKMARK_CONTENT_CONVERSION_TOOL`\n\n```text\nDefault: 'pandoc'\n\nThe tool used to convert HTML content to markdown when creating\nbookmarks.\n\nSupported Tools:\n\n- https://github.com/JohannesKaufmann/html-to-markdown\n- https://github.com/microsoft/markitdown\n- https://pandoc.org\n\nSupported Values: '', 'html-to-markdown', 'markitdown', 'pandoc'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_BROWSE_MARKDOWN_READER`\n\n```text\n$NB_BROWSE_MARKDOWN_READER\n\nDefault: 'markdown+emoji+raw_html+east_asian_line_breaks'\n\nThe Pandoc reader, including extensions, to use for converting Markdown to\nHTML in `nb browse`.\n\nMore information:\n https://pandoc.org/MANUAL.html#extensions\n https://pandoc.org/MANUAL.html#general-options-1\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_BROWSE_SERVER_TOOL`\n\n```text\nDefault: first available: 'ncat', 'socat', 'netcat', 'bash' (5.2+ only), ''\n\nThe tool used to listen on the server host and port and respond to\nincoming requests.\n\nSupported Values: 'accept', 'bash', 'nc', 'ncat', netcat', 'socat'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_BROWSE_SUPPORT_LINKS`\n\n```text\nDefault: '1'\n\nSet to '0' to hide the 'Donate' and 'Sponsor' links in `nb browse`.\n\nSupported Values: '0' '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_BROWSER`\n\n```text\nDefault: value of $BROWSER\n\nExample Values: 'links', 'w3m'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_COLOR_PRIMARY`\n\n```text\nDefault: Value depends on terminal capabilities.\n\nSet highlighting color. This should be set to an xterm color number, usually\na value between 1 and 256. For a table of common colors and their numbers\nrun:\n\n nb settings colors\n\nSupported Values: [0..255+]\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_COLOR_SECONDARY`\n\n```text\nDefault: '8'\n\nColor for lines and other accents. This should be set to an xterm color\nnumber, usually a value between 1 and 256. For a table of common colors and\ntheir numbers, run:\n\n nb settings colors\n\nSupported Values: [0..255+]\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_COLOR_THEME`\n\n```text\nDefault: 'nb'\n\nThe color theme.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_CUSTOM_CSS`\n\n```text\nDefault: ''\n\nA style sheet to be included inline in a `<style>` element on pages\nrendered by `nb browse`.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_CUSTOM_CSS_URL`\n\n```text\nDefault: ''\n\nA URL to a style sheet to be included in a `<link rel=\"stylesheet\">`\nelement on pages rendered by `nb browse`.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_CUSTOM_JAVASCRIPT`\n\n```text\nDefault: ''\n\nA block of JavaScript code to be included inline in a `<script>` element\non pages rendered by `nb browse`.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_CUSTOM_JAVASCRIPT_URL`\n\n```text\nDefault: ''\n\nA URL to a JavaScript file to be included in a `<script src=//url>`\nelement on pages rendered by `nb browse`.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_DATA_TOOL`\n\n```text\nDefault: '' (first available)\n\nExample Values: 'visidata', 'sc-im'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_DEFAULT_EXTENSION`\n\n```text\nDefault: 'md'\n\nExample Values: 'md' 'org'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_DEFAULT_TEMPLATE`\n\n```text\nDefault: ''\n\nA string template or a path to a template file.\n\nExample Values: '/path/to/template/file' '# {{title}} {{content}}'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_DIR`\n\n```text\nDefault: `$HOME/.nb`\n\nThe location of the directory that contains the notebooks.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_DIRECTORY_TOOL`\n\n```text\nDefault: '' (nb browse)\n\nExample Values: 'ranger', 'mc'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_EDITOR`\n\n```text\nDefault: the value of `$EDITOR`\n\nThe terminal editor command for editing items. Overrides the value of\n`$EDITOR` in the environment.\n\nSee also: `$EDITOR`\n\nExample Values: 'code', 'emacs', 'hx', 'vim'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_ENCRYPTION_TOOL`\n\n```text\nDefault: 'openssl'\n\nSupported Values: 'gpg' 'openssl'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_FOLDERS_FIRST`\n\n```text\nDefault: '0'\n\nWhen set to '1', folders are printed before other items in `nb`, `nb ls`,\nand `nb browse`.\n\nSupported Values: '0' '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_FOOTER`\n\n```text\nDefault: '1'\n\nSupported Values: '0' '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_GUI_BROWSER`\n\n```text\nDefault: ''\n\nExample Value: 'firefox'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_HEADER`\n\n```text\nDefault: '2'\n\nSupported Values: '0' '1' '2' '3'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_IMAGE_TOOL`\n\n```text\nDefault: '' (first available)\n\nExample Values: 'imgcat', 'catimg'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_AUDIO`\n\n```text\nDefault: 🔉\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_BOOKMARK`\n\n```text\nDefault: 🔖\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_DOCUMENT`\n\n```text\nDefault: 📄\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_EBOOK`\n\n```text\nDefault: 📖\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_ENCRYPTED`\n\n```text\nDefault: 🔒\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_FOLDER`\n\n```text\nDefault: 📂\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_IMAGE`\n\n```text\nDefault: 🌄\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_PINNED`\n\n```text\nDefault: 📌\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_TODO`\n\n```text\nDefault: ✔️\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_TODO_DONE`\n\n```text\nDefault: ✅\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_VIDEO`\n\n```text\nDefault: 📹\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_LIMIT`\n\n```text\nDefault: '15'\n\nSet to a positive number to limit the output of `nb` and `nb ls` to that value.\nSet to \"auto\" to automatically limit output to the current terminal height.\nSet a maximum auto limit with `auto^<max>`, e.g., `auto^15`.\nSubtract an auto limit offset for multiline prompts with `auto-<offset>`.\nAdd an auto limit offet with `auto+<offset>`.\nCombine both modifiers with `auto-<offset>^<max>` or `auto+<offset>^<max>`.\n\nSupported Values:\n - <max>\n - auto\n - auto^<max>\n - auto-<offset>\n - auto+<offset>\n - auto-<offset>^<max>\n - auto+<offset>^<max>\n\nExample Values:\n - 15\n - auto\n - auto^15\n - auto-2\n - auto+2\n - auto-2^15\n - auto+2^15\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_MATHJAX_ENABLED`\n\n```text\nDefault: '0'\n\nExample Values: '0', '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_MARKDOWN_TOOL`\n\n```text\nDefault: '' (default pager)\n\nSupported Values: 'bat', 'glow', 'lowdown', 'mdcat', 'mdless', 'mdv'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_PINNED_PATTERN`\n\n```text\nExample Value: '#pinned'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_SERVER_HOST`\n\n```text\nDefault: 'localhost'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_SERVER_PORT`\n\n```text\nDefault: '6789'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_SYNTAX_THEME`\n\n```text\nDefault: 'base16'\n\nSupported Values: Theme names listed with `bat --list-themes`\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_USER_AGENT`\n\n```text\nDefault: '' (`curl` or `wget` default user agent)\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NBRC_PATH`\n\n```text\nDefault: `$HOME/.nbrc`\n\nThe location of the .nbrc configuration file.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n## Specifications\n\n<div align=\"center\">\n <a href=\"#nb-markdown-bookmark-file-format\">Bookmark File Format</a> ·\n <a href=\"#nb-markdown-todo-file-format\">Todo File Format</a> ·\n <a href=\"#nb-notebook-specification\">Notebook Specification</a>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n<div align=\"center\">\n <a href=\"#-help\"> ↑ </a>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n### `nb` Markdown Bookmark File Format\n\n<p>\n <sup>\n <a href=\"#specifications\">↑</a> ·\n <a href=\"#-bookmarks\">Bookmarks</a>,\n <a href=\"#bookmark\"><code>nb bookmark</code></a>\n </sup>\n</p>\n\n#### Extension\n\n`.bookmark.md`\n\n#### Description\n\n`nb` bookmarks are Markdown documents created using a combination of\nuser input and data from the bookmarked page. The `nb` bookmark format\nis intended to be readable, editable, convertible, renderable, and\nclearly organized for greatest accessibility.\n\nBookmarks are identified by a `.bookmark.md` file extension. The\nbookmark URL is the first URL in the file within `<` and `>` characters.\nTo create a minimally valid bookmark file with [`nb add`](#add):\n\n```bash\nnb add example.bookmark.md --content \"<https://example.com>\"\n```\n\nThis creates a file with the name `example.bookmark.md` containing:\n\n```markdown\n<https://example.com>\n```\n\nIn a full bookmark, information is separated into sections,\nwith each bookmark section indicated by a Markdown `h2` heading.\n\n#### Example\n\n````markdown\n# Example Title (example.com)\n\n<https://example.com>\n\n## Description\n\nExample description.\n\n## Quote\n\n> Example quote line one.\n>\n> Example quote line two.\n\n## Comment\n\nExample comment.\n\n## Related\n\n- <https://example.net>\n- <https://example.org>\n- [[example:123]]\n\n## Tags\n\n#tag1 #tag2\n\n## Content\n\nExample Title\n=============\n\nThis domain is for use in illustrative examples in documents. You may\nuse this domain in literature without prior coordination or asking for\npermission.\n\n[More information\\...](https://www.iana.org/domains/example)\n\n## Source\n\n```html\n<!doctype html>\n<html>\n <head>\n <title>Example Title\n \n \n\n \n

Example Title

\n

\n This domain is for use in illustrative examples in documents. You may\n use this domain in literature without prior coordination or asking for\n permission.\n

\n

\n More information...\n

\n \n\n```\n````\n\n#### Elements\n\n##### Title\n\n`Optional`\n\nA [Markdown atx-style `h1` heading\n](https://daringfireball.net/projects/markdown/syntax#header)\ncontaining the content of the bookmarked page's\nHTML `` or [`og:title`](https://ogp.me/) tag, if present, followed by\nthe domain within parentheses.\n\n###### Examples\n\n```markdown\n# Example Title (example.com)\n```\n```markdown\n# (example.com)\n```\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### URL\n\n`Required`\n\nThe URL of the bookmarked resource, with surrounding angle brackets\n(`<`, `>`).\n\nThis is the only required element.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Description`\n\n`Optional`\n\nA text element containing the content of the bookmarked page's meta description\nor [`og:description`](https://ogp.me/) tag, if present.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Quote`\n\n`Optional`\n\nA markdown quote block containing a user-specified excerpt from the bookmarked\nresource.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Comment`\n\n`Optional`\n\nA text element containing a comment written by the user.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Related`\n\n`Optional`\n\nA Markdown list of\nangle bracketed (`<`, `>`) URLs and\n[[[wiki-style links]]](#-linking)\nthat are related to the bookmarked resource.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Tags`\n\n`Optional`\n\nA list of [#tags](#-tagging)\nrepresented as `#hashtags`\nseparated by individual spaces.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Content`\n\n`Optional`\n\nThe full content of the bookmarked page, converted to Markdown.\n\nThe `## Content` section makes the page content available locally for\nfull-text search and viewing of page content. The source HTML is converted\nto inline Markdown to reduce the amount of markup, make it more readable,\nand make page content easily viewable in the terminal as markdown and\nstreamlined HTML in web browsers.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Source`\n\n`Optional`\n\nA fenced code block with `html` language identifier containing the source HTML\nfrom the bookmarked page.\n\n`nb` does not save the page source by default. `nb` uses this section to save\nthe source HTML page content when `pandoc` is not available to convert it to\nMarkdown.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n### `nb` Markdown Todo File Format\n\n<p>\n <sup>\n <a href=\"#specifications\">↑</a> ·\n <a href=\"#-todos\">Todos</a>,\n <a href=\"#todo\"><code>nb todo</code></a>\n </sup>\n</p>\n\n#### Extension\n\n`.todo.md`\n\n#### Description\n\n`nb` todos are Markdown documents identified by a `.todo.md` file extension.\nTodos contain a Markdown `h1` heading\nstarting with a Markdown checkbox (`[ ]` / `[x]`) indicating\nthe todo completion state, followed by the todo title.\n\n#### Example\n\n```markdown\n# [x] Example todo title.\n\n## Due\n\n2100-01-01\n\n## Description\n\nExample description.\n\n## Tasks\n\n- [ ] One\n- [x] Two\n- [ ] Three\n\n## Related\n\n- [[example:123]]\n- <https://example.org>\n\n## Tags\n\n#tag1 #tag2\n```\n\n#### Elements\n\n##### Title\n\n`Required`\n\nA [Markdown atx-style `h1` heading\n](https://daringfireball.net/projects/markdown/syntax#header)\ncontaining a Markdown checkbox followed by the todo title.\nAn `x` within the checkbox (`[ ]`) indicates that the todo is done.\n\n###### Examples\n\n```markdown\n# [ ] Example undone / open todo title.\n```\n```markdown\n# [x] Example done / closed todo title.\n```\n\n<p>\n <sup>\n <a href=\"#nb-markdown-todo-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Due`\n\n`Optional`\n\nA text element containing a value referencing\na due date and / or time for the todo.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-todo-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Description`\n\n`Optional`\n\nA text element containing a description for the todo.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-todo-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Tasks`\n\n`Optional`\n\nA markdown tasklist containing sub-tasks for the todo.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-todo-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Related`\n\n`Optional`\n\nA Markdown list of\nangle bracketed (`<`, `>`) URLs and\n[[[wiki-style links]]](#-linking)\nthat are related to the todo.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-todo-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Tags`\n\n`Optional`\n\nA list of [#tags](#-tagging)\nrepresented as `#hashtags`\nseparated by individual spaces.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-todo-file-format\">↑</a>\n </sup>\n</p>\n\n### `nb` Notebook Specification\n\n<p>\n <sup>\n <a href=\"#specifications\">↑</a> ·\n <a href=\"#-notebooks\">Notebooks</a>,\n <a href=\"#notebooks\"><code>nb notebooks</code></a>\n </sup>\n</p>\n\nAn `nb` notebook is a directory that contains a valid `.git` directory,\nindicating that it has been initialized as a git repository, and a `.index`\nfile in the root directory.\n\n#### `.index` Files\n\nA notebook folder index is a text file named `.index` in any folder\nwithin the notebook directory. `.index` contains a list of visible\nfilenames within the folder, one per line, and the line number of each\nfilename represents the id. `.index` files are included in the git repository\nso ids are preserved across systems.\n\n##### Operations\n\n<dl>\n <dt><code>add</code></dt>\n <dd>Append a new line containing the filename to <code>.index</code>.</dd>\n <dt><code>update</code></dt>\n <dd>Overwrite the existing filename in <code>.index</code> with the new filename.</dd>\n <dt><code>delete</code></dt>\n <dd>Delete the filename, preserving the newline, leaving the line blank.</dd>\n <dt><code>reconcile</code></dt>\n <dd>Remove duplicate lines, preserving existing blank lines, <code>add</code> entries for new files, and <code>delete</code> entries for deleted files.</dd>\n <dt><code>rebuild</code></dt>\n <dd>Delete and rebuild <code>.index</code>, listing files by most recently modified, reversed.</dd>\n</dl>\n\n##### `index` Subcommand\n\n`nb` manages the `.index` of each folder within a notebook using an internal\n`index` subcommand.\n\n###### `nb help index`\n\n```text\nUsage:\n nb index add <filename>\n nb index delete <filename>\n nb index edit\n nb index get_basename <id>\n nb index get_id <filename>\n nb index get_max_id\n nb index rebuild [--ancestors]\n nb index reconcile [--ancestors] [--commit]\n nb index show\n nb index update <existing-filename> <new-filename>\n nb index verify\n nb index <subcommand> <options>... [<folder-path>]\n\nOptions:\n --ancestors Perform the action on all folders within the notebook that\n are ancestors of the current folder.\n --commit Commit changes to git.\n\nSubcommands:\n add Add <filename> to the index.\n delete Delete <filename> from the index.\n edit Open the index file in `$EDITOR`.\n get_basename Print the filename / basename at the specified <id>.\n get_id Get the id for <filename>.\n get_max_id Get the maximum id for the folder.\n rebuild Rebuild the index, listing files by last modified, reversed.\n Some ids will change. Prefer `nb index reconcile`.\n reconcile Remove duplicates and update index for added and deleted files.\n show Print the index.\n update Overwrite the <existing-filename> entry with <new-filename>.\n verify Verify that the index matches the folder contents.\n\nDescription:\n Manage the index for the current folder or the folder at <folder-path>,\n which can be passed as the final argument to any `index` subcommand.\n\n `index` is used internally by `nb` and using it manually will\n probably corrupt the index. If something goes wrong with an index,\n fix it with `nb index reconcile`.\n\n An index is a text file named '.index' in any folder within a notebook.\n .index contains a list of filenames and the line number of each filename\n represents the id. .index files are included in the git repository so\n ids are preserved across systems.\n```\n\n<p>\n <sup>\n <a href=\"#nb-notebook-specification\">↑</a>\n </sup>\n</p>\n\n#### `.pindex` Files\n\nAny folder may contain an optional plain text file named `.pindex`\ncontaining a list of basenames from that folder, one per line, that should\nbe treated as [pinned](#-pinning), meaning they appear first in some\nlist operations, including `nb` and [`nb ls`](#ls). Entries are added to a\n`.pindex` file with [`nb pin`](#pin) and removed with [`nb unpin`](#unpin).\n\n<p>\n <sup>\n <a href=\"#nb-notebook-specification\">↑</a>\n </sup>\n</p>\n\n#### Archived Notebooks\n\nA notebook is considered [archived](#archiving-notebooks)\nwhen it contains a file named `.archived`\nat the root level of the notebook directory.\n\n<p>\n <sup>\n <a href=\"#nb-notebook-specification\">↑</a>\n </sup>\n</p>\n\n## Tests\n\nWith more than 2,200 tests spanning tens of thousands of lines,\n`nb` is really mostly a\n[test suite](https://github.com/xwmx/nb/tree/master/test).\nTests run continuously [via GitHub Actions](https://github.com/xwmx/nb/actions)\non recent versions of both Ubuntu and macOS to account for differences between\nBSD and GNU tools and Bash versions.\nTo run the tests locally, install\n[Bats](https://github.com/bats-core/bats-core)\nand the [recommended dependencies](#optional),\nthen run `bats test` within the project root directory. Run groups of\ntests with globbing, e.g., `bats test/browse*` and `bats test/folders*`.\n\n<div align=\"center\">\n <span>\n <a href=\"#overview\"> ↑ </a>\n </span>\n\n <br/>\n</div>\n\n---\n\n<div align=\"center\">\n <span>\n Copyright (c) 2015-present ·\n <a href=\"https://www.williammelody.com/\">William Melody</a> ·\n <a href=\"https://github.com/xwmx/nb/blob/master/LICENSE\">AGPLv3</a>\n </span>\n\n <br/>\n <br/>\n</div>\n\n<div align=\"center\">\n <span>\n <a href=\"https://xwmx.github.io/nb\">xwmx.github.io/nb</a> ·\n <a href=\"https://github.com/xwmx/nb\">github.com/xwmx/nb</a>\n </span>\n\n <br/>\n <br/>\n</div>\n\n<div align=\"center\">\n <span>\n 📝🔖🔒🔍📔\n </span>\n\n <br/>\n <br/>\n</div>\n\n<div align=\"center\">\n <span>\n <a href=\"#top\"> ↑ </a>\n </span>\n</div>\n" }, { "path": "bin/bookmark", "content": "#!/usr/bin/env bash\n###############################################################################\n# __ __ __\n# / /_ ____ ____ / /______ ___ ____ ______/ /__\n# / __ \\/ __ \\/ __ \\/ //_/ __ `__ \\/ __ `/ ___/ //_/\n# / /_/ / /_/ / /_/ / ,< / / / / / / /_/ / / / ,<\n# /_.___/\\____/\\____/_/|_/_/ /_/ /_/\\__,_/_/ /_/|_|\n#\n# bookmark -- Command line bookmarking with tagging, encryption,\n# full-text page content search with regular expression support,\n# GUI and terminal browser support, and data stored in plain text\n# Markdown files with Git-backed versioning and syncing.\n#\n# Part of:\n# __ _\n# \\ \\ _ __ | |__\n# \\ \\ | '_ \\| '_ \\\n# / / | | | | |_) |\n# /_/ |_| |_|_.__/\n#\n# [nb] Command line and local web note-taking, bookmarking, and archiving with\n# plain text data storage, encryption, filtering and search, pinning, #tagging,\n# Git-backed versioning and syncing, Pandoc-backed conversion, global and local\n# notebooks, customizable color themes, [[wiki-style linking]], plugins, and\n# more in a single portable, user-friendly script.\n#\n# https://github.com/xwmx/nb\n#\n# Based on Bash Boilerplate: https://github.com/xwmx/bash-boilerplate\n#\n# Copyright (c) 2015-present William Melody • hi@williammelody.com\n# AGPLv3 • See LICENSE for details.\n###############################################################################\n\nexport _NB_PATH=\"${_NB_PATH:-}\"\n\nif [[ -z \"${_NB_PATH:-}\" ]]\nthen\n _NB_PATH=\"$(command -v nb)\"\nfi\n\nif [[ -z \"${_NB_PATH:-}\" ]]\nthen\n cat <<HEREDOC\n\\`bookmark\\` is part of \\`nb\\`. To install \\`nb\\`, see:\n https://github.com/xwmx/nb\nHEREDOC\nfi\n\n_main() {\n if [[ -z \"${1:-}\" ]]\n then\n local _count=0\n while IFS= read -r __line\n do\n _count=$((_count+1))\n\n if [[ \"${_count}\" == 1 ]] ||\n [[ \"${_count}\" == 6 ]] ||\n [[ \"${_count}\" == 8 ]]\n then\n printf \"%s\\\\n\" \"${__line}\" \\\n | sed -e 's/nb help bookmark/bookmark help/' \\\n | sed -e 's/nb/bookmark/'\n elif [[ \"${_count}\" == 2 ]]\n then\n printf \"%s\\\\n\" \"${__line}\" \\\n | sed -e 's/-------------------------/----------------------------/'\n else\n printf \"%s\\\\n\" \"${__line}\"\n fi\n done < <(\"${_NB_PATH:-}\" bookmark)\n elif [[ \"${1:-}\" =~ ^-h$|^--help$|^h$|^help$ ]] || {\n [[ \"${1:-}\" =~ ^q$|^search$ ]] &&\n [[ -z \"${2:-}\" ]]\n\n }\n then\n {\n cat <<HEREDOC\n __ __ __\n / /_ ____ ____ / /______ ___ ____ ______/ /__\n / __ \\\\/ __ \\\\/ __ \\\\/ //_/ __ \\`__ \\\\/ __ \\`/ ___/ //_/\n / /_/ / /_/ / /_/ / ,< / / / / / / /_/ / / / ,<\n/_.___/\\\\____/\\\\____/_/|_/_/ /_/ /_/\\\\__,_/_/ /_/|_|\n\nbookmark -- Command line bookmarking with tagging, encryption,\nfull-text page content search with regular expression support,\nGUI and terminal browser support, and data stored in plain text\nMarkdown files with Git-backed versioning and syncing.\n\nHEREDOC\n \"${_NB_PATH:-}\" help bookmark \\\n | sed -e \"/ nb example/d\" \\\n | sed -e \"s/ nb https/ bookmark https/g\" \\\n | sed -e \"s/ nb bookmark/ bookmark/g\" \\\n | sed -e \"/ nb b$/d\" \\\n | sed -e \"/ nb bk$/d\" \\\n | sed -e \"/ nb bm$/d\" \\\n | sed -e \"s/Shortcut Alias: \\`b\\`//\" \\\n | sed -e \"s/Shortcut Alias: \\`bk\\`//\" \\\n | sed -e \"s/Shortcut Aliases.*//\" \\\n | sed -e '$ d'\n\n cat <<HEREDOC\n------------------------------------------\nPart of \\`nb\\` (https://github.com/xwmx/nb).\nFor more information, see: \\`nb help\\`.\nHEREDOC\n } | if [[ -n \"${PAGER:-}\" ]] && [[ ! \"${PAGER:-}\" =~ less ]]\n then\n \"${PAGER}\"\n elif hash \"less\" 2>/dev/null\n then\n less -R \\\n --CLEAR-SCREEN \\\n --prompt=\"> scroll for more, h for help, or q to quit\"\n else\n cat\n fi\n else\n \"${_NB_PATH}\" bookmark \"${@:-}\"\n fi\n} && _main \"${@:-}\"\n" }, { "path": "bin/notes", "content": "#!/usr/bin/env bash\n###############################################################################\n# __ _\n# \\ \\ _ __ ___ | |_ ___ ___\n# \\ \\ | '_ \\ / _ \\| __/ _ \\/ __|\n# / / | | | | (_) | || __/\\__ \\\n# /_/ |_| |_|\\___/ \\__\\___||___/\n#\n# `notes`\n#\n# Part of:\n# __ _\n# \\ \\ _ __ | |__\n# \\ \\ | '_ \\| '_ \\\n# / / | | | | |_) |\n# /_/ |_| |_|_.__/\n#\n# [nb] Command line and local web note-taking, bookmarking, and archiving with\n# plain text data storage, encryption, filtering and search, pinning, #tagging,\n# Git-backed versioning and syncing, Pandoc-backed conversion, global and local\n# notebooks, customizable color themes, [[wiki-style linking]], plugins, and\n# more in a single portable, user-friendly script.\n#\n# https://github.com/xwmx/nb\n#\n# Based on Bash Boilerplate: https://github.com/xwmx/bash-boilerplate\n#\n# Copyright (c) 2015-present William Melody • hi@williammelody.com\n# AGPLv3 • See LICENSE for details.\n###############################################################################\n\nexport _NB_PATH=\"${_NB_PATH:-}\"\n\nif [[ -z \"${_NB_PATH:-}\" ]]\nthen\n _NB_PATH=\"$(command -v nb)\"\nfi\n\nif [[ -z \"${_NB_PATH:-}\" ]]\nthen\n cat <<HEREDOC\n\\`notes\\` is part of \\`nb\\`. To install \\`nb\\`, see:\n https://github.com/xwmx/nb\nHEREDOC\nfi\n\n_main() {\n if [[ \"${1:-}\" =~ ^-h$|^--help$|^h$|^help$ ]] ||\n {\n [[ \"${1:-}\" =~ ^q$|^search$ ]] && [[ -z \"${2:-}\" ]]\n }\n then\n {\n\n shift\n\n {\n if [[ -n \"${*:-}\" ]]\n then\n \"${_NB_PATH:-}\" help \"${@}\"\n else\n cat <<HEREDOC\n __ _\n \\ \\ _ __ ___ | |_ ___ ___\n \\ \\ | '_ \\ / _ \\| __/ _ \\/ __|\n / / | | | | (_) | || __/\\__ \\\\\n /_/ |_| |_|\\___/ \\__\\___||___/\n\n Part of [nb]\nHEREDOC\n \"${_NB_PATH:-}\" help | sed -e '1,6d'\n\n fi\n } | sed -e \"s/^ nb$/ notes/g\" \\\n | sed -e \"s/ nb / notes /g\" \\\n | sed -e \"s/\\`nb/\\`notes/g\" \\\n | sed -e \"s/^\\`notes\\`/\\`nb\\`/g\" \\\n | sed -E \"s/nb(.*Command)/notes\\1/g\" \\\n | sed -e '$ d'\n\n cat <<HEREDOC\n------------------------------------------\nPart of \\`nb\\` (https://github.com/xwmx/nb).\nFor more information, see: \\`nb help\\`.\nHEREDOC\n } | if [[ -n \"${PAGER:-}\" ]] && [[ ! \"${PAGER:-}\" =~ less ]]\n then\n \"${PAGER}\"\n elif hash \"less\" 2>/dev/null\n then\n less \\\n --CLEAR-SCREEN \\\n --prompt=\"> scroll for more, h for help, or q to quit\"\n else\n cat\n fi\n else\n \"${_NB_PATH}\" \"${@:-}\"\n fi\n} && _main \"${@:-}\"\n" }, { "path": "docs/.gitignore", "content": "_site\n.sass-cache\n.jekyll-cache\n.jekyll-metadata\nvendor\n" }, { "path": "docs/.rubocop.yml", "content": "inherit_from: .rubocop_todo.yml\n" }, { "path": "docs/.rubocop_todo.yml", "content": "# This configuration was generated by\n# `rubocop --auto-gen-config`\n# on 2020-09-25 20:07:34 UTC using RuboCop version 0.92.0.\n# The point is for the user to remove these configuration records\n# one by one as the offenses are removed from the code base.\n# Note that changes in the inspected code, or installation of new\n# versions of RuboCop, may require this file to be generated again.\n\n# Offense count: 1\n# Cop supports --auto-correct.\n# Configuration parameters: EnforcedStyle.\n# SupportedStyles: final_newline, final_blank_line\nLayout/TrailingEmptyLines:\n Exclude:\n - 'Gemfile'\n\n# Offense count: 1\n# Cop supports --auto-correct.\n# Configuration parameters: EnforcedStyle.\n# SupportedStyles: always, always_true, never\nStyle/FrozenStringLiteralComment:\n Exclude:\n - 'Gemfile'\n\n# Offense count: 1\n# Cop supports --auto-correct.\n# Configuration parameters: UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.\n# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys\nStyle/HashSyntax:\n EnforcedStyle: hash_rockets\n\n# Offense count: 12\n# Cop supports --auto-correct.\n# Configuration parameters: ConsistentQuotesInMultiline.\n# SupportedStyles: single_quotes, double_quotes\nStyle/StringLiterals:\n EnforcedStyle: double_quotes\n\n# Offense count: 1\n# Cop supports --auto-correct.\n# Configuration parameters: MinSize.\n# SupportedStyles: percent, brackets\nStyle/SymbolArray:\n EnforcedStyle: brackets\n" }, { "path": "docs/.ruby-version", "content": "3.4.8\n" }, { "path": "docs/.tool-versions", "content": "ruby 3.4.8\n" }, { "path": "docs/404.html", "content": "---\npermalink: /404.html\nlayout: default\n---\n\n<style type=\"text/css\" media=\"screen\">\n .container {\n margin: 10px auto;\n max-width: 600px;\n text-align: center;\n }\n h1 {\n margin: 30px 0;\n font-size: 4em;\n line-height: 1;\n letter-spacing: -1px;\n }\n</style>\n\n<div class=\"container\">\n <h1>404</h1>\n\n <p><strong>Page not found :(</strong></p>\n <p>The requested page could not be found.</p>\n</div>\n" }, { "path": "docs/Gemfile", "content": "source \"https://rubygems.org\"\nruby \"3.4.8\"\n# Hello! This is where you manage which Jekyll version is used to run.\n# When you want to use a different version, change it below, save the\n# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:\n#\n# bundle exec jekyll serve\n#\n# This will help ensure the proper Jekyll version is running.\n# Happy Jekylling!\n# gem \"jekyll\", \"~> 4.1.1\"\n# This is the default theme for new Jekyll sites. You may change this to anything you like.\ngem \"minima\", \">= 2.5\"\n# If you want to use GitHub Pages, remove the \"gem \"jekyll\"\" above and\n# uncomment the line below. To upgrade, run `bundle update github-pages`.\ngem \"github-pages\", group: :jekyll_plugins\n# If you have any plugins, put them here!\n# group :jekyll_plugins do\n# gem \"jekyll-feed\", \"~> 0.12\"\n# end\n\n# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem\n# and associated library.\nplatforms :mingw, :x64_mingw, :mswin, :jruby do\n gem \"tzinfo\", \">= 1.2\"\n gem \"tzinfo-data\"\nend\n\n# Performance-booster for watching directories on Windows\ngem \"wdm\", \">= 0.1.1\", :platforms => [:mingw, :x64_mingw, :mswin]\n\n# Just the Docs\n#\n# A Jekyll theme.\n#\n# https://pmarsceill.github.io/just-the-docs/\ngem \"just-the-docs\"\n" }, { "path": "docs/_config.yml", "content": "# Welcome to Jekyll!\n#\n# This config file is meant for settings that affect your whole blog, values\n# which you are expected to set up once and rarely edit after that. If you find\n# yourself editing this file very often, consider using Jekyll's data files\n# feature for the data you need to update frequently.\n#\n# For technical reasons, this file is *NOT* reloaded automatically when you use\n# 'bundle exec jekyll serve'. If you change this file, please restart the server process.\n#\n# If you need help with YAML syntax, here are some quick references for you:\n# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml\n# https://learnxinyminutes.com/docs/yaml/\n#\n# Site settings\n# These are used to personalize your new site. If you look in the HTML files,\n# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.\n# You can create any custom variable you would like, and they will be accessible\n# in the templates via {{ site.myvariable }}.\n\n###############################################################################\n# Just the Docs\n#\n# https://github.com/pmarsceill/just-the-docs\n# https://pmarsceill.github.io/just-the-docs/docs/configuration/\n\nremote_theme: pmarsceill/just-the-docs\n\n# Aux links for the upper right navigation\naux_links:\n \"<code><code></code>\":\n - \"//github.com/xwmx/nb\"\n\ncolor_scheme: \"light\"\n\nga_tracking: \"UA-190590-18\"\n\nlogo: \"/assets/images/nb.png\"\n\nsearch_enabled: true\n\nsearch:\n heading_level: 3\n preview_words_after: 5\n preview_words_before: 5\n\ntoc_list: true\n\ntitle: nb\nemail: hi@williammelody.com\ndescription: >- # this means to ignore newlines until \"baseurl:\"\n A CLI and local web plain text\n note-taking, bookmarking, archiving,\n and knowledge base application.\n# the subpath of your site, e.g. /blog\nbaseurl: \"/nb\"\n# the base hostname & protocol for your site, e.g. http://example.com\nurl: \"https://xwmx.github.io\"\n\n# twitter_username: jekyllrb\n# github_username: jekyll\n\n# Build settings\n# theme: minima\n# plugins:\n# - jekyll-feed\n# - jekyll-seo-tag\n\n# Exclude from processing.\n# The following items will not be processed, by default.\n# Any item listed under the `exclude:` key here will be automatically added to\n# the internal \"default list\".\n#\n# Excluded items can be processed by explicitly listing the directories or\n# their entries' file path in the `include:` list.\n#\n# exclude:\n# - .sass-cache/\n# - .jekyll-cache/\n# - gemfiles/\n# - Gemfile\n# - Gemfile.lock\n# - node_modules/\n# - vendor/bundle/\n# - vendor/cache/\n# - vendor/gems/\n# - vendor/ruby/\n\nexclude:\n - color-themes.md\n" }, { "path": "docs/_includes/favicon.html", "content": "<!-- <link rel=\"shortcut icon\" href=\"{{ 'favicon.ico' | relative_url }}\" type=\"image/x-icon\"> -->\n\n<link rel=\"icon\" type=\"image/x-icon\" href=\"data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAQAACQWAAAkFgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAon8IB59/AlSegwFunYgCVJ+RBhGdlAFcnZkAbp2eAkqcpwMxm6sBaJuxAzCbtwJim7wChZrAAlCaxgUHmsQEAKN+CQafgQJqnYUB2p6JA2WfkQYPnpYDdp2aAdmengNXnKgEMZutAsCbsgHNm7cCiZu9AnGZwwG8mMcCbo6pAACehgIAnYYCIJ2HAbeeigMYnpUFAJ6cBSednQK1nqAEE5irAACbsQKTm7MBlp++DwKZxgIAmccCPZjKAbuZzQQXnogCAJ2IAiCdigG8no0EHZ6XBQCenwUnnZ8CtZ6iBBOZrgAAm7MCkZu1AmqatAAAmcsEAJnLAx2YzQG9mc8EKJ2LAgCdigIenY0B152RAlqdlwAAnqEEL52iAbaepQQQmLAAAJu2ApObuAGbncQKBJjLAQCZzQJBmM8BupnRBBafiQUOnYsBep2OAdOdlAKsnZoChZ2gAaidowKVoKwOA5a3AACbuAKQm7sC0ZrCApCYyAF8mM0Bv5jPAmeTxgAAn4oGDJ6MA1WekANJnpcEIp2cAmudoAJsnaQDGp2jAgCVuwAAm7sCkJu9A3GZxAJUmcgCe5nNAkaa0QUGmdAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKjBJwCZuwAAnLkFFZu9AqSbvwNkmr4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACowSYAl7sAAJu6A1iavQGym8EDQprAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAqcMpAJu9AACcvAUEnMAECJ3ECAKcwwcAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA//8AAP//AAD//wAA//8AAAABAAAAAQAAiIgAAIiYAACIiAAAAIEAAAGBAAD/HwAA/x8AAP8fAAD//wAA//8AAA==\">\n" }, { "path": "docs/_includes/head.html", "content": "<head>\n <meta charset=\"UTF-8\">\n <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n\n {% unless site.plugins contains \"jekyll-seo-tag\" %}\n <title>{{ page.title or site.title }}\n\n {% if page.description %}\n \n {% endif %}\n {% endunless %}\n\n {% include favicon.html %}\n\n \n\n {% if site.ga_tracking != nil %}\n \n \n\n {% endif %}\n\n {% if site.search_enabled != false %}\n \n {% endif %}\n\n {% if site.mermaid %}\n \n {% endif %}\n\n \n\n \n\n {% seo %}\n\n {% include head_custom.html %}\n\n\n" }, { "path": "docs/_includes/js/custom.js", "content": "" }, { "path": "docs/_includes/nav.html", "content": "{% comment %}{% include toc.html html=content class=\"navigation-list\" h_max=3 %}{% endcomment %}\n\n\n\n\n\n\n\n\n\n\n" }, { "path": "docs/_includes/toc.html", "content": "{% capture tocWorkspace %}\n {% comment %}\n Copyright (c) 2017 Vladimir \"allejo\" Jimenez\n\n Permission is hereby granted, free of charge, to any person\n obtaining a copy of this software and associated documentation\n files (the \"Software\"), to deal in the Software without\n restriction, including without limitation the rights to use,\n copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the\n Software is furnished to do so, subject to the following\n conditions:\n\n The above copyright notice and this permission notice shall be\n included in all copies or substantial portions of the Software.\n\n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\n OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\n NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\n HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\n WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\n OTHER DEALINGS IN THE SOFTWARE.\n {% endcomment %}\n {% comment %}\n Version 1.0.14\n https://github.com/allejo/jekyll-toc\n\n \"...like all things liquid - where there's a will, and ~36 hours to spare, there's usually a/some way\" ~jaybe\n\n Usage:\n {% include toc.html html=content sanitize=true class=\"inline_toc\" id=\"my_toc\" h_min=2 h_max=3 %}\n\n Parameters:\n * html (string) - the HTML of compiled markdown generated by kramdown in Jekyll\n\n Optional Parameters:\n * sanitize (bool) : false - when set to true, the headers will be stripped of any HTML in the TOC\n * class (string) : '' - a CSS class assigned to the TOC\n * id (string) : '' - an ID to assigned to the TOC\n * h_min (int) : 1 - the minimum TOC header level to use; any header lower than this value will be ignored\n * h_max (int) : 6 - the maximum TOC header level to use; any header greater than this value will be ignored\n * ordered (bool) : false - when set to true, an ordered list will be outputted instead of an unordered list\n * item_class (string) : '' - add custom class(es) for each list item; has support for '%level%' placeholder, which is the current heading level\n * submenu_class (string) : '' - add custom class(es) for each child group of headings; has support for '%level%' placeholder which is the current \"submenu\" heading level\n * baseurl (string) : '' - add a base url to the TOC links for when your TOC is on another page than the actual content\n * anchor_class (string) : '' - add custom class(es) for each anchor element\n * skipNoIDs (bool) : false - skip headers that do not have an `id` attribute\n\n Output:\n An ordered or unordered list representing the table of contents of a markdown block. This snippet will only\n generate the table of contents and will NOT output the markdown given to it\n {% endcomment %}\n\n {% capture my_toc %}{% endcapture %}\n {% assign orderedList = include.ordered | default: false %}\n {% assign skipNoIDs = include.skipNoIDs | default: false %}\n {% assign minHeader = include.h_min | default: 1 %}\n {% assign maxHeader = include.h_max | default: 6 %}\n {% assign nodes = include.html | split: ' maxHeader %}\n {% continue %}\n {% endif %}\n\n {% assign _workspace = node | split: '' | first }}>{% endcapture %}\n {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}\n\n {% assign indentAmount = headerLevel | minus: minHeader %}\n {% assign space = '' %}\n {% for i in (1..indentAmount) %}\n {% assign space = space | prepend: ' ' %}\n {% endfor %}\n\n {% if include.item_class and include.item_class != blank %}\n {% capture listItemClass %}{:.{{ include.item_class | replace: '%level%', headerLevel }}}{% endcapture %}\n {% endif %}\n\n {% capture anchor_body %}{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}{% endcapture %}\n {% capture anchor_body %}{{ anchor_body | replace: \"|\", \"\\|\" }}{% endcapture %}\n\n {% if html_id %}\n {% capture list_item %}[{{ anchor_body }}]({% if include.baseurl %}{{ include.baseurl }}{% endif %}#{{ html_id }}){% endcapture %}\n {% elsif skipNoIDs == true %}\n {% continue %}\n {% else %}\n {% capture list_item %}{{ anchor_body }}{% endcapture %}\n {% endif %}\n\n \n {% if include.submenu_class and previousLevel > indentAmount %}\n \n {% assign submenuIndentation = space | prepend: ' ' %}\n\n {% capture my_toc %}{{ my_toc }}\n{{ submenuIndentation }}{:.{{ include.submenu_class | replace: '%level%', previousLevel }}}{% endcapture %}\n {% endif %}\n\n {% capture my_toc %}{{ my_toc }}\n{{ space }}{{ listModifier }} {{ listItemClass }} {{ list_item }}{% if include.anchor_class %}{:.{{ include.anchor_class }}}{% endif %}{% endcapture %}\n\n {% assign previousLevel = indentAmount %}\n {% endfor %}\n\n {% if include.class and include.class != blank %}\n {% capture my_toc %}{:.{{ include.class }}}\n{{ my_toc | lstrip }}{% endcapture %}\n {% endif %}\n\n {% if include.id %}\n {% capture my_toc %}{: #{{ include.id }}}\n{{ my_toc | lstrip }}{% endcapture %}\n {% endif %}\n\n \n {% if include.submenu_class != blank %}\n \n {% for i in (1..previousLevel) %}\n {% assign lvl = previousLevel | plus: 1 | minus: i %} \n {% assign closingSpace = '' %}\n\n {% for i in (1..lvl) %}\n {% assign closingSpace = closingSpace | prepend: ' ' %}\n {% endfor %}\n\n {% capture my_toc %}{{ my_toc }}\n{{ closingSpace }}{:.{{ include.submenu_class | replace: '%level%', lvl }}}{% endcapture %}\n {% endfor %}\n {% endif %}\n{% endcapture %}{% assign tocWorkspace = '' %}{{ my_toc | markdownify | strip }}\n" }, { "path": "docs/_layouts/default.html", "content": "---\nlayout: table_wrappers\n---\n\n\n\n\n{% include head.html %}\n\n \n \n Link\n \n \n \n \n \n Search\n \n \n \n \n \n Menu\n \n \n \n \n \n Expand\n \n \n \n \n \n Document\n \n \n \n \n \n\n
\n
\n {% include title.html %}\n \n \n \n \n \n \n \n
\n \n
\n
\n
\n
\n {% if site.search_enabled != false %}\n
\n
\n \n \n
\n
\n
\n {% endif %}\n {% include header_custom.html %}\n {% if site.aux_links %}\n \n {% endif %}\n
\n
\n {% unless page.url == \"/\" %}\n {% if page.parent %}\n {%- for node in pages_list -%}\n {%- if node.parent == nil -%}\n {%- if page.parent == node.title or page.grand_parent == node.title -%}\n {%- assign first_level_url = node.url | absolute_url -%}\n {%- endif -%}\n {%- if node.has_children -%}\n {%- assign children_list = pages_list | where: \"parent\", node.title -%}\n {%- for child in children_list -%}\n {%- if page.url == child.url or page.parent == child.title -%}\n {%- assign second_level_url = child.url | absolute_url -%}\n {%- endif -%}\n {%- endfor -%}\n {%- endif -%}\n {%- endif -%}\n {%- endfor -%}\n \n {% endif %}\n {% endunless %}\n
\n {% if site.heading_anchors != false %}\n {% include vendor/anchor_headings.html html=content beforeHeading=\"true\" anchorBody=\"\" anchorClass=\"anchor-heading\" anchorAttrs=\"aria-labelledby=\\\"%html_id%\\\"\" %}\n {% else %}\n {{ content }}\n {% endif %}\n\n {% if page.has_children == true and page.has_toc != false %}\n
\n

Table of contents

\n
    \n {%- assign children_list = pages_list | where: \"parent\", page.title | where: \"grand_parent\", page.parent -%}\n {% for child in children_list %}\n
  • \n {{ child.title }}{% if child.summary %} - {{ child.summary }}{% endif %}\n
    • \n {% endfor %}\n
\n {% endif %}\n\n {% capture footer_custom %}\n {%- include footer_custom.html -%}\n {% endcapture %}\n {% if footer_custom != \"\" or site.last_edit_timestamp or site.gh_edit_link %}\n
\n
\n {% if site.back_to_top %}\n

{{ site.back_to_top_text }}

\n {% endif %}\n\n {{ footer_custom }}\n\n {% if site.last_edit_timestamp or site.gh_edit_link %}\n
\n {% if site.last_edit_timestamp and site.last_edit_time_format and page.last_modified_date %}\n

\n Page last modified: {{ page.last_modified_date | date: site.last_edit_time_format }}.\n

\n {% endif %}\n {% if\n site.gh_edit_link and\n site.gh_edit_link_text and\n site.gh_edit_repository and\n site.gh_edit_branch and\n site.gh_edit_view_mode\n %}\n

\n {{ site.gh_edit_link_text }}\n

\n {% endif %}\n
\n {% endif %}\n
\n {% endif %}\n\n
\n
\n\n \n\n {% if site.search_enabled != false %}\n {% if site.search.button %}\n \n \n \n {% endif %}\n\n
\n {% endif %}\n
\n\n\n" }, { "path": "docs/_sass/custom/custom.scss", "content": "///////////////////////////////////////////////////////////////////////////////\n// docs/_sass/custom/custom.scss\n//\n// Custom styles for Just the Docs.\n//\n// More info:\n// https://pmarsceill.github.io/just-the-docs/docs/customization/\n///////////////////////////////////////////////////////////////////////////////\n\n///////////////////////////////////////////////////////////////////////////////\n// Colors\n\n/* #1a1a1a #1b1b1b #1e1f25 #4da6dc #65bcfb #6cb2b5 #222327 #232529 */\n\n$body-background-color: #15181d;\n$body-color: #c5c7cf;\n$code-block-background-color: #1c1f25;\n$code-inline-background-color: #2a303b;\n$muted-color: #636363;\n$hr-color: lighten($body-background-color, 10%);\n$link-color: #5e8bd0;\n$side-bar-background-color: #0f1217;\n\n///////////////////////////////////////////////////////////////////////////////\n// Styles\n\n::placeholder {\n color: $muted-color;\n}\n\n::selection {\n background-color: #393f67;\n}\n\na,\na code {\n color: $link-color !important;\n}\n\na:not([class]),\na:not([class]):hover {\n background: none;\n}\n\na:not([class]) {\n text-decoration: none;\n}\n\na:not([class]):hover {\n text-decoration: underline;\n}\n\nbody,\nhtml {\n font-size: 16px !important;\n}\n\nbody {\n background-color: $body-background-color;\n color: $body-color;\n padding-bottom: 2rem;\n}\n\n// NOTE:\n// `code.highlighter-rouge`: inline code\n// `code`, `div.highlighter-rouge`: code blocks\ncode {\n border-radius: 6px;\n\n &,\n a &,\n a:visited & {\n border: 1px solid #1b2027;\n color: #cbcbd6;\n font-family: ui-monospace,\n SFMono-Regular,\n SF Mono,\n Menlo,\n Consolas,\n Liberation Mono,\n monospace;\n font-size: 0.9rem;\n line-height: 1.4;\n padding: 0.2rem 0.4rem;\n\n @media (min-width: 50rem) {\n font-size: 0.85rem;\n }\n }\n\n a & {\n white-space: nowrap;\n }\n\n a &,\n a:visited &,\n dl &,\n h1 &,\n sup &,\n ul &,\n &.highlighter-rouge {\n background-color: $code-inline-background-color;\n border: 0;\n font-size: 0.85em;\n vertical-align: middle;\n }\n\n sup & {\n font-size: 0.85em;\n }\n\n &.highlighter-rouge {\n white-space: nowrap;\n\n h1 &, h2 &, h3 &, h4 &, h5 &, h6 &,\n li & {\n white-space: normal;\n }\n }\n}\n\ncode.highlighter-rouge {\n background-color: $code-inline-background-color !important;\n border: none;\n}\n\ndiv.highlighter-rouge {\n // &,\n // code,\n // pre {\n & {\n background-color: $code-block-background-color;\n border: none;\n padding: 1rem;\n\n button {\n // TODO\n display: none;\n }\n } // &, code, pre\n} // code, div.highlighter-rouge\n\ndiv.highlighter-rouge,\ndiv.listingblock {\n div.highlight {\n border: none;\n padding: 0;\n }\n}\n\nh1, h2, h3, h4, h5, h6 {\n color: $body-color !important;\n}\n\nh1, h1 code {\n font-size: 2rem !important;\n}\n\nh2 {\n font-size: 1.35rem !important;\n}\n\nh3 {\n font-size: 1.25rem !important;\n}\n\nhr {\n background-color: $hr-color;\n}\n\ninput[type='text'] {\n background-color: $body-background-color;\n}\n\np {\n margin-bottom: 1rem;\n margin-top: 0;\n}\n\npre {\n font-size: 1.2rem;\n line-height: 1rem;\n}\n\nth,\nthead th,\ntd {\n background-color: transparent;\n border-bottom: 1px solid lighten($body-background-color, 5%);\n border-left: 1px solid lighten($body-background-color, 5%);\n font-size: 0.95rem !important;\n}\n\nth {\n padding: 0.5rem 0 0.5rem 0.45rem;\n\n @media (min-width: 50rem) {\n padding-left: 0.75rem;\n }\n}\n\n.aux-nav .aux-nav-list {\n font-size: 0.95rem !important;\n\n @media (max-width: 50rem) {\n display: block;\n text-align: center;\n }\n\n code {\n background-color: $code-block-background-color;\n }\n}\n\n.highlight,\n.highlight pre,\npre.highlight {\n background: none;\n}\n\n.highlight {\n .c {\n color: #7c7992;\n }\n\n .cp {\n color: #008b99;\n }\n\n .gh {\n color: #9ea6d0;\n }\n\n .gu {\n color: #7178d4;\n }\n\n .k {\n color: #d6d3a9;\n }\n\n .na {\n color: #af62ac;\n }\n\n .nb {\n color: #a29eab;\n }\n\n .nl {\n color: #a0e0bd;\n }\n\n .no {\n color: #b8bd65;\n }\n\n .nt {\n color: #89b1f3;\n }\n\n .nv {\n color: #6590bf;\n }\n\n .o {\n color: $body-color;\n }\n\n .s {\n color: #66afa9;\n }\n\n .s2 {\n color: #ada7e0;\n }\n\n .se {\n color: #e281d7;\n }\n\n .sx {\n color: #99b7b6;\n }\n} // .highlight\n\n.main-content {\n padding: 1rem 2rem 0;\n\n @media (min-width: 50rem) {\n padding: 1rem 2.5rem 0;\n }\n\n a {\n white-space: normal;\n }\n\n dl {\n display: block;\n\n dt {\n font-size: 1rem;\n font-style: italic;\n font-weight: 600;\n margin-top: 1rem;\n padding: 0;\n text-align: left;\n\n &::after {\n content: \"\";\n }\n\n code {\n font-weight: bold;\n }\n }\n }\n\n h1 {\n border-bottom: 1px solid $hr-color;\n margin-bottom: 1rem;\n padding-bottom: 1rem;\n }\n\n h1, h2, h3, h4, h5 {\n font-weight: bold;\n\n code {\n font-weight: bold;\n padding: 0.1rem 0.4rem;\n }\n }\n\n h1, h2, h3, h4, h5, h6 {\n padding-top: 1rem !important;\n }\n\n h2, h3, h4, h5, h6 {\n margin-bottom: 1rem !important;\n }\n\n h2, h3, h4, h5, h6 {\n margin-top: -0.6rem;\n text-transform: none;\n }\n\n h2, h3 {\n margin-top: -1rem !important;\n }\n\n h4 {\n font-size: 1rem !important;\n }\n\n h4,\n h5,\n h6 {\n code {\n font-size: 0.93em !important;\n }\n }\n\n h5,\n h6,\n .text-zeta {\n font-size: 1rem !important;\n }\n\n p:last-child {\n display: none;\n }\n\n p:nth-last-child(2),\n p:nth-last-child(6) {\n margin: 2rem 0 1rem;\n }\n\n // override theme list styles\n ul > li::before {\n color: inherit;\n content: none;\n margin-left: inherit;\n position: inherit;\n }\n\n ul {\n list-style-type: disc;\n }\n\n .anchor-heading {\n height: auto;\n left: -1.25rem;\n padding: 0;\n vertical-align: middle;\n width: 1rem;\n\n svg {\n color: $link-color;\n }\n }\n\n .highlighter-rouge {\n margin-bottom: 1.15rem;\n }\n}\n\n.main-content-wrap {\n padding: 0;\n}\n\n.main-header,\n.side-bar + .main .main-header {\n background-color: $body-background-color;\n border: 0;\n\n @media (max-width: 50rem) {\n background-color: $body-background-color;\n }\n}\n\n.nav-list {\n @media (max-width: 50rem) {\n text-align: center;\n }\n\n .nav-list-item {\n @media (max-width: 50rem) {\n display: inline-block;\n font-size: 1rem !important;\n }\n\n &:first-child .nav-list-link.active {\n background: 0;\n background-color: $side-bar-background-color;\n\n @media (max-width: 50rem) {\n background-color: $body-background-color;\n }\n\n &:hover {\n background-color: $body-background-color;\n }\n }\n\n code,\n &.nav-settings code {\n padding: 0.1em 0.25em 0.17em;\n\n @media (max-width: 50rem) {\n padding: 0.1rem 0.3rem;\n }\n }\n\n .nav-list-link {\n @media only screen and (min-width: 50rem) {\n line-height: 1rem !important;\n padding-left: 1.25rem !important;\n }\n\n @media (max-width: 50rem) {\n display: inline-block;\n padding: 0.2rem;\n }\n\n line-height: 1.5rem !important;\n min-height: auto;\n\n &:hover,\n &.active {\n background: 0;\n background-color: $body-background-color;\n }\n }\n\n .nav-separator {\n color: $muted-color;\n\n @media (min-width: 50rem) {\n display: none;\n }\n }\n }\n}\n\n.search-active .search-input,\n.search-input,\n.search-results,\n.search-result-previews {\n background-color: #1e1f25;\n color: #c7c5ce;\n}\n\n.search-input:focus + .search-label .search-icon,\n.search-result-doc .search-result-icon {\n color: lighten($body-color, 1%);\n}\n\n.search-input-wrap {\n @media (max-width: 50rem) {\n border-bottom: 1px solid lighten($body-background-color, 5%);\n box-shadow: 0 3px 10px rgba(0, 0, 0, 0.08);\n }\n}\n\n.search-result:hover,\n.search-result.active {\n background: none;\n background-color: #16181b;\n\n & .search-result-previews {\n background-color: #16181b;\n }\n}\n\n.search-result-doc.search-result-doc-parent {\n display: none;\n}\n\n.search-result-previews {\n border-left-color: #3a3a3a;\n}\n\n.side-bar {\n background-color: $side-bar-background-color;\n border: 0;\n}\n\n.site-button {\n &:hover {\n background: none;\n background-color: darken($body-background-color, 2%);\n border-radius: 0 0 5px 5px;\n\n @media (max-width: 50rem) {\n background-color: $body-background-color;\n }\n }\n\n &,\n .icon,\n .bi-x-lg {\n color: $body-color;\n }\n\n .bi-x-lg {\n display: none;\n }\n\n &.nav-open {\n .icon {\n display: none;\n }\n\n .bi-x-lg {\n display: block;\n margin-left: 0.2rem;\n }\n }\n\n text-align: center;\n}\n\n.site-footer {\n font-size: 0.85rem !important;\n padding: 0;\n position: relative;\n text-align: center;\n text-transform: lowercase;\n width: 100% !important;\n\n p {\n margin: 0;\n }\n\n\n .up-arrow {\n padding-top: 2rem;\n }\n}\n\n.site-header {\n border: 0;\n\n @media (max-width: 50rem) {\n background-color: $body-background-color;\n }\n\n @media (min-width: 50rem) {\n display: none;\n }\n}\n\n.site-nav {\n padding: 0 1rem;\n\n @media (max-width: 50rem) {\n background-color: $body-background-color;\n margin-top: -0.5rem;\n }\n\n @media (min-width: 50rem) {\n padding: 0;\n padding-top: 1rem;\n }\n\n code {\n font-size: 0.8rem;\n padding: 0;\n }\n}\n\n.site-nav,\n.site-header,\n.site-footer {\n @media (min-width: 66.5rem) {\n width: 14rem;\n }\n}\n\n.site-title {\n padding-left: 1.5rem;\n\n @media (max-width: 50rem) {\n display: none;\n }\n}\n\n.site-title:hover {\n background: 0;\n background-color: darken($side-bar-background-color, 2%);\n}\n\n.table-wrapper {\n box-shadow: none;\n}\n\n#console,\n#desert,\n#electro,\n#forest,\n#nb-default,\n#ocean,\n#raspberry,\n#smoke,\n#unicorn,\n#utility {\n margin-top: -1rem;\n}\n" }, { "path": "docs/assets/js/link-img-elements.js", "content": "(function linkImgElements($, window, document) {\n $(document).ready(function() {\n $('img').each(function() {\n $(this).wrap(function() {\n return '\\\n';\n })\n })\n });\n}(jQuery, window, document));\n" }, { "path": "docs/assets/js/scroll-highlight.js", "content": "$(function() {\n $(window).scroll(function() {\n $(\"#home, h2, h3\").each(function() {\n if ($(window).scrollTop() >= $(this).offset().top - 200) {\n var id = $(this).attr('id');\n\n if (id.indexOf(\"-import--export\") !== -1) {\n id = '%EF%B8%8F-import--export';\n }\n\n if (id.indexOf(\"-set--settings\") !== -1) {\n id = '%EF%B8%8F-set--settings';\n }\n\n if (id.indexOf(\"-tasks\") !== -1) {\n id = '%EF%B8%8F-tasks';\n }\n\n if (\n id.indexOf(\"nb-markdown-bookmark-file-format\") !== -1 ||\n id.indexOf(\"nb-markdown-todo-file-format\") !== -1 ||\n id.indexOf(\"nb-notebook-specification\") !== -1\n ) {\n id = 'specifications';\n }\n\n $('.nav-list a').removeClass('active');\n $('.nav-list a[href=\"#' + id + '\"]').addClass('active');\n } else if($(window).scrollTop() + $(window).height() == $(document).height()) {\n $('.nav-list a').removeClass('active');\n $('.nav-list a[href=\"#tests\"').addClass('active');\n }\n });\n });\n});\n\n" }, { "path": "docs/color-themes.md", "content": "# `nb` Color Themes\n\n`nb` includes several built-in color themes. The colors for built-in themes can be overridden with [`nb settings color_primary`](https://github.com/xwmx/nb#settings-list---long) and [`nb settings color_secondary`](https://github.com/xwmx/nb#settings-list---long).\n\n`nb` also supports user-defined themes. For more information, see [`nb settings color_theme`](https://github.com/xwmx/nb#settings-list---long).\n\n## Built-in Themes\n\n### `blacklight`\n\n| ![blacklight](https://xwmx.github.io/misc/nb/images/nb-theme-blacklight-home.png) | ![blacklight](https://xwmx.github.io/misc/nb/images/nb-theme-blacklight-web.png) |\n|:--:|:--:|\n| | |\n\n##### `console`\n\n| ![console](https://xwmx.github.io/misc/nb/images/nb-theme-console-home.png) | ![console](https://xwmx.github.io/misc/nb/images/nb-theme-console-web.png) |\n|:--:|:--:|\n| | |\n\n##### `desert`\n\n| ![desert](https://xwmx.github.io/misc/nb/images/nb-theme-desert-home.png) | ![desert](https://xwmx.github.io/misc/nb/images/nb-theme-desert-web.png) |\n|:--:|:--:|\n| | |\n\n##### `electro`\n\n| ![electro](https://xwmx.github.io/misc/nb/images/nb-theme-electro-home.png) | ![electro](https://xwmx.github.io/misc/nb/images/nb-theme-electro-web.png) |\n|:--:|:--:|\n| | |\n\n##### `forest`\n\n| ![forest](https://xwmx.github.io/misc/nb/images/nb-theme-forest-home.png) | ![forest](https://xwmx.github.io/misc/nb/images/nb-theme-forest-web.png) |\n|:--:|:--:|\n| | |\n\n##### `nb` (default)\n\n| ![nb](https://xwmx.github.io/misc/nb/images/nb-theme-nb-home.png) | ![nb](https://xwmx.github.io/misc/nb/images/nb-theme-nb-web.png) |\n|:--:|:--:|\n| | |\n\n##### `ocean`\n\n| ![ocean](https://xwmx.github.io/misc/nb/images/nb-theme-ocean-home.png) | ![ocean](https://xwmx.github.io/misc/nb/images/nb-theme-ocean-web.png) |\n|:--:|:--:|\n| | |\n\n##### `raspberry`\n\n| ![raspberry](https://xwmx.github.io/misc/nb/images/nb-theme-raspberry-home.png) | ![raspberry](https://xwmx.github.io/misc/nb/images/nb-theme-raspberry-web.png) |\n|:--:|:--:|\n| | |\n\n##### `smoke`\n\n| ![smoke](https://xwmx.github.io/misc/nb/images/nb-theme-monochrome-home.png) | ![smoke](https://xwmx.github.io/misc/nb/images/nb-theme-smoke-web.png) |\n|:--:|:--:|\n| | |\n\n##### `unicorn`\n\n| ![unicorn](https://xwmx.github.io/misc/nb/images/nb-theme-unicorn-home.png) | ![unicorn](https://xwmx.github.io/misc/nb/images/nb-theme-unicorn-web.png) |\n|:--:|:--:|\n| | |\n\n##### `utility`\n\n| ![utility](https://xwmx.github.io/misc/nb/images/nb-theme-utility-home.png) | ![utility](https://xwmx.github.io/misc/nb/images/nb-theme-utility-web.png) |\n|:--:|:--:|\n| | |\n" }, { "path": "docs/index.markdown", "content": "---\nlayout: home\ntitle: nb · command line and local web plain text note-taking, bookmarking, archiving, and knowledge base application\npermalink: /\n---\n\n

\n\n
\n \"nb\"\n\n
\n\n

\n\n
\n \n \"Build\n \n
\n\n
 
\n
\n\n`nb` is a command line and local web\nnote‑taking, bookmarking, archiving,\nand knowledge base application\nwith:\n\n- plain text data storage,\n- [encryption](#password-protected-encrypted-notes-and-bookmarks),\n- [filtering](#listing--filtering), [pinning](#-pinning), [#tagging](#-tagging), and [search](#-search),\n- [Git](https://git-scm.com/)-backed [versioning](#-revision-history) and [syncing](#-git-sync),\n- [Pandoc](https://pandoc.org/)-backed [conversion](#%EF%B8%8F-import--export),\n- [[wiki-style linking]],\n- terminal and GUI web [browsing](#-browsing),\n- inline [images](#-images),\n- [todos](#-todos) with [tasks](#%EF%B8%8F-tasks),\n- global and local [notebooks](#-notebooks),\n- organization with [folders](#-folders),\n- customizable [color themes](#-color-themes),\n- extensibility through [plugins](#-plugins),\n\nand more, in a single portable script.\n\n`nb` creates notes in text-based formats like\n[Markdown](https://en.wikipedia.org/wiki/Markdown),\n[Org](https://orgmode.org/),\n[LaTeX](https://www.latex-project.org/),\nand [AsciiDoc](https://asciidoc.org/),\ncan work with files in any format,\ncan import and export notes to many document formats,\nand can create private, password-protected encrypted notes and bookmarks.\nWith `nb`, you can write notes using\nVim,\nEmacs,\nVS Code,\nSublime Text,\nand any other text editor you like,\nas well as terminal and GUI web browsers.\n`nb` works in any standard Linux / Unix environment,\nincluding macOS and Windows via WSL, MSYS, and Cygwin.\n[Optional dependencies](#optional) can be installed to enhance functionality,\nbut `nb` works great without them.\n\n
\n \"home\"\n\n
\n\n`nb` is also a powerful [bookmarking](#-bookmarks) system featuring:\n\n- locally-served, text-centric, distraction-free bookmark [browsing](#-browsing)\n in terminal and GUI web browsers,\n- local full-text search of cached page content with regular expression support,\n- convenient filtering and listing,\n- [Internet Archive Wayback Machine](https://archive.org/web/) snapshot lookup\n for broken links,\n- tagging, pinning, linking, and full integration with other `nb` features.\n\nPage information is\ndownloaded,\ncleaned up,\nstructured,\nand saved\ninto normal Markdown documents made for humans,\nso bookmarks are easy to view and edit just like any other note.\n\n
\n \"nb\n
\n\n`nb` uses [Git](https://git-scm.com/) in the background to\nautomatically record changes and sync notebooks with remote repositories.\n`nb` can also be configured to\nsync notebooks using a general purpose syncing utility like Dropbox\nso notes can be edited in other apps on any device.\n\n
\n \"nb\n
\n\n`nb` is designed to be portable, future-focused, and vendor independent,\nproviding a full-featured and intuitive experience within\na highly composable multimodal user-centric text interface.\nThe entire program is contained within\na single [well-tested](#tests) shell script\nthat can be\ninstalled, copied, or `curl`ed almost anywhere and just work,\nusing a strategy inspired by\n[progressive enhancement](https://en.wikipedia.org/wiki/Progressive_enhancement)\nfor various experience improvements in more capable environments.\n`nb` works great whether you have one notebook with just a few notes\nor dozens of notebooks containing thousands of notes, bookmarks, and other items.\n`nb` makes it easy to incorporate other tools, writing apps, and workflows.\n`nb` can be used a little, a lot, once in a while, or for just a subset of features.\n`nb` is flexible.\n\n
 
\n\n
\n \n 📝\n 🔖\n 🔍\n 🌍\n 🔒\n ✅\n 🔄\n 🎨\n 📚\n 📌\n 📂\n 🌄\n \n
\n\n

 

\n\n
\n

nb

\n
\n\n
\n Installation ·\n Overview  \n
\n\n

\n\n
\n Help\n
\n\n

\n\n
\n  ↑ \n
\n\n### Installation\n\n#### Dependencies\n\n##### Required\n\n- [Bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell))\n - `nb` works perfectly with Zsh, fish, and any other shell\n set as your primary login shell,\n the system just needs to have Bash available on it.\n- [Git](https://git-scm.com/)\n- A text editor with command line support, such as:\n - [Vim](https://en.wikipedia.org/wiki/Vim_\\(text_editor\\)),\n - [Emacs](https://en.wikipedia.org/wiki/Emacs),\n - [Visual Studio Code](https://code.visualstudio.com/),\n - [Sublime Text](https://www.sublimetext.com/),\n - [Helix](https://helix-editor.com/),\n - [micro](https://github.com/zyedidia/micro),\n - [nano](https://en.wikipedia.org/wiki/GNU_nano),\n - [Atom](https://atom.io/),\n - [TextMate](https://macromates.com/),\n - [MacDown](https://macdown.uranusjr.com/),\n - [some of these](https://github.com/topics/text-editor),\n - [and many of these.](https://en.wikipedia.org/wiki/List_of_text_editors)\n\n##### Optional\n\n`nb` leverages standard command line tools\nand works in standard Linux / Unix environments.\n`nb` also checks the environment for some additional optional tools and\nuses them to enhance the experience whenever they are available.\n\nRecommended:\n\n- [`bat`](https://github.com/sharkdp/bat)\n- [`ncat`](https://nmap.org/ncat/) or [`socat`](https://www.kali.org/tools/socat/)\n- [`pandoc`](https://pandoc.org/)\n- [`rg`](https://github.com/BurntSushi/ripgrep)\n- [`tig`](https://github.com/jonas/tig)\n- [`w3m`](https://en.wikipedia.org/wiki/W3m)\n\nAlso supported for various enhancements:\n\n[Ack](https://beyondgrep.com/),\n[`afplay`](https://ss64.com/osx/afplay.html),\n[`asciidoctor`](https://asciidoctor.org/),\n[The Silver Searcher (`ag`)](https://github.com/ggreer/the_silver_searcher),\n[`catimg`](https://github.com/posva/catimg),\n[Chafa](https://github.com/hpjansson/chafa),\n[Chromium](https://www.chromium.org) / [Chrome](https://www.google.com/chrome/),\n[`eza`](https://github.com/eza-community/eza),\n[`ffplay`](https://ffmpeg.org/ffplay.html),\n[ImageMagick](https://imagemagick.org/),\n[`glow`](https://github.com/charmbracelet/glow),\n[GnuPG](https://en.wikipedia.org/wiki/GNU_Privacy_Guard),\n[`highlight`](http://www.andre-simon.de/doku/highlight/en/highlight.php),\n[`imgcat`](https://www.iterm2.com/documentation-images.html),\n[`joshuto`](https://github.com/kamiyaa/joshuto),\n[kitty's `icat` kitten](https://sw.kovidgoyal.net/kitty/kittens/icat.html),\n[`lowdown`](https://kristaps.bsd.lv/lowdown),\n[`lsd`](https://github.com/lsd-rs/lsd),\n[Links](https://en.wikipedia.org/wiki/Links_(web_browser)),\n[Lynx](https://en.wikipedia.org/wiki/Lynx_(web_browser)),\n[`mdcat`](https://github.com/swsnr/mdcat),\n[`mdless`](https://github.com/ttscoff/mdless),\n[`mdv`](https://github.com/axiros/terminal_markdown_viewer),\n[Midnight Commander (`mc`)](https://en.wikipedia.org/wiki/Midnight_Commander),\n[`mpg123`](https://en.wikipedia.org/wiki/Mpg123),\n[MPlayer](https://en.wikipedia.org/wiki/MPlayer),\n[`ncat`](https://nmap.org/ncat/),\n[`netcat`](https://netcat.sourceforge.net/),\n[note-link-janitor](https://github.com/andymatuschak/note-link-janitor)\n(via [plugin](https://github.com/xwmx/nb/blob/master/plugins/backlink.nb-plugin)),\n[`pdftotext`](https://en.wikipedia.org/wiki/Pdftotext),\n[Pygments](https://pygments.org/),\n[Ranger](https://ranger.github.io/),\n[readability-cli](https://gitlab.com/gardenappl/readability-cli),\n[`rga` / ripgrep-all](https://github.com/phiresky/ripgrep-all),\n[`sc-im`](https://github.com/andmarti1424/sc-im),\n[`socat`](https://www.kali.org/tools/socat/),\n[`termvisage`](https://github.com/AnonymouX47/termvisage),\n[`termpdf.py`](https://github.com/dsanson/termpdf.py),\n[Tidy-Viewer (`tv`)](https://github.com/alexhallam/tv),\n[`timg`](https://github.com/hzeller/timg),\n[vifm](https://vifm.info/),\n[`viu`](https://github.com/atanunq/viu),\n[VisiData](https://www.visidata.org/)\n\n#### macOS / Homebrew\n\n```bash\nbrew install xwmx/taps/nb\n```\n\nInstalling `nb` with Homebrew also installs\nthe recommended dependencies above\nand completion scripts for Bash, Zsh, and Fish.\n\nInstall the latest development version from the repository with:\n\n```bash\nbrew install xwmx/taps/nb --head\n```\n\n`nb` is also available in\n[homebrew-core](https://github.com/Homebrew/homebrew-core).\nInstalling it together with the `bash` formula is recommended:\n\n```bash\nbrew install nb bash\n```\n\n#### Ubuntu, Windows, and others\n\n##### npm\n\n```bash\nnpm install -g nb.sh\n```\n\nAfter `npm` installation completes, run\n`sudo \"$(which nb)\" completions install`\nto install Bash and Zsh completion scripts (recommended).\n\nOn Ubuntu and WSL, you can\nrun [`sudo \"$(which nb)\" env install`](#env)\nto install the optional dependencies.\n\nWhen `nb` is installed on Windows,\n`socat` ([MSYS](https://packages.msys2.org/package/socat),\n[Cygwin](https://cygwin.com/packages/summary/socat.html)) is recommended.\n\n*`nb` is also available under its original package name,\n[notes.sh](https://www.npmjs.com/package/notes.sh),\nwhich comes with an extra `notes` executable wrapping `nb`.*\n\n##### Download and Install\n\nTo install as an administrator,\ncopy and paste one of the following multi-line commands:\n\n```bash\n# install using wget\nsudo wget https://raw.github.com/xwmx/nb/master/nb -O /usr/local/bin/nb &&\n sudo chmod +x /usr/local/bin/nb &&\n sudo nb completions install --download\n\n# install using curl\nsudo curl -L https://raw.github.com/xwmx/nb/master/nb -o /usr/local/bin/nb &&\n sudo chmod +x /usr/local/bin/nb &&\n sudo nb completions install --download\n```\n\nOn Ubuntu and WSL, you can\nrun [`sudo nb env install`](#env) to install the optional dependencies.\n\n###### User-only Installation\n\nTo install with just user permissions, simply\nadd the `nb` script to your `$PATH`.\nIf you already have a `~/bin` directory, for example, you can\nuse one of the following commands:\n\n```bash\n# download with wget\nwget https://raw.github.com/xwmx/nb/master/nb -O ~/bin/nb && chmod +x ~/bin/nb\n\n# download with curl\ncurl -L https://raw.github.com/xwmx/nb/master/nb -o ~/bin/nb && chmod +x ~/bin/nb\n```\n\nInstalling with just user permissions doesn't include\nthe optional dependencies or completions,\nbut `nb` core functionality works without them.\nIf you have `sudo` access and want\nto install the completion scripts and dependencies, run the following command:\n\n```bash\nsudo nb env install\n```\n\n##### Make\n\nTo install with [Make](https://en.wikipedia.org/wiki/Make_(software)),\nclone this repository, navigate to the clone's root directory, and run:\n\n```bash\nsudo make install\n```\n\nThis will also install the completion scripts on all systems and\nthe recommended dependencies on Ubuntu and WSL.\n\n##### bpkg\n\nTo install with [bpkg](https://github.com/bpkg/bpkg):\n\n```bash\nbpkg install xwmx/nb\n```\n\n##### basher\n\nTo install with [basher](https://www.basher.it/):\n\n```bash\nbasher install xwmx/nb\n```\n\n#### Tab Completion\n\nBash, Fish, and Zsh tab completion should be enabled\nwhen `nb` is installed using the methods above,\nassuming you have the appropriate system permissions or installed with `sudo`.\nIf completion isn't working after installing `nb`, see the\n[completion installation instructions](https://github.com/xwmx/nb/tree/master/etc).\n\n#### Updating\n\nWhen `nb` is installed using a package manager like npm or Homebrew,\nuse the package manager's upgrade functionality to update `nb` to\nthe latest version.\nWhen installed via other methods,\n`nb` can be updated to the latest version using\nthe [`nb update`](#update) subcommand.\n\n## Overview\n\n\n\n

\n\n
\n  ↑ \n
\n\n

\n\nTo get started, simply run:\n\n```bash\nnb\n```\n\n`nb` sets up your initial `home` notebook the first time it runs.\n\nBy default, notebooks and notes are global (at `~/.nb`),\nso they are always available to `nb`\nregardless of the current working directory.\n`nb` also supports [local notebooks](#global-and-local-notebooks).\n\n### 📝 Notes\n\n#### Adding\n\n

\n \n ↑ ·\n nb add,\n nb browse add\n \n

\n\nUse [`nb add`](#add) (shortcuts: [`nb a`](#add), [`nb +`](#add))\nto create new notes:\n\n```bash\n# create a new note in your text editor\nnb add\n\n# create a new note with the filename \"example.md\"\nnb add example.md\n\n# create a new note containing \"This is a note.\"\nnb add \"This is a note.\"\n\n# create a new note with piped content\necho \"Note content.\" | nb add\n\n# create a new password-protected, encrypted note titled \"Secret Document\"\nnb add --title \"Secret Document\" --encrypt\n\n# create a new note in the notebook named \"example\"\nnb example:add \"This is a note.\"\n\n# create a new note in the folder named \"sample\"\nnb add sample/\n```\n\n[`nb add`](#add) with no arguments or input will open the new, blank note\nin your environment's preferred text editor.\nYou can change your editor using\nthe `$EDITOR` environment variable\nor [`nb set editor`](#editor).\n\n`nb` files are [Markdown](https://daringfireball.net/projects/markdown/)\nfiles by default. The default file type can be changed to\nwhatever you like\nusing [`nb set default_extension`](#default_extension).\n\n[`nb add`](#add) has intelligent argument parsing\nand behaves differently depending on the types of arguments it receives.\nWhen a filename with extension is specified,\na new note with that filename is opened in the editor:\n\n```bash\nnb add example.md\n```\n\nWhen a string is specified, a new note is immediately created\nwith that string as the content and without opening the editor:\n\n```bash\n❯ nb add \"This is a note.\"\nAdded: [1] 20200101000000.md\n```\n\n[`nb add `](#add) is useful for quickly jotting down notes directly\nvia the command line. Quoting content is optional, but recommended.\n\nWhen no filename is specified, [`nb add`](#add) uses the current datetime as\nthe filename.\n\n[`nb add`](#add) can also receive piped content, which behaves the same as\n[`nb add `](#add):\n\n```bash\n# create a new note containing \"Note content.\"\n❯ echo \"Note content.\" | nb add\nAdded: [6] 20200101000100.md\n\n# create a new note containing the clipboard contents on macOS\n❯ pbpaste | nb add\nAdded: [7] 20200101000200.md\n\n# create a new note containing the clipboard contents using xclip\n❯ xclip -o | nb add\nAdded: [8] 20200101000300.md\n```\n\nContent can be passed with the [`--content `](#add) option,\nwhich also creates a new note without opening the editor:\n\n```bash\nnb add --content \"Note content.\"\n```\n\nWhen content is piped,\nspecified with [`--content `](#add),\nor passed as a string argument,\nuse the [`--edit`](#add) flag to open the file in the editor\nbefore the change is committed.\n\nThe title, filename, and content can also be specified with long and\nshort options:\n\n```bash\n❯ nb add --filename \"example.md\" -t \"Example Title\" -c \"Example content.\"\nAdded: [9] example.md \"Example Title\"\n```\n\nThe [`-t `](#add) / [`--title <title>`](#add) option also\nsets the filename to the title,\nlowercased with spaces and non-filename characters replaced with underscores:\n\n```bash\n❯ nb add --title \"Example Title\" \"Example content.\"\nAdded: [10] example_title.md \"Example Title\"\n```\n\nTags can be added with the [`--tags <tag1>,<tag2>...`](#add) option, which\ntakes a comma separated list of tags,\nconverts them to [#hashtags](#-tagging),\nand inserts them between the title and content:\n\n```bash\n❯ nb add \"Example content.\" --title \"Tagged Example\" --tags tag1,tag2\nAdded: [11] tagged_example.md \"Tagged Example\"\n\n❯ nb show 11 --print\n# Tagged Example\n\n#tag1 #tag2\n\nExample content.\n```\n\n[Search](#-search) for tagged items with\n[`nb search`](#search) / [`nb q`](#search):\n\n```bash\n# search for items tagged with \"#tag1\"\nnb search --tag tag1\n\n# search for items tagged with \"#tag1\" AND \"#tag2\", short options\nnb q -t tag1 -t tag2\n\n# search for items tagged with \"#tag1\" OR \"#tag2\", arguments\nnb q \\#tag1 --or \\#tag2\n```\n\nFiles can be created with any file type by specifying the extension either\nin the filename (`example.md`),\nthe extension by itself (`.md`),\nor via the [`--type <type>`](#add) option (`--type md`):\n\n```bash\n# open a new Org file in the editor\nnb add example.org\n\n# open a new reStructuredText file in the editor\nnb add --type rst\n\n# open a new JavaScript file in the editor\nnb add .js\n```\n\nCombining a type argument with piped clipboard content provides\na very convenient way to save code snippets using a clipboard utility such as\n`pbpaste`,\n`xclip`,\nor [`pb`](https://github.com/xwmx/pb):\n\n```bash\n# save the clipboard contents as a JavaScript file in the current notebook\npb | nb add .js\n\n# save the clipboard contents as a Rust file in the \"rust\" notebook\n# using the shortcut alias `nb a`\npb | nb a rust: .rs\n\n# save the clipboard contents as a Haskell file named \"example.hs\" in the\n# \"snippets\" notebook using the shortcut alias `nb +`\npb | nb + snippets: example.hs\n```\n\nUse [`nb show`](#show) and [`nb browse`](#browse) to view code snippets\nwith automatic syntax highlighting and\nuse [`nb edit`](#edit) to open in your editor.\n\nThe [`clip` plugin](#clip) can also be used to\ncreate notes from clipboard content.\n\nPiping,\n[`--title <title>`](#add),\n[`--tags <tag-list>`](#add),\n[`--content <content>`](#add),\nand content passed in an argument\ncan be combined as needed\nto create notes with content from multiple input methods and sources\nusing a single command:\n\n```bash\n❯ pb | nb add \"Argument content.\" \\\n --title \"Sample Title\" \\\n --tags tag1,tag2 \\\n --content \"Option content.\"\nAdded: [12] sample_title.md \"Sample Title\"\n\n❯ nb show 12 --print\n# Sample Title\n\n#tag1 #tag2\n\nArgument content.\n\nOption content.\n\nClipboard content.\n```\n\nFor a full list of options available for [`nb add`](#add), run\n[`nb help add`](#add).\n\n##### Password-Protected Encrypted Notes and Bookmarks\n\nPassword-protected notes and [bookmarks](#-bookmarks) are\ncreated with the [`-e`](#add) / [`--encrypt`](#add) flag and\nencrypted with AES-256 using OpenSSL by default.\nGPG is also supported and can be configured with\n[`nb set encryption_tool`](#encryption_tool).\n\nEach protected note and bookmark is\nencrypted individually with its own password.\nWhen an encrypted item is viewed, edited, or opened,\n`nb` will simply prompt for the item's password before proceeding.\nAfter an item is edited,\n`nb` automatically re-encrypts it and saves the new version.\n\nEncrypted notes can be decrypted\nusing the OpenSSL and GPG command line tools directly, so\nyou aren't dependent on `nb` to decrypt your files.\n\n##### Templates\n\nCreate a note based on a template by assigning a template string\nor path to a template file with [`add --template <template>`](#add):\n\n<!-- {% raw %} -->\n```bash\n# create a new note based on a template specified by path\nnb add --template /path/to/example/template\n\n# create a new note based on a template defined as a string\nnb add --template \"{{title}} • {{content}}\"\n```\n<!-- {% endraw %} -->\n\n`nb` template tags are enclosed in double curly brackets.\nSupported tags include:\n\n<dl>\n <dt><code>{{title}}</code></dt>\n <dd>The note title, as specified with\n <a href=\"#add\"><code>add --title <title></code></a></dd>\n <dt><code>{{tags}}</code></dt>\n <dd>A list of hashtags, as specified with\n <a href=\"#add\"><code>add --tags <tag1>,<tag2></code></a></dd>\n <dt><code>{{content}}</code></dt>\n <dd>The note content, as specified with\n <a href=\"#add\"><code>add <content></code></a>,\n <a href=\"#add\"><code>add --content <content></code></a>,\n and piped content.</dd>\n <dt><code>{{date}}</code></dt>\n <dd>The ouput of the system's <code>date</code> command. Use the\n <a href=\"https://man7.org/linux/man-pages/man1/date.1.html\"><code>date</code>\n command options</a> to control formatting, e.g.,\n <code>{{date +\"%Y-%m-%d\"}}</code>.\n </dd>\n</dl>\n\nAn example complete markdown template could look like the following:\n\n<!-- {% raw %} -->\n```\n# {{title}}\n\n{{date +\"%Y-%m-%d\"}}\n\n{{tags}}\n\n{{content}}\n```\n<!-- {% endraw %} -->\n\nTemplates are Bash strings processed with `eval`, so you can use\ncommand substitution (`$(echo \"Example command\")`) to include\nthe output from command line tools and shell code.\n\nA default template can be configured by assigning a string or path\nto the [`$NB_DEFAULT_TEMPLATE`](#nb_default_template) variable\nin your `~/.nbrc` file:\n\n<!-- {% raw %} -->\n```bash\n# set the default template to a path\nexport NB_DEFAULT_TEMPLATE=\"/path/to/example/template\"\n\n# set the default template with a string\nexport NB_DEFAULT_TEMPLATE=\"{{title}} • {{content}}\"\n```\n<!-- {% endraw %} -->\n\nUse [`nb add --no-template`](#add) to skip using a template when\none is assigned.\n\n##### Shortcut Aliases: `nb a`, `nb +`\n\n`nb` includes shortcuts for many commands, including\n[`nb a`](#add) and [`nb +`](#add) for [`nb add`](#add):\n\n```bash\n# create a new note in your text editor\nnb a\n\n# create a new note with the filename \"example.md\"\nnb a example.md\n\n# create a new note containing \"This is a note.\"\nnb + \"This is a note.\"\n\n# create a new note containing the clipboard contents with xclip\nxclip -o | nb +\n\n# create a new note in the notebook named \"example\"\nnb example:a\n```\n\n##### Other Aliases: `nb create`, `nb new`\n\n[`nb add`](#add) can also be invoked with\n[`nb create`](#add) and [`nb new`](#add) for convenience:\n\n```bash\n# create a new note containing \"Example note content.\"\nnb new \"Example note content.\"\n\n# create a new note with the title \"Example Note Title\"\nnb create --title \"Example Note Title\"\n```\n\n##### Adding with `nb browse`\n\nItems can also be added within terminal and GUI web browsers using\n[`nb browse add`](#browse) / [`nb b a`](#browse):\n\n```bash\n❯ nb browse add\n❯nb · home : +\n\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n\n[add]\n```\n\nPass a filename, relative path, and / or notebook name to\ncreate a new note at that location:\n\n```bash\n# open the add form in the browser to create the file \"file.md\" in the folder \"example\"\nnb browse add \"example/file.md\"\n```\n\n[`nb browse add`](#browse) includes options for quickly\npre-populating new notes with content:\n\n```bash\n❯ nb browse add --title \"Example Title\" --content \"Example content.\" --tags tag1,tag2\n❯nb · home : +\n\n[# Example Title ]\n[ ]\n[#tag1 #tag2 ]\n[ ]\n[Example content. ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n\n[add]\n```\n\n[`nb browse add`](#browse) can also be opened with\n[`nb add --browse`](#add) / [`nb a -b`](#add).\n\nFor more information, see [Browsing](#-browsing).\n\n#### Listing & Filtering\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#ls\"><code>nb ls</code></a>,\n <a href=\"#list\"><code>nb list</code></a>,\n <a href=\"#browse\"><code>nb browse</code></a>\n </sup>\n</p>\n\nTo list notes and notebooks, run [`nb ls`](#ls) (shortcut alias: `nb`):\n\n<div align=\"center\">\n <img src=\"https://xwmx.github.io/misc/nb/images/nb-theme-utility-home.png\"\n alt=\"nb ls\"\n width=\"450\">\n</div>\n\nNotebooks are listed above the line,\nwith the current notebook highlighted and/or underlined,\ndepending on terminal capabilities.\n[`nb ls`](#ls) also includes a footer with example commands for easy reference.\nThe notebook header and command footer can be configured or hidden with\n[`nb set header`](#header) and\n[`nb set footer`](#footer).\n\n```bash\n❯ nb ls\nhome\n----\n[3] example.md · \"Example content.\"\n[2] sample.md · \"Sample content.\"\n[1] demo.md · \"- Demo list item one.\"\n```\n\nNotes from the current notebook are listed in the order they were last modified.\nBy default, each note is listed with its\nid, filename, and an excerpt from the first line of the note.\nWhen a note has a title, the title is displayed\ninstead of the filename and first line.\n\nMarkdown titles can be defined within a note using\n[either Markdown `h1` style](https://daringfireball.net/projects/markdown/syntax#header)\nor [YAML front matter](#front-matter):\n\n```markdown\n# Example Title\n```\n\n```markdown\nSample Title\n============\n```\n\n```markdown\n---\ntitle: Demo Title\n---\n```\n\n[Org](https://orgmode.org/),\n[LaTeX](https://www.latex-project.org/),\nand [AsciiDoc](https://asciidoc.org/)\ntitles are recognized in `.org`,`.latex`, and `.asciidoc` / `.adoc` files:\n\n```text\n#+title: Example Org Title\n```\n\n```latex\n\\title{Example LaTeX Title}\n```\n\n```asciidoc\n= Example AsciiDoc Title\n```\n\nOnce defined, titles are displayed in place of the filename and first line\nin the output of [`nb ls`](#ls):\n\n```bash\n❯ nb ls\nhome\n----\n[3] Example Title\n[2] Sample Title\n[1] Demo Title\n```\n\nPass an id, filename, or title to view the listing for that note:\n\n```bash\n❯ nb ls Sample\\ Title\n[2] Sample Title\n\n❯ nb ls 3\n[3] Example Title\n```\n\nIf there is no exact match, `nb` will list items with\ntitles and filenames that fuzzy match the query:\n\n```bash\n❯ nb ls exa\n[3] Example Title\n\n❯ nb ls ample\n[3] Example Title\n[2] Sample Title\n```\n\nMultiple words act like an `OR` filter, listing any\ntitles or filenames that match any of the words:\n\n```bash\n❯ nb ls example demo\n[3] Example Title\n[1] Demo Title\n```\n\nWhen multiple words are quoted, filter titles and filenames for that phrase:\n\n```bash\n❯ nb ls \"example title\"\n[3] Example Title\n```\n\nFor full text search, see [Search](#-search).\n\nTo view excerpts of notes, use the [`--excerpt`](#ls) or [`-e`](#ls) option,\nwhich optionally accepts a length:\n\n```bash\n❯ nb ls 3 --excerpt\n[3] Example Title\n-----------------\n# Example Title\n\nThis is an example excerpt.\n\n❯ nb ls 3 -e 8\n[3] Example Title\n-----------------\n# Example Title\n\nThis is an example excerpt.\n\nMore example content:\n\n- one\n- two\n```\n\nSeveral classes of file types are represented with emoji\n[indicators](#indicators) to make them easily identifiable in lists.\nFor example, bookmarks and encrypted notes are listed with `🔖` and `🔒`:\n\n```bash\n❯ nb ls\nhome\n----\n[4] Example Note\n[3] 🔒 encrypted-note.md.enc\n[2] 🔖 Example Bookmark (example.com)\n[1] 🔖 🔒 encrypted.bookmark.md.enc\n```\n\nFile types include:\n\n```text\n 🔉 Audio\n 📖 Book\n 🔖 Bookmark\n 🔒 Encrypted\n 📂 Folder\n 🌄 Image\n 📄 PDF, Word, or Open Office document\n 📹 Video\n```\n\nBy default, items are listed starting with the most recently modified.\nTo reverse the order, use the [`-r`](#ls) or [`--reverse`](#ls) flag:\n\n```bash\n❯ nb ls\nhome\n----\n[2] Todos\n[3] Example Title\n[1] Ideas\n\n❯ nb ls --reverse\n[1] Ideas\n[3] Example Title\n[2] Todos\n```\n\nNotes can be sorted with the [`-s`](#ls) / [`--sort`](#ls) flag,\nwhich can be combined with [`-r`](#ls) / [`--reverse`](#ls):\n\n```bash\n❯ nb ls\nhome\n----\n[2] Sample Title\n[3] Example Title\n[1] Demo Title\n\n❯ nb ls --sort\n[1] Demo Title\n[2] Sample Title\n[3] Example Title\n\n❯ nb ls --sort --reverse\n[3] Example Title\n[2] Sample Title\n[1] Demo Title\n```\n\n`nb` with no subcommand behaves like an alias for [`nb ls`](#ls),\nso the examples above can be run without the `ls`:\n\n```bash\n❯ nb\nhome\n----\n[2] Sample Title\n[3] Example Title\n[1] Demo Title\n\n❯ nb example\n[3] Example Title\n\n❯ nb 3 --excerpt\n[3] Example Title\n-----------------\n# Example Title\n\nThis is an example excerpt.\n\n❯ nb 3 -e 8\n[3] Example Title\n-----------------\n# Example Title\n\nThis is an example excerpt.\n\nMore example content:\n\n- one\n- two\n\n❯ nb --sort\n[1] Demo Title\n[2] Sample Title\n[3] Example Title\n\n❯ nb --sort --reverse\n[3] Example Title\n[2] Sample Title\n[1] Demo Title\n```\n\nShort options can be combined for brevity:\n\n```bash\n# equivalent to `nb --sort --reverse --excerpt 2` and `nb -s -r -e 2`:\n❯ nb -sre 2\n[3] Example Title\n-----------------\n# Example Title\n\n[2] Sample Title\n----------------\nSample Title\n============\n[1] Demo Title\n--------------\n---\ntitle: Demo Title\n```\n\n`nb` and [`nb ls`](#ls) display the 15 most recently modified items.\nThe default limit can be changed with [`nb set limit <number>`](#limit).\nTo list a different number of items on a per-command basis, use the\n[`-n <limit>`](#ls),\n[`--limit <limit>`](#ls),\n[`--<limit>`](#ls),\n[`-a`](#ls),\nand [`--all`](#ls)\nflags:\n\n```bash\n❯ nb -n 1\nhome\n----\n[5] Example Five\n4 omitted. 5 total.\n\n❯ nb --limit 2\nhome\n----\n[5] Example Five\n[4] Example Four\n3 omitted. 5 total.\n\n❯ nb --3\nhome\n----\n[5] Example Five\n[4] Example Four\n[3] Example Three\n2 omitted. 5 total.\n\n❯ nb --all\nhome\n----\n[5] Example Five\n[4] Example Four\n[3] Example Three\n[2] Example Two\n[1] Example One\n```\n\nLists can be paginated with\n[`-p <number>`](#ls) / [`--page <number>`](#ls),\nwhich paginates by the value of [`nb set limit`](#limit) by\ndefault, or the value of\n[`-n <limit>`](#ls),\n[`--limit <limit>`](#ls),\nor [`--<limit>`](#ls)\nwhen present:\n\n```bash\n❯ nb\nhome\n----\n[6] Example Six\n[5] Example Five\n[4] Example Four\n[3] Example Three\n[2] Example Two\n[1] Example One\n\n❯ nb set limit 3\nNB_LIMIT set to 3\n\n❯ nb --page 1\n[6] Example Six\n[5] Example Five\n[4] Example Four\n\n❯ nb -p 2\n[3] Example Three\n[2] Example Two\n[1] Example One\n\n❯ nb -p 2 --limit 2\n[4] Example Four\n[3] Example Three\n\n❯ nb -p 3 --2\n[2] Example Two\n[1] Example One\n```\n\nList [#tagged](#tagging) items by passing `\\#escaped` or `\"#quoted\"` hashtags\nor tags specified with the [`--tags`](#ls) option. Multiple tags perform an\n`AND` query:\n\n```bash\n# list items in the current notebook tagged with \"#tag1\", escaped\nnb \\#tag1\n\n# list items in the \"example\" notebook tagged with \"#tag2\", quoted\nnb example: \"#tag2\"\n\n# list items in all notebooks tagged with \"#tag1\", long option\nnb \\#tag1 --all\n\n# list items in the current notebook tagged with \"#tag1\" AND \"#tag2\"\nnb \\#tag1 \"#tag2\"\n\n# list items in all notebooks tagged with \"#tag2\" AND \"#tag3\", short option\nnb --tags tag2,tag3 -a\n```\n\n[`nb ls`](#ls) is a combination of\n[`nb notebooks`](#notebooks) and [`nb list`](#list)\nin one view and accepts the same arguments as [`nb list`](#list),\nwhich lists only notes without the notebook list and with no limit by default:\n\n```bash\n❯ nb list\n[100] Example One Hundred\n[99] Example Ninety-Nine\n[98] Example Ninety-Eight\n... lists all notes ...\n[2] Example Two\n[1] Example One\n```\n\nFor more information about options for listing notes, run\n[`nb help ls`](#ls)\nand\n[`nb help list`](#list).\n\n##### Listing with `browse`\n\nItems can be listed within terminal and GUI web browsers using\n[`nb browse`](#browse) / [`nb b`](#browse):\n\n```bash\n❯ nb browse example:sample/demo/\n❯nb · example : sample / demo / +\n\nsearch: [ ]\n\n[example:sample/demo/7] Title Seven\n[example:sample/demo/6] Title Six\n[example:sample/demo/5] Title Five\n[example:sample/demo/4] Title Four\n[example:sample/demo/3] Title Three\n\nnext ❯\n```\n\nFor more information, see [Browsing](#-browsing).\n\n#### Editing\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#edit\"><code>nb edit</code></a>,\n <a href=\"#browse\"><code>nb browse edit</code></a>\n </sup>\n</p>\n\nYou can edit an item in your editor with\n[`nb edit`](#edit) (shortcut: [`nb e`](#edit)):\n\n```bash\n# edit note by id\nnb edit 3\n\n# edit note by filename\nnb edit example.md\n\n# edit note by title\nnb edit \"A Document Title\"\n\n# edit note 12 in the notebook named \"example\"\nnb edit example:12\n\n# edit note 12 in the notebook named \"example\", alternative\nnb example:12 edit\n\n# edit note 12 in the notebook named \"example\", alternative\nnb example:edit 12\n\n# edit the last modified item\nnb edit --last\n```\n\n[`edit`](#edit) and other subcommands that take an identifier\ncan be called with the identifier and subcommand name reversed:\n\n```bash\n# edit note by id\nnb 3 edit\n```\n\n[`nb edit`](#edit) can also receive piped content, which it\nappends to the specified note without opening the editor:\n\n```bash\necho \"Content to append.\" | nb edit 1\n```\n\nContent can be passed with the [`--content <content>`](#edit) option,\nwhich also appends the content without opening the editor:\n\n```bash\nnb edit 1 --content \"Content to append.\"\n```\n\nUse the [`--overwrite`](#edit) option to overwrite existing file content\nand the [`--prepend`](#edit) option to prepend the new content before existing content.\n\nWhen content is piped or specified with [`--content <content>`](#edit),\nuse the [`--edit`](#edit) flag to open the file in the editor\nbefore the change is committed.\n\nEdit the last modified item with [`--last`](#edit) / [`-l`](#edit):\n\n```bash\n# edit the last modified item\nnb edit --last\n\n# edit the last modified item, short option\nnb edit -l\n```\n\n##### Editing Encrypted Notes\n\nWhen a note is encrypted,\n[`nb edit`](#edit) prompts you for the note password,\nopens the unencrypted content in your editor,\nand then automatically reencrypts the note when you are done editing.\n\n##### Shortcut Alias: `nb e`\n\n[`nb edit`](#edit) can be called by the shortcut alias, [`nb e`](#edit):\n\n```bash\n# edit note by id\nnb e 3\n\n# edit note by filename\nnb e example.md\n\n# edit note by title\nnb e \"A Document Title\"\n\n# edit note by id, alternative\nnb 3 e\n\n# edit note 12 in the notebook named \"example\"\nnb e example:12\n\n# edit note 12 in the notebook named \"example\", alternative\nnb example:12 e\n\n# edit note 12 in the notebook named \"example\", alternative\nnb example:e 12\n\n# edit the last modified item, short option\nnb e -l\n```\n\nFor [`nb edit`](#edit) help information, run [`nb help edit`](#edit).\n\n##### Editing with `browse`\n\nItems can be edited within terminal and GUI web browsers using\n[`nb browse edit`](#browse) / [`nb b e`](#browse):\n\n```bash\n❯ nb browse edit text:formats/markdown/123\n❯nb · text : formats / markdown / 123 · ↓ · editing · - | +\n\n[# Daring Fireball: Markdown (daringfireball.net) ]\n[ ]\n[<https://daringfireball.net/projects/markdown/> ]\n[ ]\n[## Related ]\n[ ]\n[- <https://en.wikipedia.org/wiki/Markdown> ]\n[ ]\n[## Comments ]\n[ ]\n[See also: ]\n[ ]\n[- [[text:formats/org]] ]\n[- [[cli:apps/nb]] ]\n[ ]\n[## Tags ]\n[ ]\n\n[save] · last: 2021-01-01 01:00:00\n```\n\nFor more information, see\n[`browse edit`](#browse-edit) and [Browsing](#-browsing).\n\n#### Viewing\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#show\"><code>nb show</code></a>,\n <a href=\"#browse\"><code>nb browse</code></a>,\n <a href=\"#open\"><code>nb open</code></a>,\n <a href=\"#peek\"><code>nb peek</code></a>\n </sup>\n</p>\n\nNotes and other items can be viewed using\n[`nb show`](#show) (shortcut: [`nb s`](#show)):\n\n```bash\n# show note by id\nnb show 3\n\n# show note by filename\nnb show example.md\n\n# show note by title\nnb show \"A Document Title\"\n\n# show note by id, alternative\nnb 3 show\n\n# show note 12 in the notebook named \"example\"\nnb show example:12\n\n# show note 12 in the notebook named \"example\", alternative\nnb example:12 show\n\n# show note 12 in the notebook named \"example\", alternative\nnb example:show 12\n```\n\nBy default, [`nb show`](#show) opens notes in\n[`less`](https://linux.die.net/man/1/less),\nwith syntax highlighting if\n[`bat`](https://github.com/sharkdp/bat),\n[`highlight`](http://www.andre-simon.de/doku/highlight/en/highlight.php),\nor\n[Pygments](https://pygments.org/)\nis installed.\nYou can navigate in `less` using the following keys:\n\n```text\nKey Function\n--- --------\nmouse scroll Scroll up or down\narrow up or down Scroll one line up or down\nf Jump forward one window\nb Jump back one window\nd Jump down one half window\nu Jump up one half window\n/<query> Search for <query>\nn Jump to next <query> match\nq Quit\n```\n\n*If `less` scrolling isn't working in [iTerm2](https://www.iterm2.com/),\ngo to*\n\"Settings\"\n-> \"Advanced\"\n-> \"Scroll wheel sends arrow keys when in alternate screen mode\"\n*and change it to* \"Yes\".\n*[More Info](https://stackoverflow.com/a/37610820)*\n\nUse the [`-p`](#show) / [`--print`](#show) option\nto print to standard output with syntax highlighting:\n\n```bash\n❯ nb show 123 --print\n# Example Title\n\nExample content:\n\n- one\n- two\n- three\n```\n\nUse [`nb show --print --no-color`](#show) to print without syntax highlighting.\n\nWhen [Pandoc](https://pandoc.org/) is available,\nuse the [`-r`](#show) / [`--render`](#show) option to\nrender the note to HTML and open it in your terminal browser:\n\n```bash\nnb show example.md --render\n# opens example.md as an HTML page in w3m, links, or lynx\n```\n\n[`nb show`](#show) also supports previewing other file types in the terminal,\ndepending on the tools available in the environment. To prefer specific tools\nfor certain file types, `nb` provides configuration variables that can be\nset in your `~/.nbrc` file,\nwhich can be opened in your editor with [`nb settings edit`](#settings).\n\nSupported file types and tools include:\n\n- Markdown files ([`$NB_MARKDOWN_TOOL`](#nb_markdown_tool)):\n - [`bat`](https://github.com/sharkdp/bat)\n - [`glow`](https://github.com/charmbracelet/glow)\n - [`lowdown`](https://kristaps.bsd.lv/lowdown)\n - [`mdcat`](https://github.com/swsnr/mdcat)\n - [`mdless`](https://github.com/ttscoff/mdless)\n - [`mdv`](https://github.com/axiros/terminal_markdown_viewer)\n- PDF files:\n - [`termpdf.py`](https://github.com/dsanson/termpdf.py)\n with [kitty](https://sw.kovidgoyal.net/kitty/)\n - [`pdftotext`](https://en.wikipedia.org/wiki/Pdftotext)\n- Audio files ([`$NB_AUDIO_TOOL`](#nb_audio_tool)):\n - [`mplayer`](https://en.wikipedia.org/wiki/MPlayer)\n - [`afplay`](https://ss64.com/osx/afplay.html)\n - [`mpg123`](https://en.wikipedia.org/wiki/Mpg123)\n - [`ffplay`](https://ffmpeg.org/ffplay.html)\n- [Images](#-images) ([`$NB_IMAGE_TOOL`](#nb_image_tool)):\n - [`catimg`](https://github.com/posva/catimg)\n - [Chafa](https://github.com/hpjansson/chafa)\n - [ImageMagick](https://imagemagick.org/) with a terminal that\n supports [sixels](https://en.wikipedia.org/wiki/Sixel)\n - [`imgcat`](https://www.iterm2.com/documentation-images.html) with\n [iTerm2](https://www.iterm2.com/)\n - [kitty's `icat` kitten](https://sw.kovidgoyal.net/kitty/kittens/icat.html)\n - [`termvisage`](https://github.com/AnonymouX47/termvisage)\n - [`timg`](https://github.com/hzeller/timg)\n - [`viu`](https://github.com/atanunq/viu)\n- Folders, Directories, Notebooks ([`$NB_DIRECTORY_TOOL`](#nb_directory_tool)):\n - [`eza`](https://github.com/eza-community/eza)\n - [`joshuto`](https://github.com/kamiyaa/joshuto)\n - [`lsd`](https://github.com/lsd-rs/lsd)\n - [Midnight Commander (`mc`)](https://en.wikipedia.org/wiki/Midnight_Commander)\n - [`ranger`](https://ranger.github.io/)\n - [`vifm`](https://vifm.info/)\n- Word Documents:\n - [Pandoc](https://pandoc.org/) with\n [`w3m`](https://en.wikipedia.org/wiki/W3m) or\n [`links`](https://en.wikipedia.org/wiki/Links_(web_browser))\n- Excel, CSV, TSV, and data files ([`$NB_DATA_TOOL`](#nb_data_tool)):\n - [VisiData](https://www.visidata.org/)\n - [`sc-im`](https://github.com/andmarti1424/sc-im)\n - [Tidy-Viewer (`tv`)](https://github.com/alexhallam/tv)\n- EPUB ebooks:\n - [Pandoc](https://pandoc.org/) with\n [`w3m`](https://en.wikipedia.org/wiki/W3m) or\n [`links`](https://en.wikipedia.org/wiki/Links_(web_browser))\n\nWhen using [`nb show`](#show) with other file types or\nif the above tools are not available,\n[`nb show`](#show) opens files in\nyour system's preferred application for each type.\n\n[`nb show`](#show) also provides [options](#show) for\nquerying information about an item. For example, use the\n[`--added`](#show) / [`-a`](#show) and [`--updated`](#show) / [`-u`](#show)\nflags to print the date and time that an item was added or updated:\n\n```bash\n❯ nb show 2 --added\n2020-01-01 01:01:00 -0700\n\n❯ nb show 2 --updated\n2020-02-02 02:02:00 -0700\n```\n\n[`nb show`](#show) is primarily intended for viewing items within the terminal.\nTo view a file in the system's preferred GUI application, use\n[`nb open`](#open).\nTo [browse](#-browsing) rendered items in terminal and GUI web browsers, use\n[`nb browse`](#browse).\n\nFor full [`nb show`](#show) usage information, run [`nb help show`](#show).\n\n##### Shortcut Alias: `nb s`\n\n[`nb show`](#show) can be called using the shortcut alias [`nb s`](#show):\n\n```bash\n# show note by id\nnb s 3\n\n# show note by filename\nnb s example.md\n\n# show note by title\nnb s \"A Document Title\"\n\n# show note by id, alternative\nnb 3 s\n\n# show note 12 in the notebook named \"example\"\nnb s example:12\n\n# show note 12 in the notebook named \"example\", alternative\nnb example:12 s\n\n# show note 12 in the notebook named \"example\", alternative\nnb example:s 12\n```\n\n##### Alias: `nb view`\n\n[`nb show`](#show) can also be invoked with [`nb view`](#show) for convenience:\n\n```bash\n# show note by id\nnb view 3\n\n# show note by filename\nnb view example.md\n\n# show note by title\nnb view \"A Document Title\"\n\n# show note by id, alternative\nnb 3 view\n```\n\n##### Viewing with `browse`\n\nItems can be viewed within terminal and GUI web browsers using\n[`nb browse`](#browse) / [`nb b`](#browse):\n\n```bash\n❯ nb browse text:formats/markdown/123\n❯nb · text : formats / markdown / 123 · ↓ · edit | +\nDaring Fireball: Markdown (daringfireball.net)\n\nhttps://daringfireball.net/projects/markdown/\n\nRelated\n\n • https://en.wikipedia.org/wiki/Markdown\n\nComments\n\nSee also:\n\n • [[text:formats/org]]\n • [[cli:apps/nb]]\n\nTags\n\n#markup #plain-text\n\nContent\n\nDaring Fireball: Markdown\n\nDownload\n\nMarkdown 1.0.1 (18 KB) — 17 Dec 2004\n\nIntroduction\n\nMarkdown is a text-to-HTML conversion tool for web writers. Markdown allows\nyou to write using an easy-to-read, easy-to-write plain text format, then\nconvert it to structurally valid XHTML (or HTML).\n```\n\nFor more information, see [Browsing](#-browsing).\n\n#### Deleting\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#delete\"><code>nb delete</code></a>,\n <a href=\"#browse\"><code>nb browse delete</code></a>\n </sup>\n</p>\n\nTo delete one or more notes, pass any number of\nids, filenames, titles, and other [selectors](#-selectors)\nto [`nb delete`](#delete) (shortcuts: [`nb d`](#delete), [`nb -`](#delete)):\n\n```bash\n# delete item by id\nnb delete 3\n\n# delete item by filename\nnb delete example.md\n\n# delete item by title\nnb delete \"A Document Title\"\n\n# delete item by id, alternative\nnb 3 delete\n\n# delete item 12 in the notebook named \"example\"\nnb delete example:12\n\n# delete item 12 in the notebook named \"example\", alternative\nnb example:12 delete\n\n# delete item 12 in the notebook named \"example\", alternative\nnb example:delete 12\n\n# delete item 345 in the folder named \"example\"\nnb delete example/345\n\n# delete items with the ids 89, 56, and 21\nnb delete 89 56 21\n```\n\nBy default, [`nb delete`](#delete) will display a confirmation prompt.\nTo skip, use the [`--force`](#delete) / [`-f`](#delete) option:\n\n```bash\nnb delete 3 --force\n```\n\n##### Shortcut Aliases: `nb d`, `nb -`\n\n[`nb delete`](#delete) has the aliases [`nb d`](#delete) and [`nb -`](#delete):\n\n```bash\n# delete note by id\nnb d 3\n\n# delete note by filename\nnb d example.md\n\n# delete note by title\nnb - \"A Document Title\"\n\n# delete note by id, alternative\nnb 3 d\n\n# delete note 12 in the notebook named \"example\"\nnb - example:12\n\n# delete note 12 in the notebook named \"example\", alternative\nnb example:12 d\n\n# delete note 12 in the notebook named \"example\", alternative\nnb example:d 12\n```\n\nFor [`nb delete`](#delete) help information, run [`nb help delete`](#delete).\n\n##### Deleting with `nb browse`\n\nItems can be deleted within terminal and GUI web browsers using\n[`nb browse delete`](#browse) / [`nb b d`](#browse):\n\n```bash\n❯ nb browse delete example:4\n❯nb · example : 4 · ↓ · edit · - | +\n\n deleting\n\n[4] example_file.md \"Example Title\"\n\n [delete]\n\n```\n\nFor more information, see [Browsing](#-browsing).\n\n### 🔖 Bookmarks\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#nb-help\"><code>nb <url></code></a>,\n <a href=\"#browse\"><code>nb browse</code></a>,\n <a href=\"#bookmark\"><code>nb bookmark</code></a>,\n <a href=\"#open\"><code>nb open</code></a>,\n <a href=\"#peek\"><code>nb peek</code></a>,\n <a href=\"#show\"><code>nb show</code></a>\n </sup>\n</p>\n\n`nb` includes a bookmarking system to conveniently\ncreate, annotate, view, search, [browse](#-browsing), and manage\ncollections of bookmarks.\n\n<div align=\"center\">\n <img src=\"https://xwmx.github.io/misc/nb/images/nb-bookmarks-gui-gui-terminal.png\"\n alt=\"nb bookmarks\"\n width=\"450\">\n</div>\n\nBookmarks in `nb` are stored as\n[simple structured Markdown files](#nb-markdown-bookmark-file-format)\ncontaining information extracted from the bookmarked pages.\n\nTo create a new bookmark, pass a URL as the first argument to `nb`:\n\n```bash\nnb https://example.com\n```\n\n`nb` automatically generates a bookmark using information from the page:\n\n```markdown\n# Example Title (example.com)\n\n<https://example.com>\n\n## Description\n\nExample description.\n\n## Content\n\nExample Title\n=============\n\nThis domain is for use in illustrative examples in documents. You may\nuse this domain in literature without prior coordination or asking for\npermission.\n\n[More information\\...](https://www.iana.org/domains/example)\n```\n\n`nb` embeds the page content in the bookmark, making it available for\n[full text search](#-search) with [`nb search`](#search) and\nlocally-served, distraction-free [reading and browsing](#-browsing)\nwith [`nb browse`](#browse).\nWhen [Pandoc](https://pandoc.org/) is installed,\nthe HTML page content is converted to Markdown.\nWhen [readability-cli](https://gitlab.com/gardenappl/readability-cli)\nis installed, markup is cleaned up to focus on content. When\n[Chromium](https://www.chromium.org) or\n[Chrome](https://www.google.com/chrome/) is installed on the system,\n`nb` automatically renders JavaScript-dependent pages\nand saves the resulting markup.\n\nMany shells automatically escape special characters in URLs. If a\nURL contains characters that are preventing it from being saved in full,\nURLs can also be enclosed in quotes when passed to `nb`:\n\n```bash\nnb \"https://example.com#sample-anchor\"\n```\n\nIn addition to caching the page content,\nyou can also include a quote from the page in a\n[`## Quote`](#-quote) section\nusing the\n[`-q <quote>`](#bookmark) / [`--quote <quote>`](#bookmark) option:\n\n```bash\nnb https://example.com --quote \"Example quote line one.\n\nExample quote line two.\"\n```\n```markdown\n# Example Title (example.com)\n\n<https://example.com>\n\n## Description\n\nExample description.\n\n## Quote\n\n> Example quote line one.\n>\n> Example quote line two.\n\n## Content\n\nExample Title\n=============\n\nThis domain is for use in illustrative examples in documents. You may\nuse this domain in literature without prior coordination or asking for\npermission.\n\n[More information\\...](https://www.iana.org/domains/example)\n```\n\nAdd a comment in a [`## Comment`](#-comment) section using the\n[`-c <comment>`](#bookmark) / [`--comment <comment>`](#bookmark) option:\n\n```bash\nnb https://example.com --comment \"Example comment.\"\n```\n```markdown\n# Example Title (example.com)\n\n<https://example.com>\n\n## Description\n\nExample description.\n\n## Comment\n\nExample comment.\n\n## Content\n\nExample Title\n=============\n\nThis domain is for use in illustrative examples in documents. You may\nuse this domain in literature without prior coordination or asking for\npermission.\n\n[More information\\...](https://www.iana.org/domains/example)\n```\n\nAdd related URLs and [linked](#-linking) [selectors](#-selectors)\nto a [`## Related`](#-related) section using the\n[`-r (<url> | <selector>)`](#bookmark) /\n[`--related (<url> | <selector>)`](#bookmark)\noption:\n\n```bash\nnb https://example.com --related example:123 -r https://example.net\n```\n```markdown\n# Example Title (example.com)\n\n<https://example.com>\n\n## Description\n\nExample description.\n\n## Related\n\n- [[example:123]]\n- <https://example.net>\n\n## Content\n\nExample Title\n=============\n\nThis domain is for use in illustrative examples in documents. You may\nuse this domain in literature without prior coordination or asking for\npermission.\n\n[More information\\...](https://www.iana.org/domains/example)\n```\n\nBookmarks can be tagged using the\n[`-t <tag1>,<tag2>...`](#bookmark) /\n[`--tags <tag1>,<tag2>...`](#bookmark) option.\nTags are converted into [#hashtags](#-tagging) and\nadded to a [`## Tags`](#-tags) section:\n\n```bash\nnb https://example.com --tags tag1,tag2\n```\n```markdown\n# Example Title (example.com)\n\n<https://example.com>\n\n## Description\n\nExample description.\n\n## Tags\n\n#tag1 #tag2\n\n## Content\n\nExample Title\n=============\n\nThis domain is for use in illustrative examples in documents. You may\nuse this domain in literature without prior coordination or asking for\npermission.\n\n[More information\\...](https://www.iana.org/domains/example)\n```\n\n[Search](#-search) for tagged bookmarks with\n[`nb search`](#search) / [`nb q`](#search):\n\n```bash\nnb search --tag tag1\n\nnb q -t tag1\n\nnb q \\#tag1\n```\n\n[`nb search`](#search) / [`nb q`](#search)\nautomatically searches archived page content:\n\n```bash\n❯ nb q \"example query\"\n[10] 🔖 example.bookmark.md \"Example Bookmark (example.com)\"\n------------------------------------------------------------\n5:Lorem ipsum example query.\n```\n\nBookmarks can also be encrypted:\n\n```bash\n# create a new password-protected, encrypted bookmark\nnb https://example.com --encrypt\n```\n\nEncrypted bookmarks require a password before they can be viewed or\nopened.\n\nMultiple URLs can be bookmarked with a single command by passing\nmultiple [`<url>`](#bookmark) arguments. Additional arguments will be reused\nfor each bookmark:\n\n```bash\n❯ nb https://example.com https://example.net --tags tag1,tag2 --filename example\nAdded: [1] 🔖 example.bookmark.md \"Example Domain (example.com)\"\nAdded: [2] 🔖 example-1.bookmark.md \"Example Domain (example.net)\"\n```\n\n#### Listing and Filtering Bookmarks\n\n<div align=\"center\">\n <img src=\"https://xwmx.github.io/misc/nb/images/nb-bookmarks-gui-terminal-terminal.png\"\n alt=\"nb bookmark lists\"\n width=\"500\">\n</div>\n\nBookmarks are included in\n`nb`,\n[`nb ls`](#ls),\n[`nb list`](#list),\nand [`nb browse`](#browse)\nalong with items of other types.\n[`nb bookmark`](#bookmark) and [`nb bookmark list`](#bookmark) can be used to\nlist and filter only bookmarks:\n\n```bash\n❯ nb bookmark\nAdd: nb <url> Help: nb help bookmark\n------------------------------------\n[3] 🔖 🔒 example.bookmark.md.enc\n[2] 🔖 Bookmark Two (example.com)\n[1] 🔖 Bookmark One (example.com)\n\n❯ nb bookmark list two\n[2] 🔖 Bookmark Two (example.com)\n```\n\nBookmarks are also included in `nb`, [`nb ls`](#ls), and [`nb list`](#list):\n\n```bash\n❯ nb\nhome\n----\n[7] 🔖 Bookmark Three (example.com)\n[6] Example Note\n[5] 🔖 Bookmark Two (example.net)\n[4] Sample Note\n[3] 🔖 🔒 example-encrypted.bookmark.md.enc\n[2] Demo Note\n[1] 🔖 Bookmark One (example.com)\n```\n\nUse the [`--type <type>`](#ls) / [`--<type>`](#ls)\noption as a filter to display only bookmarks:\n\n```bash\n❯ nb --type bookmark\n[7] 🔖 Bookmark Three (example.com)\n[5] 🔖 Bookmark Two (example.net)\n[3] 🔖 🔒 example-encrypted.bookmark.md.enc\n[1] 🔖 Bookmark One (example.com)\n\n❯ nb --bookmark\n[7] 🔖 Bookmark Three (example.com)\n[5] 🔖 Bookmark Two (example.net)\n[3] 🔖 🔒 example-encrypted.bookmark.md.enc\n[1] 🔖 Bookmark One (example.com)\n```\n\n`nb` saves the domain in the title, making it easy to filter by domain\nusing any list subcommands:\n\n```bash\n❯ nb example.com\n[7] 🔖 Bookmark Three (example.com)\n[1] 🔖 Bookmark One (example.com)\n```\n\nFor more listing options, see\n[`nb help ls`](#ls),\n[`nb help list`](#list),\nand [`nb help bookmark`](#bookmark).\n\n##### Shortcut Aliases: `nb bk`, `nb bm`\n\n[`nb bookmark`](#bookmark) can also be used with the aliases\n[`nb bk`](#bookmark) and [`nb bm`](#bookmark):\n\n```bash\n❯ nb bk\nAdd: nb <url> Help: nb help bookmark\n------------------------------------\n[7] 🔖 Bookmark Three (example.com)\n[5] 🔖 Bookmark Two (example.net)\n[3] 🔖 🔒 example-encrypted.bookmark.md.enc\n[1] 🔖 Bookmark One (example.com)\n\n❯ nb bm example.net\n[5] 🔖 Bookmark Two (example.net)\n```\n\n#### Viewing Bookmarks\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#browse\"><code>nb browse</code></a>,\n <a href=\"#open\"><code>nb open</code></a>,\n <a href=\"#peek\"><code>nb peek</code></a>,\n <a href=\"#show\"><code>nb show</code></a>\n </sup>\n</p>\n\n`nb` provides multiple ways to view bookmark files, bookmarked content,\nand bookmarked URLs.\n\nUse [`nb browse`](#browse) (shortcut: [`nb b`](#browse))\nto [browse](#-browsing) bookmarks with cached content,\n<a href=\"#-linking\">[[wiki-style links]]</a>,\nlinked [#tags](#-tagging), and external links:\n\n```bash\n❯ nb browse text:formats/markdown/123\n❯nb · text : formats / markdown / 123 · ↓ · edit | +\nDaring Fireball: Markdown (daringfireball.net)\n\nhttps://daringfireball.net/projects/markdown/\n\nRelated\n\n • https://en.wikipedia.org/wiki/Markdown\n\nComments\n\nSee also:\n\n • [[text:formats/org]]\n • [[cli:apps/nb]]\n\nTags\n\n#markup #plain-text\n\nContent\n\nDaring Fireball: Markdown\n\nDownload\n\nMarkdown 1.0.1 (18 KB) — 17 Dec 2004\n\nIntroduction\n\nMarkdown is a text-to-HTML conversion tool for web writers. Markdown allows\nyou to write using an easy-to-read, easy-to-write plain text format, then\nconvert it to structurally valid XHTML (or HTML).\n```\n\nFor more information, see [Browsing](#-browsing).\n\n[`nb open`](#open) (shortcut: [`nb o`](#open)) opens the bookmarked URL in\nyour system's primary web browser:\n\n```bash\n# open bookmark by id\nnb open 3\n\n# open bookmark 12 in the notebook named \"example\"\nnb open example:12\n\n# open bookmark 12 in the notebook named \"example\", alternative\nnb example:12 open\n\n# open bookmark 12 in the notebook named \"example\", alternative\nnb example:open 12\n```\n\n*N.B. To use [`nb open`](#open) with\n[WSL](https://docs.microsoft.com/en-us/windows/wsl/install),\ninstall [wslu](https://github.com/wslutilities/wslu).*\n\n[`nb peek`](#peek) (shortcut: [`nb p`](#peek), alias: [`nb preview`](#peek))\nopens the bookmarked URL in your terminal web browser,\nsuch as\n[w3m](https://en.wikipedia.org/wiki/W3m),\n[Links](https://en.wikipedia.org/wiki/Links_(web_browser)), or\n[Lynx](https://en.wikipedia.org/wiki/Lynx_(web_browser)):\n\n```bash\n# peek bookmark by id\nnb peek 3\n\n# peek bookmark 12 in the notebook named \"example\"\nnb peek example:12\n\n# peek bookmark 12 in the notebook named \"example\", alternative\nnb example:12 peek\n\n# peek bookmark 12 in the notebook named \"example\", alternative\nnb example:peek 12\n```\n\n[`nb open`](#open) and [`nb peek`](#peek)\nwork seamlessly with encrypted bookmarks.\n`nb` simply prompts you for the bookmark's password.\n\n[`nb open`](#open) and [`nb peek`](#peek)\nautomatically check whether the URL is still valid.\nIf the page has been removed, `nb` can check\nthe [Internet Archive Wayback Machine](https://archive.org/web/)\nfor an archived copy.\n\nThe preferred terminal web browser can be set using\nthe `$BROWSER` environment variable,\nassigned in `~/.bashrc`, `~/.zshrc`, or similar:\n\n```bash\nexport BROWSER=lynx\n```\n\nWhen `$BROWSER` is not set, `nb` looks for\n[`w3m`](https://en.wikipedia.org/wiki/W3m),\n[`links`](https://en.wikipedia.org/wiki/Links_(web_browser)), and\n[`lynx`](https://en.wikipedia.org/wiki/Lynx_(web_browser))\nand uses the first one it finds.\n\n`$BROWSER` can also be used to easy specify the terminal browser for\nan individual command:\n\n```bash\n❯ BROWSER=links nb 12 peek\n# opens the URL from bookmark 12 in links\n\n❯ BROWSER=w3m nb 12 peek\n# opens the URL from bookmark 12 in w3m\n```\n\n[`nb show`](#show) and [`nb edit`](#edit)\ncan also be used to view and edit bookmark files,\nwhich include the cached page converted to Markdown.\n\n[`nb show <id> --render`](#show) / [`nb show <id> -r`](#show)\ndisplays the bookmark file converted to HTML in the terminal web browser,\nincluding all bookmark fields and the cached page content,\nproviding a cleaned-up, distraction-free, locally-served view of\nthe page content along with all of your notes.\n\n##### Shortcut Aliases: `nb o` and `nb p`\n\n[`nb open`](#open) and [`nb peek`](#peek)\ncan also be used with the shortcut aliases\n[`nb o`](#open) and [`nb p`](#peek):\n\n```bash\n# open bookmark by id\nnb o 3\n\n# open bookmark 12 in the notebook named \"example\"\nnb o example:12\n\n# open bookmark 12 in the notebook named \"example\", alternative\nnb example:12 o\n\n# peek bookmark by id\nnb p 3\n\n# peek bookmark 12 in the notebook named \"example\"\nnb p example:12\n\n# peek bookmark 12 in the notebook named \"example\", alternative\nnb example:12 p\n```\n\n#### Bookmark File Format\n\nBookmarks are identified by a `.bookmark.md` file extension.\nThe bookmark URL is the first URL in the file within `<` and `>` characters.\nTo create a minimally valid bookmark file with [`nb add`](#add):\n\n```bash\nnb add example.bookmark.md --content \"<https://example.com>\"\n```\n\nFor a full overview, see\n[`nb` Markdown Bookmark File Format](#nb-markdown-bookmark-file-format).\n\n#### `bookmark` -- A command line tool for managing bookmarks.\n\n`nb` includes [`bookmark`](#bookmark-help), a full-featured\ncommand line interface for creating, viewing, searching, and editing bookmarks.\n\n[`bookmark`](#bookmark-help) is a shortcut for the\n[`nb bookmark`](#bookmark) subcommand,\naccepting all of the same subcommands and options with identical behavior.\n\nBookmark a page:\n\n```bash\n❯ bookmark https://example.com --tags tag1,tag2\nAdded: [3] 🔖 20200101000000.bookmark.md \"Example Title (example.com)\"\n```\nList and filter bookmarks with\n[`bookmark`](#bookmark) and [`bookmark list`](#bookmark):\n\n```bash\n❯ bookmark\nAdd: bookmark <url> Help: bookmark help\n---------------------------------------\n[3] 🔖 🔒 example.bookmark.md.enc\n[2] 🔖 Example Two (example.com)\n[1] 🔖 Example One (example.com)\n\n❯ bookmark list two\n[2] 🔖 Example Two (example.com)\n```\n\nView a bookmark in your terminal web browser:\n\n```bash\nbookmark peek 2\n```\n\nOpen a bookmark in your system's primary web browser:\n\n```bash\nbookmark open 2\n```\n\nPerform a full text search of bookmarks and archived page content:\n\n```bash\n❯ bookmark search \"example query\"\n[10] 🔖 example.bookmark.md \"Example Bookmark (example.com)\"\n------------------------------------------------------------\n5:Lorem ipsum example query.\n```\n\nSee [`bookmark help`](#bookmark-help) for more information.\n\n### ✅ Todos\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#do\"><code>nb do</code></a>,\n <a href=\"#tasks\"><code>nb tasks</code></a>,\n <a href=\"#todo\"><code>nb todo</code></a>,\n <a href=\"#undo\"><code>nb undo</code></a>\n </sup>\n</p>\n\nUse [`nb todo`](#todo) (shortcut: [`nb to`](#todo))\nto create, list, and update todos.\n`nb` todos are [structured Markdown documents](#nb-markdown-todo-file-format)\nreferencing a single primary todo,\nwith optional [tasks](#%EF%B8%8F-tasks).\n\nUse [`nb todo add`](#todo) to create a new todo:\n\n```bash\n# create a new todo titled \"Example todo one.\"\n❯ nb todo add \"Example todo one.\"\nAdded: [1] ✔️ [ ] Example todo one.\n\n❯ nb show 1 --print\n# [ ] Example todo one.\n```\n\nUse the [`--due <date>`](#todo) option to add an optional due date in a\n[`## Due`](#-due) section:\n\n```bash\n# create a new todo titled \"Example todo two.\" with a due date of \"2100-01-01\"\n❯ nb todo add \"Example todo two.\" --due \"2100-01-01\"\nAdded: [2] ✔️ [ ] Example todo two.\n\n❯ nb show 2 --print\n# [ ] Example todo two.\n\n## Due\n\n2100-01-01\n```\n\nAdd an optional [description](#-description-1) with the\n[`--description <description>`](#todo)\noption:\n\n```bash\n❯ nb todo add \"Example todo three.\" --description \"Example description.\"\nAdded: [3] ✔️ [ ] Example todo three.\n\n❯ nb show 3 --print\n# [ ] Example todo three.\n\n## Description\n\nExample description.\n```\n\nTodos can have [tasks](#%EF%B8%8F-tasks).\nTasks added with one or more [`--task <task>`](#todo) options\nare represented as a markdown task list and placed in a\n[`## Tasks`](#-tasks) section:\n\n```bash\n❯ nb todo add \"Example todo seven.\" --task \"Task one.\" --task \"Task two.\" --task \"Task three.\"\nAdded: [7] ✔️ [ ] Example todo seven.\n\n❯ nb show 7 --print\n# [ ] Example todo seven.\n\n## Tasks\n\n- [ ] Task one.\n- [ ] Task two.\n- [ ] Task three.\n```\n\nRelated URLs and [linked](#-linking) [selectors](#-selectors)\ncan be added to a [`## Related`](#-related-1) field using the\n[`-r (<url> | <selector>)`](#todo) / [`--related (<url> | <selector>)`](#todo)\noption:\n\n```bash\n❯ nb todo add \"Example todo four.\" --related example:123 -r https://example.com\nAdded: [4] ✔️ [ ] Example todo four.\n\n❯ nb show 4 --print\n# [ ] Example todo four.\n\n## Related\n\n- [[example:123]]\n- <https://example.com>\n```\n\n[Tags](#-tagging) can be added to todos with the\n[`--tags <tag1>,<tag2>...`](#todo) option:\n\n```bash\n❯ nb todo add \"Example todo five.\" --tags tag1,tag2\nAdded: [5] ✔️ [ ] Example todo five.\n\n❯ nb show 5 --print\n# [ ] Example todo five.\n\n## Tags\n\n#tag1 #tag2\n```\n\n[Tags](#-tagging), [links](#-linking), and URLs can be\n[browsed](#-browsing)\nin terminal and GUI web browsers with [`nb browse`](#browse).\n\n#### Listing Todos\n\nList todos in with [`nb todos`](#todo):\n\n```bash\n# list todos in the current notebook\n❯ nb todos\n[6] ✔️ [ ] Example todo six.\n[5] ✅ [x] Example todo five.\n[4] ✔️ [ ] Example todo four.\n[3] ✅ [x] Example todo three.\n[2] ✅ [x] Example todo two.\n[1] ✔️ [ ] Example todo one.\n\n# list todos in the notebook named \"sample\"\n❯ nb todos sample:\n[sample:4] ✅ [x] Sample todo four.\n[sample:3] ✔️ [ ] Sample todo three.\n[sample:2] ✔️ [ ] Sample todo two.\n[sample:1] ✅ [x] Sample todo one.\n\n```\n\nOpen / undone todos can be listed with [`nb todos open`](#todo):\n\n```bash\n# list open todos in the current notebook\n❯ nb todos open\n[6] ✔️ [ ] Example todo six.\n[4] ✔️ [ ] Example todo four.\n[1] ✔️ [ ] Example todo one.\n\n# list open todos in the notebook named \"sample\"\n❯ nb tasks open sample:\n[sample:3] ✔️ [ ] Sample todo three.\n[sample:2] ✔️ [ ] Sample todo two.\n```\n\nClosed / done todos can be listed with [`nb todos closed`](#todo):\n\n```bash\n# list closed todos in the current notebook\n❯ nb todos closed\n[5] ✅ [x] Example todo five.\n[3] ✅ [x] Example todo three.\n[2] ✅ [x] Example todo two.\n\n# list closed todos in the notebook named \"sample\"\n❯ nb tasks closed sample:\n[sample:4] ✅ [x] Sample todo four.\n[sample:1] ✅ [x] Sample todo one.\n```\n\nSee\n[`nb help todo`](#todo)\nfor more information.\n\n#### `do` / `undo`\n\nMark a todo as done or closed with [`nb do`](#do):\n\n```bash\n# add a new todo titled \"Example todo six.\"\n❯ nb todo add \"Example todo six.\"\nAdded: [6] ✔️ [ ] Example todo six.\n\n# mark todo 6 as done / closed\n❯ nb do 6\nDone: [6] ✅ [x] Example todo six.\n```\n\nRe-open a closed todo with [`nb undo`](#undo):\n\n```bash\n# mark todo 6 as undone / open\n❯ nb undo 6\nUndone: [6] ✔️ [ ] Example todo six.\n```\n\nSee\n[`nb help do`](#do)\nand\n[`nb help undo`](#undo)\nfor more information.\n\n### ✔️ Tasks\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#do\"><code>nb do</code></a>,\n <a href=\"#tasks\"><code>nb tasks</code></a>,\n <a href=\"#todo\"><code>nb todo</code></a>,\n <a href=\"#undo\"><code>nb undo</code></a>\n </sup>\n</p>\n\n`nb` can list and update tasks in [todos](#-todos) and other Markdown documents.\n\nTasks are defined as one or more Markdown list items starting with\n`- [ ]` to indicate an open task or `- [x]` to indicate a done / closed task:\n\n```markdown\n- [ ] Example open task.\n- [x] Example closed task.\n```\n\nList tasks in items, folders, and notebooks with\n[`nb tasks`](#tasks) (shortcut: [`nb t`](#tasks)),\nwhich lists both tasks and todos:\n\n```bash\n# list tasks in item 7\n❯ nb tasks 7\n[7] ✔️ [ ] Example todo seven.\n------------------------------\n[7 1] [x] Task one.\n[7 2] [x] Task two.\n[7 3] [ ] Task three.\n\n# list tasks and todos in the notebook named \"example\"\n❯ nb tasks example:\n[example:9] ✔️ [ ] Example todo nine.\n[example:8] ✅ [x] Example todo eight.\n--------------------------------------\n[example:8 1] [x] Task one.\n[example:8 2] [x] Task two.\n\n[example:6] ✔️ [ ] Example todo six.\n[example:4] Example Note Title\n------------------------------\n[example:4 1] [ ] Task one.\n[example:4 2] [x] Task two.\n[example:4 3] [ ] Task three.\n\n[example:3] ✔️ [ ] Example todo three.\n```\n\nOpen / undone tasks can be listed with [`nb tasks open`](#tasks):\n\n```bash\n# list open tasks in item 7\n❯ nb tasks open 7\n[7] ✔️ [ ] Example todo seven.\n------------------------------\n[7 3] [ ] Task three.\n\n# list open tasks and todos in the notebook named \"example\"\n❯ nb tasks open example:\n[example:9] ✔️ [ ] Example todo nine.\n[example:6] ✔️ [ ] Example todo six.\n[example:4] Example Note Title\n------------------------------\n[example:4 1] [ ] Task one.\n[example:4 3] [ ] Task three.\n\n[example:3] ✔️ [ ] Example todo three.\n```\n\nClosed / done tasks can be listed with [`nb tasks closed`](#tasks):\n\n```bash\n# list closed tasks in item 7\n❯ nb tasks closed 7\n[7] ✔️ [ ] Example todo seven.\n------------------------------\n[7 1] [x] Task one.\n[7 2] [x] Task two.\n\n# list closed tasks and todos in the notebook named \"example\"\n❯ nb tasks closed example:\n[example:8] ✅ [x] Example todo eight.\n--------------------------------------\n[example:8 1] [x] Task one.\n[example:8 2] [x] Task two.\n\n[example:4] Example Note Title\n------------------------------\n[example:4 2] [x] Task two.\n```\n\nTasks are identified by the item [selector](#-selectors), followed by\na space, then followed by the sequential number of the task in the file.\n\nUse [`nb do`](#do) to mark tasks as done / closed:\n\n```bash\n# list tasks in item 9\n❯ nb tasks 9\n[9] ✔️ [ ] Example todo nine.\n-----------------------------\n[9 1] [ ] Task one.\n[9 2] [ ] Task two.\n[9 3] [ ] Task three.\n\n# mark task 2 in item 9 as done / closed\n❯ nb do 9 2\n[9] ✔️ [ ] Example todo nine.\n-----------------------------\nDone: [9 2] [x] Task two.\n\n# list tasks in item 9\n❯ nb tasks 9\n[9] ✔️ [ ] Example todo nine.\n-----------------------------\n[9 1] [ ] Task one.\n[9 2] [x] Task two.\n[9 3] [ ] Task three.\n```\n\nUndo a done / closed task with [`nb undo`](#undo):\n\n```bash\n# mark task 2 in item 9 as undone / open\n❯ nb undo 9 2\n[9] ✔️ [ ] Example todo nine.\n-----------------------------\nUndone: [9 2] [ ] Task two.\n\n# list tasks in item 9\n❯ nb tasks 9\n[9] ✔️ [ ] Example todo nine.\n-----------------------------\n[9 1] [ ] Task one.\n[9 2] [ ] Task two.\n[9 3] [ ] Task three.\n```\n\nSee\n[`nb help tasks`](#tasks)\nfor more information.\n\n### 🏷 #tagging\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#add\"><code>nb add</code></a>,\n <a href=\"#bookmark\"><code>nb bookmark</code></a>,\n <a href=\"#browse\"><code>nb browse</code></a>,\n <a href=\"#list\"><code>nb list</code></a>,\n <a href=\"#ls\"><code>nb ls</code></a>,\n <a href=\"#search\"><code>nb search</code></a>\n </sup>\n</p>\n\nTagging is a flexible and powerful way to organize, filter, and discover your\nnotes, bookmarks, and todos in `nb`.\n\nTags in `nb` are written as `#hashtags`\nand can be placed anywhere within a document. A hashtag is defined as a `#`\ncharacter followed by any number of letters, numbers, underscores, or dashes,\nallowing you to create custom categories or keywords tailored to your workflow.\n\nTagging lets you group related items, quickly search for topics, set up ad hoc\ncollections, and create multi-dimensional taxonomies that complement notebooks\nand folders.\n\nTags can be added when creating or editing items, or embedded\ndirectly in your note content.\n\n#### Nested Tagging\n\nIn addition to standard hashtags, `nb` supports hierarchical tags using\nslashes, such as `#project/design/ui`. This enables an organizational structure\nwhere tags can represent parent-child relationships. For example, tagging a\nnote with `#topic/subtopic/detail` lets you group related notes at different\nlevels of specificity.\n\nWhen searching for tags, nested tags are matched by prefix:\n- Searching for `#project` matches notes tagged with `#project`,\n `#project/design`, and `#project/design/ui`.\n- Searching for `#project/design` matches `#project/design` and any deeper\n descendants like `#project/design/ui`.\n- Searching for an exact nested tag like `#project/design/ui` matches only\n that tag.\n- Searching for a branch that doesn't exist, such as `#project/ui` when only\n `#project/design/ui` exists, will match nothing.\n\nThis makes it easy to filter, organize, and browse notes and bookmarks using\neither broad or specific tag queries.\n\n#### Adding Tags\n\nNotes and bookmarks can be tagged when they are created using the\n`--tags <tag1>,<tag2>...` option,\nwhich is available with\n[`nb add`](#add),\n[`nb <url>`](#nb-help),\n[`nb browse add`](#browse),\n[`nb bookmark`](#bookmark),\nand\n[`nb todo`](#todo).\n`--tags` takes a comma-separated list of tags, converts them to\n`#hashtags`,\nand adds them to the document.\n\nTags added to notes with [`nb add --tags`](#add) are placed between the title\nand body text:\n\n```bash\n❯ nb add --title \"Example Title\" \"Example note content.\" --tags tag1,tag2\n```\n\n```markdown\n# Example Title\n\n#tag1 #tag2\n\nExample note content.\n```\n\nTags added to [bookmarks](#bookmarks) with\n[`nb <url> --tags`](#nb-help) and [`nb bookmark <url> --tags`](#bookmark)\nare placed in a [`## Tags`](#-tags) section:\n\n```bash\n❯ nb https://example.com --tags tag1,tag2\n```\n\n```markdown\n# Example Title (example.com)\n\n<https://example.com>\n\n## Description\n\nExample description.\n\n## Tags\n\n#tag1 #tag2\n\n## Content\n\nExample Title\n=============\n\nThis domain is for use in illustrative examples in documents. You may\nuse this domain in literature without prior coordination or asking for\npermission.\n\n[More information\\...](https://www.iana.org/domains/example)\n```\n\nTags added to [todos](#-todos) with\n[`nb todo add --tags`](#todo)\nare placed in a [`## Tags`](#-tags-1) section:\n\n```bash\n❯ nb todo add --tags tag1,tag2 \"Example todo.\"\n```\n\n```markdown\n# [ ] Example todo.\n\n## Tags\n\n#tag1 #tag2\n```\n\n#### Listing and Searching Tags\n\nUse [`nb --tags`](#nb-help), [`nb ls --tags`](#ls),\nand [`nb list --tags`](#list)\nto list the tags present in a notebook, folder, or item:\n\n```bash\n# list all tags found in items in the current notebook\nnb --tags\n\n# list all tags found in the folder named \"example\"\nnb example/ --tags\n\n# list all tags in the item with id 123 in the notebook named \"sample\"\nnb sample:123 --tags\n```\n\nList tagged items by passing `\\#escaped` or `\"#quoted\"` hashtags or tags\nspecified with the [`--tags`](#ls) option to [`nb`](#ls) / [`nb ls`](#ls):\n\n```bash\n# list items in the current notebook tagged with \"#tag1\", escaped\nnb \\#tag1\n\n# list items in the \"example\" notebook tagged with \"#tag2\", quoted\nnb example: \"#tag2\"\n\n# list items in all notebooks tagged with \"#tag3\", long option\nnb --tags tag3 --all\n\n# list items in all notebooks tagged with \"#tag3\", short option\nnb --tags tag3 -a\n```\n\nCombine multiple tags to search for items containing all specified tags:\n\n```bash\n# list items in the current notebook tagged with \"#tag1\" AND \"#tag2\"\nnb \\#tag1 \"#tag2\"\n\n# list items in the current notebook tagged with \"#tag2\" AND \"#tag3\"\nnb --tags tag2,tag3\n\n# list items in all notebooks tagged with \"#tag1\" AND \"#tag2\" AND \"#tag3\" AND \"#tag4\"\nnb \\#tag1 \"#tag2\" --tags tag3,tag4 --all\n```\n\nTagged items can be [searched](#-search) with\n[`nb search`](#search) / [`nb q`](#search):\n\n```bash\n# search for items tagged with \"#tag1\"\nnb search --tag tag1\n\n# search for items tagged with \"#tag1\", shortcut and short option\nnb q -t tag1\n\n# search for items tagged with \"#tag1\", shortcut and argument\nnb q \\#tag1\n\n# search for items tagged with \"#tag1\", shortcut and argument, alternative\nnb q \"#tag1\"\n\n# search for items tagged with \"#tag1\" AND \"#tag2\"\nnb q --tag tag1 --tag tag2\n\n# search for items tagged with \"#tag1\" AND \"#tag2\", short options\nnb q -t tag1 -t tag2\n\n# search for items tagged with \"#tag1\" AND \"#tag2\", arguments\nnb q \\#tag1 \\#tag2\n\n# search for items tagged with \"#tag1\" AND \"#tag2\", tag list\nnb q --tags tag1,tag2\n\n# search for items tagged with either \"#tag1\" OR \"#tag2\", options\nnb q -t tag1 --or -t tag2\n\n# search for items tagged with either \"#tag1\" OR \"#tag2\", arguments\nnb q \\#tag1 --or \\#tag2\n\n# search for items tagged with either \"#tag1\" OR \"#tag2\", single argument\nnb q \"#tag1|#tag2\"\n\n# search for items tagged with \"#tag1\" AND \"#tag2\" AND \"#tag3\"\nnb q -t tag1 --tags tag2,tag3\n\n# search for items tagged with \"#tag1\" OR \"#tag2\" OR \"#tag3\"\nnb q -t tag1 --or --tags tag2,tag3\n\n# search for items tagged with \"#tag1\" OR \"#tag2\" OR \"#tag3\"\nnb q \\#tag1 --or -t tag2 --or \"#tag3\"\n```\n\n#### Browsing Tags\n\nLinked tags can be [browsed](#-browsing) with [`nb browse`](#browse),\nproviding another dimension of browsability in terminal and GUI web browsers,\ncomplimenting <a href=\"#-linking\">[[wiki-style linking]]</a>.\n\nTags in notes,\nbookmarks,\nfiles in text-based formats,\nWord `.docx` documents,\nand [Open Document](https://en.wikipedia.org/wiki/OpenDocument) `.odt` files\nare rendered as links to the list of items in the notebook sharing that tag:\n\n```bash\n❯nb · example : 321\n\nExample Title\n\n#tag1 #tag2\n\nExample content with link to [[Sample Title]].\n\nMore example content:\n\n- one\n- two\n- three\n```\n\nUse the [`-t <tag>`](#browse) / [`--tag <tag>`](#browse) option\nto open [`nb browse`](#browse) to the list of\nall items in the current notebook or a specified notebook or folder that\nshare a tag:\n\n```bash\n# open to a list of items tagged with \"#tag2\" in the \"example\" notebook\n❯ nb browse example: --tag tag2\n❯nb · example\n\nsearch: [#tag2 ]\n\n[example:321] Example Title\n[example:654] Sample Title\n[example:789] Demo Title\n\n# shortcut alias and short option\n❯ nb b example: -t tag2\n❯nb · example\n\nsearch: [#tag2 ]\n\n[example:321] Example Title\n[example:654] Sample Title\n[example:789] Demo Title\n```\n\nFor more information about full-text search, see\n[Search](#-search) and [`nb search`](#search).\nFor more information about browsing, see\n[Browsing](#-browsing) and [`nb browse`](#browse).\n\n### 🔗 Linking\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#browse\"><code>nb browse</code></a>\n </sup>\n</p>\n\nNotes,\nbookmarks,\nfiles in text-based formats,\nWord `.docx` documents,\nand [Open Document](https://en.wikipedia.org/wiki/OpenDocument) `.odt` files\ncan reference other items using\n<a href=\"#-linking\">[[wiki-style links]]</a>,\nmaking `nb` a powerful terminal-first platform for\n[Zettelkasten](#-zettelkasten),\nwiki-style knowledge mapping,\nand other link-based note-taking methods.\n\nTo add a link from a note or bookmark to another in the same notebook,\ninclude the id, title, or relative path for the target item\nwithin double square brackets anywhere in the linking document:\n\n```bash\n# link to the item with id 123 in the root level of current notebook\n[[123]]\n\n# link to the item titled \"Example Title\" in the root level of the current notebook\n[[Example Title]]\n\n# link to the item with id 456 in the folder named \"Sample Folder\"\n[[Sample Folder/456]]\n\n# link to the item titled \"Demo Title\" in the folder named \"Sample Folder\"\n[[Sample Folder/Demo Title]]\n```\n\nTo link to an item in another notebook,\nadd the notebook name with a colon before the identifier:\n\n```bash\n# link to the item with id 123 in the \"sample\" folder in the \"example\" notebook\n[[example:sample/123]]\n\n# link to the item titled \"Example Title\" in the \"demo\" notebook\n[[demo:Example Title]]\n\n# link to the item with filename \"Example File.md\" in the \"sample\" notebook\n[[sample:Example File.md]]\n```\n\nThe text for a link can be specified after a pipe `|` character:\n\n```bash\n# render link to item 123 in the \"example\" notebook as [[Example Link Text]]\n[[example:123|Example Link Text]]\n```\n\n<a href=\"#-linking\">[[wiki-style links]]</a> cooperate well with\n[Org links](https://orgmode.org/guide/Hyperlinks.html),\nwhich have a similar syntax,\nproviding a convenient option for linking collections of Org files.\n\nLinked items can be [browsed](#-browsing) with [`nb browse`](#browse).\n\nFor more information about identifying items, see [Selectors](#-selectors).\n\n### 🌍 Browsing\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#browse\"><code>nb browse</code></a>\n </sup>\n</p>\n\nUse [`nb browse`](#browse) (shortcut: [`nb b`](#browse)) to\nbrowse, view, edit, and search linked notes, bookmarks, notebooks, folders,\nand other items using terminal and GUI web browsers.\n\n<div align=\"center\">\n <img src=\"https://xwmx.github.io/misc/nb/images/gui-gui-terminal-browse.png\"\n alt=\"nb browse\"\n width=\"500\">\n</div>\n\n[`nb browse`](#browse) includes an embedded, terminal-first web application\nthat renders\n<a href=\"#-linking\">[[wiki-style links]]</a>\nand\n[#hashtags](#-tagging)\nas internal links, enabling you to browse your notes and notebooks in web\nbrowsers, including seamlessly browsing to and from the offsite links in\nbookmarks and notes.\n\n```bash\n❯ nb browse\n❯nb · home : +\n\nsearch: [ ]\n\n[home:6]  📌 Example Markdown Title\n[home:12] 🔒 example-encrypted.md.enc\n[home:11] 🔖 Example Bookmark (example.com)\n[home:10] 🔖 🔒 example-encrypted.bookmark.md.enc\n[home:9]  Example .org Title\n[home:8]  🌄 example-image.png\n[home:7]  📄 example.pdf\n[home:5]  🔉 example-audio.mp3\n[home:4]  Example LaTeX Title\n[home:3]  📹 example-video.mp4\n[home:2]  example.md\n[home:1]  📂 Example Folder\n```\n\nLists are displayed using the same format as `nb` and [`nb ls`](#ls),\nincluding [pinned](#-pinning) items, with each list item linked.\nLists are automatically paginated to fit the height of the terminal window.\n\n```bash\n❯ nb browse example:sample/demo/\n❯nb · example : sample / demo / +\n\nsearch: [ ]\n\n[example:sample/demo/7] Title Seven\n[example:sample/demo/6] Title Six\n[example:sample/demo/5] Title Five\n[example:sample/demo/4] Title Four\n[example:sample/demo/3] Title Three\n\nnext ❯\n```\n\n[`nb browse`](#browse) is designed to make it easy to navigate within\nterminal web browsers using only keyboard commands,\nwhile also supporting mouse interactions.\nThe [`nb browse`](#browse) interface includes links\nto quickly jump to parent folders,\nthe current notebook,\nand other notebooks.\n\n[`nb browse`](#browse) opens in\n[w3m](https://en.wikipedia.org/wiki/W3m),\n[Links](https://en.wikipedia.org/wiki/Links_\\(web_browser\\)),\nor in the browser set in the `$BROWSER` environment variable.\nUse [`nb browse --gui`](#browse) / [`nb b -g`](#browse) to\nopen in the system's primary [GUI web browser](#browse---gui).\n\nTo open a specific item in [`nb browse`](#browse),\npass the [selector](#-selectors) for the item, folder, or notebook\nto [`nb browse`](#browse):\n\n```bash\n# open the item with id 42 in the folder named \"sample\" in the \"example\" notebook\n❯ nb browse example:sample/42\n❯nb · example : sample / 42 · ↓ · edit | +\n\nExample Title\n\n#tag1 #tag2\n\nExample content with link to [[Demo Title]].\n\nMore example content:\n\n • one\n • two\n • three\n```\n\nItems can also be browsed with\n[`nb show --browse`](#show) / [`nb s -b`](#show),\nwhich behaves identically.\n\n[`nb browse`](#browse) is particularly useful for [bookmarks](#-bookmarks).\nCached content is rendered in the web browser along with comments and notes.\nInternal and external links are easily accessible directly in the terminal,\nproviding a convenient, distraction-free approach for browsing collections\nof bookmarks.\n\n```bash\n❯ nb browse text:formats/markdown/123\n❯nb · text : formats / markdown / 123 · ↓ · edit | +\nDaring Fireball: Markdown (daringfireball.net)\n\nhttps://daringfireball.net/projects/markdown/\n\nRelated\n\n • https://en.wikipedia.org/wiki/Markdown\n\nComments\n\nSee also:\n\n • [[text:formats/org]]\n • [[cli:apps/nb]]\n\nTags\n\n#markup #plain-text\n\nContent\n\nDaring Fireball: Markdown\n\nDownload\n\nMarkdown 1.0.1 (18 KB) — 17 Dec 2004\n\nIntroduction\n\nMarkdown is a text-to-HTML conversion tool for web writers. Markdown allows\nyou to write using an easy-to-read, easy-to-write plain text format, then\nconvert it to structurally valid XHTML (or HTML).\n```\n\nNotes, bookmarks, files in text-based formats, source code,\nWord `.docx` documents, and\n[Open Document](https://en.wikipedia.org/wiki/OpenDocument) `.odt`\nfiles are converted into HTML and rendered in the browser. Use the down\narrow (`↓`) link to view or download the original file.\n\n[MathJax](https://www.mathjax.org/) support can be enabled by setting\nthe [`$NB_MATHJAX_ENABLED`](https://github.com/xwmx/nb#nb_mathjax_enabled)\nvariable in your `~/.nbrc` file:\n\n```bash\nexport NB_MATHJAX_ENABLED=1\n```\n\nWith this variable set, `nb` will automatically download and install MathJax\nfrom [GitHub](https://github.com/mathjax/MathJax) and enable it when items\nare viewed in [`nb browse --gui`](#browse).\n\n#### `browse edit`\n\n<div align=\"center\">\n <img src=\"https://xwmx.github.io/misc/nb/images/gui-terminal-browse-edit.png\"\n alt=\"nb browse edit\"\n width=\"500\">\n</div>\n\nItems in text formats can be edited within terminal and GUI web browsers using\nthe `edit` link on the item page or by opening the item with\n[`nb browse edit`](#browse) / [`nb b e`](#browse),\nwhich automatically resizes the form to fit the current terminal window:\n\n```bash\n❯ nb browse edit text:formats/markdown/123\n❯nb · text : formats / markdown / 123 · ↓ · editing · - | +\n\n[# Daring Fireball: Markdown (daringfireball.net) ]\n[ ]\n[<https://daringfireball.net/projects/markdown/> ]\n[ ]\n[## Related ]\n[ ]\n[- <https://en.wikipedia.org/wiki/Markdown> ]\n[ ]\n[## Comments ]\n[ ]\n[See also: ]\n[ ]\n[- [[text:formats/org]] ]\n[- [[cli:apps/nb]] ]\n[ ]\n[## Tags ]\n[ ]\n\n[save] · last: 2021-01-01 01:00:00\n```\n\nTerminal web browsers provide different editing workflows.\n[`w3m`](https://en.wikipedia.org/wiki/W3m) opens items in your `$EDITOR`,\nthen returns you back to the browser to save changes and continue browsing.\nEdits in [`links`](https://en.wikipedia.org/wiki/Links_(web_browser))\nare performed directly in the browser.\n\nSyntax highlighting, block selection, and other\n[advanced editor features](#browse---gui-editing)\nare available with [`nb browse --gui`](#browse).\n\n#### `browse add`\n\nAdd an item within the browser using the `+` link or\n[`nb browse add`](#browse) / [`nb b a`](#browse).\nPass a notebook, folder, and / or filename selector to create a new note\nin that location:\n\n```bash\n❯ nb browse add text:formats/\n❯nb · text : formats / +\n\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n\n[add]\n```\n\n[`nb browse add`](#browse) includes options for quickly pre-populating\nnew notes with content:\n\n```bash\n❯ nb browse add --title \"Example Title\" --content \"Example content.\" --tags tag1,tag2\n❯nb · home : +\n\n[# Example Title ]\n[ ]\n[#tag1 #tag2 ]\n[ ]\n[Example content. ]\n[ ]\n[ ]\n[ ]\n[ ]\n[ ]\n\n[add]\n```\n\n#### `browse delete`\n\nUse the `-` link on the [`nb browse edit`](#browse) page or\n[`nb browse delete`](#browse) / [`nb b d`](#browse)\nto delete an item:\n\n```bash\n❯ nb browse delete example:4\n❯nb · example : 4 · ↓ · edit · - | +\n\n deleting\n\n[4] example_file.md \"Example Title\"\n\n [delete]\n\n```\n\n#### `browse` Search\n\n[`nb browse`](#browse) includes a search field powered by\n[`nb search`](#search)\nthat can be used to search the current notebook or folder.\nSearch queries are treated as command line arguments for\n[`nb search`](#search),\nproviding the ability to perform `AND` and `OR` queries.\nUse the\n[`-q <query>`](#browse) / [`--query <query>`](#browse)\noption to open [`nb browse`](#browse) to\nthe results page for a search:\n\n```bash\n# open to a list of items containing \"example\" in the current notebook\n❯ nb browse --query \"example\"\n❯nb · home\n\nsearch: [example ]\n\n[home:321] Test Title\n[home:654] Sample Title\n[home:789] Demo Title\n\n# using shortcut alias and short option\n❯ nb b -q \"example\"\n❯nb · home\n\nsearch: [example ]\n\n[home:321] Test Title\n[home:654] Sample Title\n[home:789] Demo Title\n```\n\nSearch for [#tags](#-tagging) with the\n[`-t`](#browse) / [`--tag`](#browse) / [`--tags`](#browse) options:\n\n```bash\n# open to a list of items tagged with \"#tag2\" in the current notebook\n❯ nb browse --tag tag2\n❯nb · home\n\nsearch: [#tag2 ]\n\n[home:654] Sample Title\n[home:789] Demo Title\n\n# using shortcut alias and short option\n❯ nb b -t tag2\n❯nb · home\n\nsearch: [#tag2 ]\n\n[home:654] Sample Title\n[home:789] Demo Title\n```\n\nFor more information about search options, see [Search](#-search) and\n[`nb search`](#search).\n\n#### `browse --gui`\n\nTo open any [`nb browse`](#browse) view in\nthe system's primary GUI web browser,\nadd the [`nb browse --gui`](#browse) / [`nb b -g`](#browse) option:\n\n```bash\n# open the item with id 123 in the \"sample\" notebook in the system's primary GUI browser\nnb browse sample:123 --gui\n\n# open the folder named \"example\" in the system's primary GUI browser,\n# short option\nnb browse example/ -g\n\n# open the current notebook in the system's primary GUI browser,\n# shortcut alias and short option\nnb b -g\n```\n\n##### `browse --gui` Editing\n\nBy default,\n[`nb browse --gui`](#browse)\nuses the browser's default `<textarea>` for editing items.\n\n[Ace](https://ace.c9.io/) is a text editor for GUI web browsers\nthat provides advanced text editing functionality,\nincluding block selection and\n[syntax highlighting](#gui-web-syntax-highlighting).\n\nTo use Ace as the editor for [`nb browse --gui`](#browse),\nadd the following line to set the\n[`$NB_ACE_ENABLED`](https://github.com/xwmx/nb#nb_ace_enabled)\nvariable in your `~/.nbrc` file:\n\n```bash\nexport NB_ACE_ENABLED=1\n```\n\nThe next time a form is loaded in [`nb browse`](#browse),\n`nb` will automatically download\n(from [GitHub](https://github.com/ajaxorg/ace-builds/)),\ninstall,\nand enable the Ace editor in\n[`nb browse edit --gui`](#browse) and [`nb browse add --gui`](#browse).\n\n#### `browse` Portability\n\n[`nb browse`](#browse) depends on\neither [`socat`](https://www.kali.org/tools/socat/)\nor\n[`ncat`](https://nmap.org/ncat/) (available as part of\nthe `ncat` or `nmap` package in most package managers) and\n[`pandoc`](https://pandoc.org/). When neither `socat` nor `ncat` is\navailable and the Bash version is 5.2 or higher, [`nb browse`](#browse)\nfalls back to a pure Bash implementation that supports all features\nexcept the Ace editor. When only `pandoc` is available,\nthe current note is rendered and\n<a href=\"#-linking\">[[wiki-style links]]</a>\ngo to unrendered, original files.\nWhen `socat`,`ncat`, or Bash 5.2+ is available without `pandoc`,\nfiles in plain text formats are rendered with the original markup unconverted.\nIf neither `ncat`, `socat`, Bash 5.2+, nor `pandoc` is available,\n[`nb browse`](#browse) falls back to the default behavior of [`nb show`](#show).\n\nWhen `nb` is installed on Windows,\n`socat` ([MSYS](https://packages.msys2.org/package/socat),\n[Cygwin](https://cygwin.com/packages/summary/socat.html)) is recommended.\n\n#### `browse` Privacy\n\n[`nb browse`](#browse) is completely local and self-contained within `nb`,\nfrom the CSS and JavaScript\nall the way down through the HTTP request parsing and response building,\nwith no imports, libraries, frameworks, or third-party code\noutside of the few binary dependencies\n(`bash`, `git`, `ncat` / `socat`, `pandoc`),\nthe Linux / Unix environment,\nand the optional [Ace editor](#ace-editor).\n\nTerminal web browsers don't use JavaScript, so visits from them are not\nvisible to some web analytics tools.\n[`nb browse`](#browse) includes a number of additional features\nto enhance privacy and avoid leaking information:\n\n- Page content is cached locally within each bookmark file,\n making it readable in terminal and GUI web browsers\n without requesting the page again or needing to be connected to the internet.\n- `<img>` tags in bookmarked content are removed to avoid requests.\n- Outbound links are automatically rewritten to use an\n [exit page redirect](https://geekthis.net/post/hide-http-referer-headers/#exit-page-redirect)\n to mitigate leaking information via the\n [referer header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer).\n- All pages include the `<meta name=\"referrer\" content=\"no-referrer\" />` tag.\n- Links include a `rel=\"noopener noreferrer\"` attribute.\n- `lynx` is opened with the `-noreferer` option.\n\n#### `browse` AsciiDoc\n\nTo [`browse`](#browse) items in [AsciiDoc](https://asciidoc.org/) format,\ninstall [`asciidoctor`](https://asciidoctor.org/).\n\n#### Shortcut Alias: `nb b`\n\n[`nb browse`](#browse) can also be used with the alias [`nb b`](#browse):\n\n```bash\n# open the current notebook in the terminal web browser\nnb b\n\n# open the item with id 123 in the \"example\" notebook using the terminal web browser\nnb b example:123\n\n# open the notebook named \"sample\" in the GUI web browser\nnb b sample: -g\n```\n\nFor more information, see [`nb browse`](#browse).\n\n### 🌄 Images\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#browse\"><code>nb browse</code></a>,\n <a href=\"#import\"><code>nb import</code></a>,\n <a href=\"#open\"><code>nb open</code></a>,\n <a href=\"#show\"><code>nb show</code></a>\n </sup>\n</p>\n\n`nb` can be used to view, organize, browse, reference, and work with images in\nterminals,\nweb browsers,\nand GUI applications.\n\n#### Image Items\n\n[Import](#%EF%B8%8F-import--export) images with [`nb import`](#import):\n\n```bash\n# import the image file \"example.png\" into the current notebook\nnb import example.png\n\n# import an image file from a URL into the current notebook\nnb import https://raw.githubusercontent.com/xwmx/nb/master/docs/images/nb.png\n\n# nb import \"sample.jpg\" into the \"demo\" folder in the \"example\" notebook\nnb import sample.jpg example:demo/\n```\n\nImported images are displayed with [`🌄` indicators](#indicators) in\n[lists](#listing--filtering):\n\n```bash\n❯ nb\nhome\n----\n[5] Example Five\n[4] 🌄 example-image.png\n[3] Example Three\n[2] Example Two\n[1] Example One\n```\n\nImported image items can be opened in the system GUI application for\nthe item's file type using [`nb open`](#open):\n\n```bash\n# open the image \"example-image.png\" in the system GUI photo viewer\nnb open example-image.png\n\n# open the image with id \"4\" in the system GUI photo viewer\nnb 4 o\n```\n\nImage items can be viewed in web browsers with [`nb browse`](#browse),\nproviding a convenient mechanism for\n[browsing](#-browsing) notebooks and folders containing image collections.\n\n[`nb browse`](#browse) renders image items within in an `<img>` tag\non the item page. Open the item page for an image item by passing a\n[selector](#-selectors) to [`nb browse`](#browse), optionally including the\n[`-g`](#browse) / [`--gui`](#browse) option\nto open the page in the system GUI web browser:\n\n```bash\n# open item with id \"123\" in the terminal web browser\nnb browse 123\n\n# open item with id \"456\" in the \"example\" notebook in the GUI web browser\nnb browse example:456 --gui\n\n# open item \"example:456\" in the GUI web browser, alternative\nnb example:456 b -g\n```\n\nThe original file can be viewed or downloaded from the item page\nby either clicking the image item or using the down arrow (`↓`) link.\n\n[`nb browse --gui`](#browse---gui) displays images in any GUI web browser.\nSome terminal web browsers, such as [`w3m`](http://w3m.sourceforge.net/),\ncan be configured to display images.\n\n[`nb show`](#show) can display images directly in the terminal with\nsupported tools and configurations, including:\n\n- [`catimg`](https://github.com/posva/catimg)\n- [Chafa](https://github.com/hpjansson/chafa)\n- [ImageMagick](https://imagemagick.org/) with a terminal that\n supports [sixels](https://en.wikipedia.org/wiki/Sixel)\n- [`imgcat`](https://www.iterm2.com/documentation-images.html) with\n [iTerm2](https://www.iterm2.com/)\n- [kitty's `icat` kitten](https://sw.kovidgoyal.net/kitty/kittens/icat.html)\n- [`termvisage`](https://github.com/AnonymouX47/termvisage)\n- [`timg`](https://github.com/hzeller/timg)\n- [`viu`](https://github.com/atanunq/viu)\n\nA preferred image viewer tool can be set with the\n[`$NB_IMAGE_TOOL`](#nb_image_tool) variable in your `~/.nbrc` file,\nwhich can be opened in your editor with [`nb settings edit`](#settings).\n\n#### Inline Images\n\nImages can be referenced and rendered inline within\nnotes, bookmarks, and other items.\n\nTo reference an image in the same notebook,\nspecify the image's relative path within the notebook:\n\n```markdown\n# reference \"example.jpg\" from markdown\n![](example.jpg)\n\n# reference \"demo.png\" in the \"sample\" folder from markdown\n![](sample/demo.png)\n```\n\nImages in any notebook can be referenced using the `--original` URL,\nobtainable from the image's [`nb browse`](#browse) item page\nby either clicking the image item or using the down arrow (`↓`) link.\n\n```markdown\n# reference \"example.jpg\" in the \"home\" notebook with the --original URL\n![](http://localhost:6789/--original/home/example.jpg)\n```\n\nImage references in content are rendered inline within web browsers with\n[`nb browse`](#browse) and [`nb show --render`](#show).\n\n`<img>` tags are stripped from bookmarked content when rendering to HTML.\nInline images can still be used in other bookmark sections like\n[`## Comment`](#-comment).\n\n### 🗂 Zettelkasten\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a>\n </sup>\n</p>\n\nZettelkasten (German: \"slip box\") is a method of note-taking and\npersonal knowledge management modeled around a few key features:\n\n- Notes are taken liberally on index cards.\n- Each note is numbered for easy reference.\n- Index cards are organized into boxes.\n- Index cards can reference other index cards.\n- Cards can include tags and other metadata.\n\nSince `nb` works directly on plain text files\norganized in normal system directories in normal git repositories,\n`nb` is a very close digital analogue to physical zettelkasten note-taking.\n\n| Zettelkasten | `nb` |\n|:-----------------:|:-----------------------------------------------:|\n| index cards | [notes](#-notes) & [bookmarks](#-bookmarks) |\n| numbering | ids & [selectors](#-selectors) |\n| slip boxes | [notebooks](#-notebooks) |\n| tags | [#tags](#-tagging) |\n| metadata | [front matter](#front-matter) |\n| cross-references | <a href=\"#-linking\">[[wiki-style links]]</a> |\n| fast note-taking | [`nb add`](#adding)/[`nb <url>`](#-bookmarks) |\n\nFor more information about Zettelkasten, see\n[Wikipedia](https://en.wikipedia.org/wiki/Zettelkasten).\n\n### 📂 Folders\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#add\"><code>nb add</code></a>,\n <a href=\"#browse\"><code>nb browse</code></a>,\n <a href=\"#folders\"><code>nb folders</code></a>,\n <a href=\"#list\"><code>nb list</code></a>,\n <a href=\"#ls\"><code>nb ls</code></a>\n </sup>\n</p>\n\nItems can be organized in folders.\nTo add a note to a folder,\ncall [`nb add`](#add) with the folder's relative path within the notebook\nfollowed by a slash:\n\n```bash\n# add a new note in the folder named \"example\"\nnb add example/\n\n# add a new note in the folder named \"demo\" in \"example\"\nnb add example/demo/\n```\n\n`nb` automatically creates any intermediate folders as needed.\n\nFolders can be created directly using [`nb add folder`](#add),\n[`nb folders add`](#folders), and [`nb add --type folder`](#add):\n\n```bash\n# create a new folder named \"sample\"\nnb add folder sample\n\n# create a new folder named \"sample\", alternative\nnb folders add sample\n\n# create a new folder named \"demo\"\nnb add demo --type folder\n\n# create a folder named \"example\" containing a folder named \"test\"\nnb add example/test --type folder\n```\n\nTo list the items in a folder, pass the folder relative path to\n`nb`,\n[`nb ls`](#ls),\n[`nb list`](#list),\nor [`nb browse`](#browse)\nwith a trailing slash:\n\n```bash\n❯ nb example/demo/\nhome\n----\n[example/demo/3] Title Three\n[example/demo/2] Title Two\n[example/demo/1] Title One\n```\n\nFolders can also be identified by the folder's id\nand listed with a trailing slash:\n\n```bash\n❯ nb list\n[1] 📂 example\n\n❯ nb list 1/\n[example/2] 📂 demo\n[example/1] document.md\n\n❯ nb list 1/2/\n[example/demo/3] Title Three\n[example/demo/2] Title Two\n[example/demo/1] Title One\n```\n\nItems in folders can be idenitified with\nthe folder's relative path using either folder ids or names,\nfollowed by the id, title, or filename of the item:\n\n```bash\n# list item 1 (\"Title One\", one.md) in the example/demo/ folder\nnb list example/demo/1\n\n# edit item 1 (\"Title One\", one.md) in the example/demo/ folder\nnb edit example/2/one.md\n\n# show item 1 (\"Title One\", one.md) in the example/demo/ folder\nnb show 1/2/Title\\ One\n\n# delete item 1 (\"Title One\", one.md) in the example/demo/ folder\nnb delete 1/demo/1\n```\n\nFor folders and items in other notebooks,\ncombine the relative path with the notebook name, separated by a colon:\n\n```bash\n# list the contents of the \"sample\" folder in the \"example\" notebook\nnb example:sample/\n\n# add an item to the \"sample/demo\" folder in the \"example\" notebook\nnb add example:sample/demo/\n\n# edit item 3 in the \"sample/demo\" folder in the \"example\" notebook\nnb edit example:sample/demo/3\n```\n\n[Browse](#-browsing) starting at any folder with [`nb browse`](#browse):\n\n```bash\n❯ nb browse example:sample/demo/\n❯nb · example : sample / demo /\n\nsearch: [ ]\n\n[example:sample/demo/5] Title Five\n[example:sample/demo/4] Title Four\n[example:sample/demo/3] Title Three\n[example:sample/demo/2] Title Two\n[example:sample/demo/1] Title One\n```\n\nFor more information about identifying folders, see [Selectors](#-selectors).\n\n### 📌 Pinning\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#pin\"><code>nb pin</code></a>,\n <a href=\"#unpin\"><code>nb unpin</code></a>,\n <a href=\"#ls\"><code>nb ls</code></a>,\n <a href=\"#browse\"><code>nb browse</code></a>\n </sup>\n</p>\n\nItems can be pinned so they appear first in\n`nb`, [`nb ls`](#ls), and [`nb browse`](#browse):\n\n```bash\n❯ nb\nhome\n----\n[2] 📌 Title Two\n[5] Title Five\n[4] Title Four\n[3] Title Three\n[1] Title One\n```\n\nUse [`nb pin`](#pin) and [`nb unpin`](#unpin) to pin and unpin items:\n\n```bash\n❯ nb\nhome\n----\n[5] Title Five\n[4] Title Four\n[3] Title Three\n[2] Title Two\n[1] Title One\n\n❯ nb pin 4\nPinned: [4] four.md \"Title Four\"\n\n❯ nb pin 1\nPinned: [1] one.md \"Title One\"\n\n❯ nb\nhome\n----\n[4] 📌 Title Four\n[1] 📌 Title One\n[5] Title Five\n[3] Title Three\n[2] Title Two\n\n❯ nb unpin 4\nUnpinned: [4] four.md \"Title Four\"\n\n❯ nb\nhome\n----\n[1] 📌 Title One\n[5] Title Five\n[4] Title Four\n[3] Title Three\n[2] Title Two\n```\n\n`nb` can also be configured to pin notes that contain\na specified [#hashtag](#-tagging) or other search pattern.\nTo enable tag / search-based pinning,\nset the [`$NB_PINNED_PATTERN`](#nb_pinned_pattern) environment variable to\nthe desired [#tag](#-tagging) or pattern.\n\nFor example, to treat all items tagged with `#pinned` as pinned items,\nadd the following line to your `~/.nbrc` file,\nwhich can be opened in your editor with [`nb settings edit`](#settings):\n\n```bash\nexport NB_PINNED_PATTERN=\"#pinned\"\n```\n\nAll [indicator icons](#indicators) in `nb` can be customized, so\nto use a different character as the pindicator,\nsimply add a line like the following to your `~/.nbrc` file:\n\n```bash\nexport NB_INDICATOR_PINNED=\"💖\"\n```\n\n```bash\n❯ nb\nhome\n----\n[1] 💖 Title One\n[5] Title Five\n[4] Title Four\n[3] Title Three\n[2] Title Two\n```\n\nTo bump an item to the top of the list without pinning, use the\n[`bump` plugin](#bump).\n\n### 🔍 Search\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#search\"><code>nb search</code></a>\n </sup>\n</p>\n\nUse [`nb search`](#search) (shortcut: [`nb q`](#search)) to\nperform full text searches, with support for regular expressions,\n[#tags](#-tagging), and `AND`, `OR`, and `NOT` queries:\n\n```bash\n# search current notebook for \"example query\"\nnb search \"example query\"\n\n# search the notebook \"example\" for \"example query\"\nnb search example: \"example query\"\n\n# search the folder named \"demo\" for \"example query\"\nnb search demo/ \"example query\"\n\n# search all unarchived notebooks for \"example query\" and list matching items\nnb search \"example query\" --all --list\n\n# search for \"example\" AND \"demo\" with multiple arguments\nnb search \"example\" \"demo\"\n\n# search for \"example\" AND \"demo\" with option\nnb search \"example\" --and \"demo\"\n\n# search for \"example\" OR \"sample\" with argument\nnb search \"example|sample\"\n\n# search for \"example\" OR \"sample\" with option\nnb search \"example\" --or \"sample\"\n\n# search for items matching both \"Example\" AND \"Sample\", and NOT \"Demo\"\nnb search \"Example\" --and \"Sample\" --not \"Demo\"\n\n# search items containing the hashtag \"#example\"\nnb search \"#example\"\n\n# search with a regular expression\nnb search \"\\d\\d\\d-\\d\\d\\d\\d\"\n\n# search bookmarks for \"example\"\nnb search \"example\" --type bookmark\n\n# search bookmarks for \"example\", alternative\nnb bk q \"example\"\n\n# search the current notebook for \"example query\"\nnb q \"example query\"\n\n# search the notebook named \"example\" for \"example query\"\nnb q example: \"example query\"\n\n# search all unarchived notebooks for \"example query\" and list matching items\nnb q -la \"example query\"\n```\n\n[`nb search`](#search) prints the id number, filename,\nand title of each matched file,\nfollowed by each search query match and its line number,\nwith color highlighting:\n\n```bash\n❯ nb search \"example\"\n[314] 🔖 example.bookmark.md \"Example Bookmark (example.com)\"\n--------------------------------------------------------------\n1:# Example Bookmark (example.com)\n\n3:<https://example.com>\n\n[2718] example.md \"Example Note\"\n--------------------------------\n1:# Example Note\n```\n\nTo just print the note information line without the content matches,\nuse the [`-l`](#search) or [`--list`](#search) option:\n\n```bash\n❯ nb search \"example\" --list\n[314] 🔖 example.bookmark.md \"Example Bookmark (example.com)\"\n[2718] example.md \"Example Note\"\n```\n\nMultiple query arguments are treated as `AND` queries,\nreturning items that match all queries.\n`AND` queries can also be specified with the\n[`--and <query>`](#search) option:\n\n```bash\n# search for items tagged with \"#example\" AND \"#demo\" AND \"#sample\" using\n# multiple arguments\nnb q \"#example\" \"#demo\" \"#sample\"\n\n# options\nnb q \"#example\" --and \"#demo\" --and \"#sample\"\n```\n\n`nb` matches `AND` query terms regardless of where they appear in a document,\nan improvement over most approaches for performing `AND` queries\nwith command line tools,\nwhich typically only match terms appearing on the same line.\n\n`OR` queries return items that match at least one of the queries\nand can be created by separating terms in a single argument\nwith a pipe character `|` or with the [`--or <query>`](#search) option:\n\n```bash\n# search for \"example\" OR \"sample\" with argument\nnb q \"example|sample\"\n\n# search for \"example\" OR \"sample\" with option\nnb q \"example\" --or \"sample\"\n```\n\n[`--or`](#search) and [`--and`](#search) queries can be used together:\n\n```bash\nnb q \"example\" --or \"sample\" --and \"demo\"\n# equivalent: example|sample AND demo|sample\n```\n\n`NOT` queries exclude items that match the specified query and are\nspecified with [`--not <query>`](#search), which can be used with\n`--and` and `--or`:\n\n```bash\n# search for items that match \"Example\", excluding items that also match \"Sample\"\nnb search \"Example\" --not \"Sample\"\n\n# search for items matching both \"Example\" AND \"Sample\", and NOT \"Demo\"\nnb search \"Example\" --and \"Sample\" --not \"Demo\"\n```\n\nSearch for [#tags](#-tagging) with flexible\n[`nb search --tags [<tags>]`](#search) / [`nb q -t [<tags>]`](#search) options:\n\n```bash\n# search for tags in the current notebook\nnb search --tags\n\n# search for tags in the \"sample\" notebook, shortcut alias\nnb sample:q --tags\n\n# search for items tagged with \"#tag1\"\nnb search --tag tag1\n\n# search for items tagged with \"#tag1\", shortcut alias and short option\nnb q -t tag1\n\n# search for items tagged with \"#tag1\", shortcut alias and argument\nnb q \\#tag1\n\n# search for items tagged with \"#tag1\", shortcut alias and argument, alternative\nnb q \"#tag1\"\n\n# search for items in the \"sample\" notebook tagged with \"#tag1\" AND \"#tag2\"\nnb sample:search --tag tag1 --tag tag2\n\n# search for items in the \"sample\" notebook tagged with \"#tag1\" AND \"#tag2\"\nnb sample:q --tags tag1,tag2\n\n# search for items in the current notebook tagged with \"#tag1\" AND \"#tag2\"\nnb q --tag tag1 --tag tag2\n\n# search for items in the current notebook tagged with \"#tag1\" OR \"#tag2\"\nnb q -t tag1 --or -t tag2\n\n# search for items tagged with \"#tag1\" AND \"#tag2\" AND \"#tag3\"\nnb q -t tag1 --tags tag2,tag3\n\n# search for items tagged with \"#tag1\" OR \"#tag2\" OR \"#tag3\"\nnb q -t tag1 --or --tags tag2,tag3\n\n# search for items tagged with \"#tag1\" OR \"#tag2\" OR \"#tag3\"\nnb q \\#tag1 --or -t tag2 --or \"#tag3\"\n```\n\n[`nb search`](#search) leverages Git's powerful built-in\n[`git grep`](https://git-scm.com/docs/git-grep).\n`nb` also supports performing searches with alternative search tools\nusing the [`--utility <name>`](#search) option.\n\nSupported alternative search tools:\n- [`rga`](https://github.com/phiresky/ripgrep-all)\n- [`rg`](https://github.com/BurntSushi/ripgrep)\n- [`ag`](https://github.com/ggreer/the_silver_searcher)\n- [`ack`](https://beyondgrep.com/)\n- [`grep`](https://en.wikipedia.org/wiki/Grep)\n\n##### Shortcut Alias: `nb q`\n\n[`nb search`](#search) can also be used with the alias\n[`nb q`](#search) (for \"query\"):\n\n```bash\n# search for \"example\" and print matching excerpts\nnb q \"example\"\n\n# search for \"example\" and list each matching file\nnb q -l \"example\"\n\n# search for \"example\" in all unarchived notebooks\nnb q -a \"example\"\n\n# search for \"example\" in the notbook named \"sample\"\nnb sample:q \"example\"\n```\n\nFor more information about search, see [`nb help search`](#search).\n\n##### Searching with `browse`\n\nSearches can be performed within terminal and GUI web browsers using\n[`nb browse --query`](#browse) / [`nb b -q`](#browse):\n\n```bash\n❯ nb browse --query \"#example\"\n❯nb · home : +\n\nsearch: [#example ]\n\n[home:7] Title Seven\n[home:32] Title Thirty-Two\n[home:56] Title Fifty-Six\n[home:135] Title One Hundred and Thirty-Five\n```\n\nFor more information, see [Browsing](#-browsing).\n\n### ↔ Moving & Renaming\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#move\"><code>nb move</code></a>,\n <a href=\"#copy\"><code>nb copy</code></a>\n </sup>\n</p>\n\nUse [`nb move`](#move) (alias: [`nb rename`](#move), shortcut: [`nb mv`](#move))\nto move and rename items:\n\n```bash\n# move \"example.md\" to \"sample.org\"\nnb move example.md sample.org\n\n# rename note 2 (\"example.md\") to \"New Name.md\"\nnb rename 2 \"New Name\"\n```\n\nItems can be moved between notebooks and folders:\n\n```bash\n# move note 12 from the \"example\" notebook into \"Sample Folder\" in the \"demo\" notebook\nnb move example:12 demo:Sample\\ Folder/\n```\n\nWhen the file extension is omitted, the existing extension is used:\n\n```bash\n# rename \"example.bookmark.md\" to \"New Name.bookmark.md\"\nnb move example.bookmark.md \"New Name\"\n```\n\nWhen only a file extension is specified, only the extension is updated:\n\n```bash\n# change the file extension of note 5 (\"demo file.md\") to .org (\"demo file.org\")\nnb rename 5 .org\n```\n\nUse [`nb rename --to-bookmark`](#move) to change the extension of a note\nto `.bookmark.md`,\n[`nb rename --to-todo`](#move) to change the extension to `.todo.md`,\nand [`nb rename --to-note`](#move) to change the extension\nof a bookmark or todo to either `.md` or the extension set with\n[`nb set default_extension`](#default_extension):\n\n```bash\n# rename note 3 (\"example.md\") to a bookmark named \"example.bookmark.md\"\nnb rename 3 --to-bookmark\n\n# rename bookmark 6 (\"sample.bookmark.md\") to a note named \"sample.md\"\nnb rename 6 --to-note\n\n# rename note 7 (\"demo.md\") to a todo named \"demo.todo.md\"\nnb rename 7 --to-todo\n```\n\nUse [`nb rename --to-title`](#move) to set the filename to the note title,\nlowercased with spaces and disallowed filename characters replaced\nwith underscores:\n\n```bash\n❯ nb rename 12 --to-title\nMoving: [12] 20210101010000.md \"Example Title\"\nTo: example_title.md\nProceed? [y/N]\n```\n\nCopy an item to a destination notebook, folder path, or filename\nwith [`nb copy`](#copy) (alias: [`nb duplicate`](#copy)):\n\n```bash\n# copy item 456 to \"sample.md\"\nnb copy 456 sample.md\n\n# copy item 678 to the \"example\" notebook\nnb copy 678 example:\n\n# copy item 789 to the \"demo\" folder\nnb copy 789 demo/\n\n# copy item 543 to test.md in the \"sample\" folder in the \"example\" notebook\nnb copy 543 example:sample/test.md\n```\n\nOmit a destination to copy the item in place:\n\n```bash\n# copy item 123 (\"example.md\") to example-1.md\n❯ nb copy 123\nAdded: [124] example-1.md\n\n# copy item 123 (\"example.md\") to example-2.md, alias\n❯ nb duplicate 123\nAdded: [125] example-2.md\n```\n\nFor more information about moving, renaming, and copying items, see\n[`nb help move`](#move) and [`nb help copy`](#copy).\n\n### 🗒 Revision History\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#history\"><code>nb history</code></a>,\n <a href=\"#notebooks\"><code>nb notebooks</code></a>\n </sup>\n</p>\n\nWhenever a note is added, modified, or deleted,\n`nb` automatically commits the change to git transparently in the background.\n\nUse [`nb history`](#history) to view the revision history of\nany notebook, folder, or item:\n\n```bash\n# show history for current notebook\nnb history\n\n# show history for note number 4\nnb history 4\n\n# show history for note with filename example.md\nnb history example.md\n\n# show history for note titled \"Example\"\nnb history Example\n\n# show history for the notebook named \"example\"\nnb example:history\n\n# show history for the notebook named \"example\", alternative\nnb history example:\n\n# show the history for note 12 in the notebook named \"example\"\nnb history example:12\n```\n\n[`nb history`](#history) uses `git log` by default and prefers\n[`tig`](https://github.com/jonas/tig) when available.\n\n#### Authorship\n\nBy default, git commits are attributed to the email and name configured in your\n[global `git` configuration](https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration).\n\nChange the email and name used for a notebook with\n[`nb notebooks author`](#notebooks):\n\n```bash\n# edit the commit author email and name for the current notebook\n❯ nb notebooks author\nCurrent configuration for: home\n--------------------------\nemail (global): example@example.test\nname (global): Example Name\n\nUpdate? [y/N]\n\n# edit the commit author email and name for the notebook named \"example\"\n❯ nb notebooks author example\nCurrent configuration for: example\n--------------------------\nemail (global): example@example.test\nname (global): Example Name\n\nUpdate? [y/N]\n```\n\nThe updated author email and name applies to subsequent commits.\n\nTo use a different email and name from the beginning of a notebook's\nhistory, create the new notebook using\n[`nb notebooks add --author`](#notebooks) or\n[`nb notebooks init --author`](#notebooks).\n\n### 📚 Notebooks\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#notebooks\"><code>nb notebooks</code></a>,\n <a href=\"#archive\"><code>nb archive</code></a>,\n <a href=\"#unarchive\"><code>nb unarchive</code></a>,\n <a href=\"#use\"><code>nb use</code></a>\n </sup>\n</p>\n\nYou can create additional notebooks, each of which has its own version history.\n\nCreate a new notebook with [`nb notebooks add`](#notebooks):\n\n```bash\n# add a notebook named example\nnb notebooks add example\n```\n\n`nb` and [`nb ls`](#ls) list the available notebooks above the list of notes:\n\n```bash\n❯ nb\nexample · home\n--------------\n[3] Title Three\n[2] Title Two\n[1] Title One\n```\n\nCommands in `nb` run within the current notebook, and identifiers\nsuch as ids, filenames, and titles refer to notes within the current notebook.\n`nb edit 3`, for example, tells `nb` to\n[`edit`](#edit) note with id `3` within the current notebook.\n\nTo switch to a different notebook, use [`nb use`](#use):\n\n```bash\n# switch to the notebook named \"example\"\nnb use example\n```\n\nIf you are in one notebook and you want\nto perform a command in a different notebook without switching to it,\nadd the notebook name with a colon before the command name:\n\n```bash\n# add a new note in the notebook \"example\"\nnb example:add\n\n# add a new note in the notebook \"example\", shortcut alias\nnb example:a\n\n# show note 5 in the notebook \"example\"\nnb example:show 5\n\n# show note 5 in the notebook \"example\", shortcut alias\nnb example:s 5\n\n# edit note 12 in the notebook \"example\"\nnb example:edit 12\n\n# edit note 12 in the notebook \"example\", shortcut alias\nnb example:e 12\n\n# search for \"example query\" in the notebook \"example\"\nnb example:search \"example query\"\n\n# search for \"example query\" in the notebook \"example\", shortcut alias\nnb example:q \"example query\"\n\n# show the revision history of the notebook \"example\"\nnb example:history\n```\n\nThe notebook name with colon can also be used as a modifier to\nthe id, filename, or title:\n\n```bash\n# edit note 12 in the notebook \"example\"\nnb edit example:12\n\n# edit note 12 in the notebook \"example\", shortcut alias\nnb e example:12\n\n# edit note 12 in the notebook \"example\", alternative\nnb example:12 edit\n\n# edit note 12 in the notebook \"example\", alternative, shortcut alias\nnb example:12 e\n\n# show note titled \"misc\" in the notebook \"example\"\nnb show example:misc\n\n# show note titled \"misc\" in the notebook \"example\", shortcut alias\nnb s example:misc\n\n# delete note with filename \"todos.md\" in the notebook \"example\", alternative\nnb example:todos.md delete\n\n# delete note with filename \"todos.md\" in the notebook \"example\", alternative,\n# shortcut alias\nnb example:todos.md d\n```\n\nWhen a notebook name with colon is called without a subcommand,\n`nb` runs [`nb ls`](#ls) in the specified notebook:\n\n```bash\n❯ nb example:\nexample · home\n--------------\n[example:3] Title Three\n[example:2] Title Two\n[example:1] Title One\n```\n\nA bookmark can be created in another notebook by specifying\nthe notebook name with colon, then a space, then the URL and bookmark options:\n\n```bash\n# create a new bookmark in a notebook named \"sample\"\n❯ nb sample: https://example.com --tags tag1,tag2\n```\n\nNotes can also be moved between notebooks:\n\n```bash\n# move note 3 from the current notebook to \"example\"\nnb move 3 example:\n\n# move note 5 in the notebook \"example\" to the notebook \"sample\"\nnb move example:5 sample:\n```\n\n##### Example Workflow\n\nThe flexibility of `nb`'s argument handling makes it easy to\nbuild commands step by step as items are listed, filtered, viewed, and edited,\nparticularly in combination with shell history:\n\n```bash\n# list items in the \"example\" notebook\n❯ nb example:\nexample · home\n--------------\n[example:3] Title Three\n[example:2] Title Two\n[example:1] Title One\n\n# filter list\n❯ nb example: three\n[example:3] Title Three\n\n# view item\n❯ nb example:3 show\n# opens item in `less`\n\n# edit item\n❯ nb example:3 edit\n# opens item in $EDITOR\n```\n\n##### Notebooks and Tab Completion\n\n[`nb` tab completion](#tab-completion) is optimized for\nfrequently running commands in various notebooks using the colon syntax,\nso installing the completion scripts is recommended\nand makes working with notebooks easy, fluid, and fun.\n\nFor example, listing the contents of a notebook is usually as simple as typing\nthe first two or three characters of the name,\nthen pressing the `<tab>` key,\nthen pressing `<enter>` / `<return>`:\n\n```bash\n❯ nb exa<tab>\n# completes to \"example:\"\n❯ nb example:\nexample · home\n--------------\n[example:3] Title Three\n[example:2] Title Two\n[example:1] Title One\n```\n\nScoped notebook commands are also available in tab completion:\n\n```bash\n❯ nb exa<tab>\n# completes to \"example:\"\n❯ nb example:hi<tab>\n# completes to \"example:history\"\n```\n\n#### Notebooks, Tags, and Taxonomy\n\n`nb` is optimized to work well with a collection of notebooks, so\nnotebooks are a good way to organize notes and bookmarks by top-level topic.\n\n[#tags](#-tagging) are searchable across notebooks and can be created ad hoc,\nmaking notebooks and tags distinct and complementary organizational systems\nin `nb`.\n\nSearch for a tag in or across notebooks with\n[`nb search`](#search) / [`nb q`](#search):\n\n```bash\n# search for #tag in the current notebook\nnb q --tag tag\n\n# search for #tag in all notebooks, short options\nnb q -t tag -a\n\n# search for #tag in the \"example\" notebook, argument\nnb q example: \"#tag\"\n```\n\n#### Global and Local Notebooks\n\n##### Global Notebooks\n\nBy default, all `nb` notebooks are global, making them\nalways accessible in the terminal regardless of the current working directory.\nGlobal notebooks are stored in the directory configured in\n[`nb set nb_dir`](#nb_dir),\nwhich is `~/.nb` by default.\n\n##### Local Notebooks\n\n`nb` also supports creating and working with local notebooks.\nLocal notebooks are notebooks that are\nanywhere on the system outside of [`$NB_DIR`](#nb_dir-1).\nAny folder can be an `nb` local notebook, which is just a normal folder\nthat has been initialized as a git repository and contains an `nb` .index file.\nInitializing a folder as an `nb` local notebook is a very easy way to\nadd structured git versioning to any folder of documents and other files.\n\nWhen `nb` runs within a local notebook,\nthe local notebook is set as the current notebook:\n\n```bash\n❯ nb\nlocal · example · home\n----------------------\n[3] Title Three\n[2] Title Two\n[1] Title One\n```\n\nA local notebook is always referred to by the name `local`\nand otherwise behaves just like a global notebook\nwhenever a command is run from within it:\n\n```bash\n# add a new note in the local notebook\nnb add\n\n# edit note 15 in the local notebook\nnb edit 15\n\n# move note titled \"Todos\" from the home notebook to the local notebook\nnb move home:Todos local:\n\n# move note 1 from the local notebook to the home notebook\nnb move 1 home:\n\n# search the local notebook for <query string>\nnb search \"query string\"\n\n# search the local notebook and all unarchived global notebooks for <query string>\nnb search \"query string\" --all\n```\n\nLocal notebooks can be created with [`nb notebooks init`](#notebooks):\n\n```bash\n# initialize the current directory as a notebook\nnb notebooks init\n\n# create a new notebook at ~/example\nnb notebooks init ~/example\n\n# clone an existing notebook to ~/example\nnb notebooks init ~/example https://github.com/example/example.git\n```\n\nLocal notebooks can also be created by exporting a global notebook:\n\n```bash\n# export global notebook named \"example\" to \"../path/to/destination\"\nnb notebooks export example ../path/to/destination\n\n# alternative\nnb export example ../path/to/destination\n```\n\nLocal notebooks can also be imported, making them global:\n\n```bash\n# import notebook or folder at \"../path/to/notebook\"\nnb notebooks import ../path/to/notebook\n\n# alternative\nnb import ../path/to/notebook\n```\n\n[`nb notebooks init`](#notebooks) and [`nb notebooks import`](#notebooks)\ncan be used together to easily turn any directory of existing files\ninto a global `nb` notebook:\n\n```bash\n❯ ls\nexample-directory\n\n❯ nb notebooks init example-directory\nInitialized local notebook: /home/username/example-directory\n\n❯ nb notebooks import example-directory\nImported notebook: example-directory\n\n❯ nb notebooks\nexample-directory\nhome\n```\n\n#### Archiving Notebooks\n\n<p>\n <sup>\n <a href=\"#-notebooks\">↑</a> ·\n <a href=\"#archive\"><code>nb archive</code></a>,\n <a href=\"#status\"><code>nb status</code></a>,\n <a href=\"#unarchive\"><code>nb unarchive</code></a>\n </sup>\n</p>\n\nNotebooks can be archived using\n[`nb archive`](#archive) (shortcut: [`nb ar`](#archive)):\n\n```bash\n# archive the current notebook\nnb archive\n\n# archive the notebook named \"example\"\nnb archive example\n\n# archive the current notebook, shortcut alias\nnb ar\n\n# archive the notebook named \"example\", shortcut alias\nnb ar example\n```\n\nWhen a notebook is archived it is not included in\n[`nb`](#ls) / [`nb ls`](#ls) output,\n[`nb search --all`](#search),\nor tab completion,\nnor synced automatically with [`nb sync --all`](#sync).\n\n```bash\n❯ nb\nexample1 · example2 · example3 · [1 archived]\n---------------------------------------------\n[3] Title Three\n[2] Title Two\n[1] Title One\n```\n\nArchived notebooks can still be used individually\nusing normal notebook commands:\n\n```bash\n# switch the current notebook to the archived notebook \"example\"\nnb use example\n\n# run the `list` subcommand in the archived notebook \"example\"\nnb example:list\n```\n\nCheck a notebook's archival status with\n[`nb status`](#status) (shortcut: [`nb st`](#status)) and\n[`nb notebooks status`](#notebooks):\n\n```bash\n# print status information, including archival status, for the current notebook\nnb status\n\n# print status information, including archival status, for the notebook named \"example\"\nnb status example\n\n# print status information, including archival status, for the current notebook,\n# shortcut alias\nnb st\n\n# print status information, including archival status, for the notebook named \"example\",\n# shortcut alias\nnb st example\n\n# print the archival status of the current notebook\nnb notebooks status\n\n# print the archival status of the notebook named \"example\"\nnb notebooks status example\n```\n\nUse [`nb unarchive`](#unarchive) (shortcut: [`nb unar`](#unarchive))\nto unarchive a notebook:\n\n```bash\n# unarchive the current notebook\nnb unarchive\n\n# unarchive the notebook named \"example\"\nnb unarchive example\n```\n\nFor more information about working with notebooks, see\n[`nb help notebooks`](#notebooks),\n[`nb help archive`](#archive),\nand [`nb help unarchive`](#unarchive).\n\nFor technical details about notebooks, see\n[`nb` Notebook Specification](#nb-notebook-specification).\n\n### 🔄 Git Sync\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#remote\"><code>nb remote</code></a>,\n <a href=\"#sync\"><code>nb sync</code></a>\n </sup>\n</p>\n\nEach notebook can be synced with a remote git repository by\nsetting the remote URL using [`nb remote`](#remote):\n\n```bash\n# set the current notebook's remote to a private GitHub repository\nnb remote set https://github.com/example/example\n\n# set the remote for the notebook named \"example\"\nnb example:remote set https://github.com/example/example\n```\n\nAny notebook with a remote URL will sync automatically\nevery time a command is run in that notebook.\n\nWhen you use `nb` on multiple systems, you can\nset a notebook on each system to the same remote\nand `nb` will keep everything in sync in the background\nevery time there's a change in that notebook.\n\nSince each notebook has its own git history,\nyou can have some notebooks syncing with remotes\nwhile other notebooks are only available locally on that system.\n\nMany services provide free private git repositories, so\ngit syncing with `nb` is easy, free, and vendor-independent.\nYou can also sync your notes using\nDropbox, Drive, Box, Syncthing, or another syncing tool\nby changing your `nb` directory with\n[`nb set nb_dir <path>`](#nb_dir),\nand git syncing will still work simultaneously.\n\nClone an existing notebook by passing the URL to\n[`nb notebooks add`](#notebooks):\n\n```bash\n# create a new notebook named \"example\" cloned from a private GitLab repository\nnb notebooks add example https://gitlab.com/example/example.git\n```\n\nTurn off syncing for a notebook by removing the remote:\n\n```bash\n# remove the remote from the current notebook\nnb remote remove\n\n# remove the remote from the notebook named \"example\"\nnb example:remote remove\n```\n\nAutomatic git syncing can be turned on or off with\n[`nb set auto_sync`](#auto_sync).\n\nTo sync manually, use [`nb sync`](#sync):\n\n```bash\n# manually sync the current notebook\nnb sync\n\n# manually sync the notebook named \"example\"\nnb example:sync\n```\n\nTo bypass `nb` syncing and run `git` commands directly within a\nnotebook, use [`nb git`](#git):\n\n```bash\n# run `git fetch` in the current notebook\nnb git fetch origin\n\n# run `git status` in the notebook named \"example\"\nnb example:git status\n```\n\n#### Syncing Multiple Notebooks with One Remote\n\nMultiple notebooks can be synced to one remote using orphan branches.\nAn\n[orphan branch](https://git-scm.com/docs/git-checkout#Documentation/git-checkout.txt---orphanltnewbranchgt)\nis a branch with a history that is independent\nfrom the repository's `main`, `master`,\nor equivalent primary branch history.\nTo sync a notebook with a new orphan branch,\nadd the remote using [`nb remote set`](#remote)\nand select the option to create a new orphan branch.\nThe name of orphan branch is derived from notebook name\nand can alternatively be specified as an argument to\n[`nb remote set`](#remote):\n\n```bash\n# set the remote for the current notebook to a remote URL and branch\nnb remote set https://github.com/xwmx/example demo-branch\n```\n\nTo create a notebook using an existing orphan branch on a remote,\npass the branch name to\n[`nb init`](#init),\n[`nb notebooks add`](#notebooks), or\n[`nb notebooks init`](#notebooks) after the URL:\n\n```bash\n# initialize new \"home\" notebook with the branch \"sample-branch\" on the remote\nnb init https://github.com/xwmx/example sample-branch\n\n# add a new \"example\" notebook from the branch \"example-branch\" on the remote\nnb notebooks add example https://github.com/xwmx/example example-branch\n```\n\nTo list all branches on a remote, use [`nb remote branches`](#remote):\n\n```bash\n# list all branches on the current remote\nnb remote branches\n\n# list all branches on a remote repository identified by a URL\nnb remote branches \"https://github.com/xwmx/example\"\n```\n\nFor information about assigning remotes, see [`nb help remote`](#remote).\n\n#### Private Repositories and Git Credentials\n\nSyncing with private repositories requires\nconfiguring git to not prompt for credentials.\nFor repositories cloned over HTTPS,\n[credentials can be cached with git\n](https://docs.github.com/en/free-pro-team@latest/github/using-git/caching-your-github-credentials-in-git).\nFor repositories cloned over SSH,\n[keys can be added to the ssh-agent\n](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).\n\nUse [`nb sync`](#sync) within a notebook to determine\nwhether your configuration is working.\nIf `nb sync` displays a password prompt,\nthen follow the instructions above to configure your credentials.\nThe password prompt can be used to authenticate, but\n`nb` does not cache or otherwise handle git credentials in any way,\nso there will likely be multiple password prompts during each sync\nif credentials are not configured.\n\n#### Sync Conflict Resolution\n\n`nb` handles git operations automatically, so\nyou shouldn't ever need to use the `git` command line tool directly.\n`nb` merges changes when syncing\nand handles conflicts using a couple different strategies.\n\nWhen [`nb sync`](#sync) encounters a conflict in a text file\nand can't cleanly merge overlapping local and remote changes,\n`nb` saves both versions within the file separated by git conflict markers\nand prints a message indicating which files contain conflicting text.\nUse [`nb edit`](#edit) to remove the conflict markers\nand delete any unwanted text.\n\nFor example, in the following file, the second list item was changed\non two systems, and git has no way to determine which one we want to keep:\n\n```\n# Example Title\n\n- List Item apple\n<<<<<<< HEAD\n- List Item apricot\n=======\n- List Item pluot\n>>>>>>> 719od01... [nb] Commit\n- List Item plum\n```\n\nThe local change is between the lines starting with\n`<<<<<<<` and `=======`,\nwhile the remote change is between the\n`=======` and `>>>>>>>`\nlines.\n\nTo resolve this conflict by keeping both items, simply\nedit the file with [`nb edit`](#edit) and\nremove the lines starting with `<<<<<<<`, `=======`, and `>>>>>>>`:\n\n```\n# Example Title\n\n- List Item apple\n- List Item apricot\n- List Item pluot\n- List Item plum\n```\n\nWhen `nb` encounters a conflict in a binary file,\nsuch as an encrypted note,\nboth versions of the file are saved in the notebook as individual files,\nwith `--conflicted-copy` appended to the filename\nof the version from the remote.\nTo resolve a conflicted copy of a binary file,\ncompare both versions and merge them manually,\nthen delete the `--conflicted-copy`.\n\nIf you do encounter a conflict that `nb` says it can't merge at all,\n[`nb git`](#git) and [`nb run`](#run) can be used to\nperform git and shell operations within the notebook\nto resolve the conflict manually.\nPlease also\n[open an issue](https://github.com/xwmx/nb/issues/new)\nwith any relevant details\nthat could inform a strategy for handling any such cases automatically.\n\n### ↕️ Import / Export\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#import\"><code>nb import</code></a>,\n <a href=\"#export\"><code>nb export</code></a>,\n <a href=\"#browse\"><code>nb browse</code></a>\n </sup>\n</p>\n\n#### Importing\n\nFiles of any type can be imported into a notebook using\n[`nb import`](#import) (shortcut: [`nb i`](#import)).\n[`nb edit`](#edit) and [`nb open`](#open) open files in\nyour system's default application for that file type.\n\n```bash\n# import an image file\nnb import ~/Pictures/example.png\n\n# open image in your default image viewer\nnb open example.png\n\n# import a .docx file\nnb import ~/Documents/example.docx\n\n# open .docx file in Word or your system's .docx viewer\nnb open example.docx\n```\n\nMultiple filenames and globbing are supported:\n\n```bash\n# import all files and directories in the current directory\nnb import ./*\n\n# import all markdown files in the current directory\nnb import ./*.md\n\n# import example.md and sample.md in the current directory\nnb import example.md sample.md\n```\n\n[`nb import`](#import) can also download and import files directly from the web:\n\n```bash\n# import a PDF file from the web\nnb import https://example.com/example.pdf\n# Imported \"https://example.com/example.pdf\" to \"example.pdf\"\n\n# open example.pdf in your system's PDF viewer\nnb open example.pdf\n```\n\nSome imported file types have [indicators](#indicators) to make them\neasier to identify in lists:\n\n```bash\n❯ nb\nhome\n----\n[6] 📖 example-ebook.epub\n[5] 🌄 example-picture.png\n[4] 📄 example-document.docx\n[3] 📹 example-video.mp4\n[2] 🔉 example-audio.mp3\n[1] 📂 Example Folder\n```\n\n#### Importing Bookmarks\n\nBookmarks exported from Chrome, Firefox, and Edge can be imported with\n[`nb import bookmarks`](#import). A new `nb` bookmark file is created for\neach bookmark.\n\n#### Exporting\n\nNotes, bookmarks, and other files can be exported using [`nb export`](#export).\nIf [Pandoc](https://pandoc.org/) is installed,\nnotes can be automatically converted to any of the\n[formats supported by Pandoc](https://pandoc.org/MANUAL.html#option--to).\nBy default, the output format is determined by the file extension:\n\n```bash\n# export a Markdown note to a .docx Microsoft Office Word document\nnb export example.md /path/to/example.docx\n\n# export a note titled \"Movies\" to an HTML web page.\nnb export Movies /path/to/example.html\n```\n\nFor more control over the `pandoc` options, use the\n[`nb export pandoc`](#export) subcommand:\n\n```bash\n# export note 42 as an epub with pandoc options\nnb export pandoc 42 --from markdown_strict --to epub -o path/to/example.epub\n```\n\n[`nb export notebook`](#export) and [`nb import notebook`](#import) can be\nused to export and import notebooks:\n\n```bash\n# export global notebook named \"example\" to \"../path/to/destination\"\nnb export notebook example ../path/to/destination\n\n# import notebook or folder at \"../path/to/notebook\"\nnb import notebook ../path/to/notebook\n```\n\n[`nb export notebook`](#export) and [`nb import notebook`](#import)\nbehave like aliases for\n[`nb notebooks export`](#notebooks) and [`nb notebooks import`](#notebooks),\nand the subcommands can be used interchangeably.\n\nFor more information about imported and exported notebooks, see\n[Global and Local Notebooks](#global-and-local-notebooks).\n\nFor [`nb import`](#import) and [`nb export`](#export) help information, see\n[`nb help import`](#import) and [`nb help export`](#export).\n\n#### Exporting with `browse`\n\nItems can be exported using terminal and GUI [web browsers](#-browsing).\nUse the down arrow (`↓`) link\non the [`nb browse`](#browse) item page\nto download the original file:\n\n```bash\n❯ nb browse 123\n❯nb · home : 123 · ↓ | +\n\n example.pdf\n\n```\n\n### ⚙️ `set` & `settings`\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#-variables\">Variables</a>,\n <a href=\"#settings\"><code>nb settings</code></a>,\n <a href=\"#unset\"><code>nb unset</code></a>\n </sup>\n</p>\n\n[`nb set`](#settings) and [`nb settings`](#settings)\nopen the settings prompt,\nwhich provides an easy way to change your `nb` settings.\n\n```bash\nnb set\n```\n\nTo update a setting in the prompt,\nenter the setting name or number and then enter the new value.\n`nb` will add the setting to your `~/.nbrc` configuration file.\n\n#### Example: editor\n\n`nb` can be configured to use a specific command line editor\nusing the `editor` setting.\n\nThe settings prompt for a setting can be started by passing\nthe setting name or number to [`nb set`](#settings):\n\n```bash\n❯ nb set editor\n[6] editor\n ------\n The command line text editor used by `nb`.\n\n • Example Values:\n\n atom\n code\n emacs\n hx\n macdown\n mate\n micro\n nano\n pico\n subl\n vi\n vim\n\nEDITOR is currently set to vim\n\nEnter a new value, unset to set to the default value, or q to quit.\nValue:\n```\n\nA setting can also be updated without the prompt by\npassing both the name and value to [`nb set`](#settings):\n\n```bash\n# set editor with setting name\n❯ nb set editor code\nEDITOR set to code\n\n# set editor with setting number (6)\n❯ nb set 6 code\nEDITOR set to code\n\n# set the color theme to blacklight\n❯ nb set color_theme blacklight\nNB_COLOR_THEME set to blacklight\n\n# set the default `ls` limit to 10\n❯ nb set limit 10\nNB_LIMIT set to 10\n```\n\nUse [`nb settings get`](#settings) to print the value of a setting:\n\n```bash\n❯ nb settings get editor\ncode\n\n❯ nb settings get 6\ncode\n```\n\nUse\n[`nb unset`](#unset) or\n[`nb settings unset`](#settings)\nto unset a setting and revert to the default:\n\n```bash\n❯ nb unset editor\nEDITOR restored to the default: vim\n\n❯ nb settings get editor\nvim\n```\n\n[`nb set`](#settings) and [`nb settings`](#settings)\nare aliases that refer to the same subcommand,\nso the two subcommand names can be used interchangeably.\n\nFor more information about [`set`](#settings) and [`settings`](#settings), see\n[`nb help settings`](#settings).\n\n### 🎨 Color Themes\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#color_theme\"><code>nb set color_theme</code></a>,\n <a href=\"#syntax_theme\"><code>nb set syntax_theme</code></a>,\n <a href=\"#color_primary\"><code>nb set color_primary</code></a>,\n <a href=\"#color_secondary\"><code>nb set color_secondary</code></a>\n </sup>\n</p>\n\n`nb` uses color to highlight various interface elements, including\nids and [selectors](#-selectors),\nthe current notebook name,\nthe shell prompt,\ndivider lines,\n[syntax elements](#terminal-syntax-highlighting-theme),\nand links.\n\n`nb` includes several built-in color themes\nand also supports user-defined themes.\nThe current color theme can be set using [`nb set color_theme`](#color_theme):\n\n```bash\nnb set color_theme\n```\n\n#### Built-in Color Themes\n\n##### `blacklight`\n\n| ![blacklight](https://xwmx.github.io/misc/nb/images/nb-theme-blacklight-home.png) | ![blacklight](https://xwmx.github.io/misc/nb/images/nb-theme-blacklight-web.png) |\n|:--:|:--:|\n| | |\n\n##### `console`\n\n| ![console](https://xwmx.github.io/misc/nb/images/nb-theme-console-home.png) | ![console](https://xwmx.github.io/misc/nb/images/nb-theme-console-web.png) |\n|:--:|:--:|\n| | |\n\n##### `desert`\n\n| ![desert](https://xwmx.github.io/misc/nb/images/nb-theme-desert-home.png) | ![desert](https://xwmx.github.io/misc/nb/images/nb-theme-desert-web.png) |\n|:--:|:--:|\n| | |\n\n##### `electro`\n\n| ![electro](https://xwmx.github.io/misc/nb/images/nb-theme-electro-home.png) | ![electro](https://xwmx.github.io/misc/nb/images/nb-theme-electro-web.png) |\n|:--:|:--:|\n| | |\n\n##### `forest`\n\n| ![forest](https://xwmx.github.io/misc/nb/images/nb-theme-forest-home.png) | ![forest](https://xwmx.github.io/misc/nb/images/nb-theme-forest-web.png) |\n|:--:|:--:|\n| | |\n\n##### `nb` (default)\n\n| ![nb](https://xwmx.github.io/misc/nb/images/nb-theme-nb-home.png) | ![nb](https://xwmx.github.io/misc/nb/images/nb-theme-nb-web.png) |\n|:--:|:--:|\n| | |\n\n##### `ocean`\n\n| ![ocean](https://xwmx.github.io/misc/nb/images/nb-theme-ocean-home.png) | ![ocean](https://xwmx.github.io/misc/nb/images/nb-theme-ocean-web.png) |\n|:--:|:--:|\n| | |\n\n##### `raspberry`\n\n| ![raspberry](https://xwmx.github.io/misc/nb/images/nb-theme-raspberry-home.png) | ![raspberry](https://xwmx.github.io/misc/nb/images/nb-theme-raspberry-web.png) |\n|:--:|:--:|\n| | |\n\n##### `smoke`\n\n| ![smoke](https://xwmx.github.io/misc/nb/images/nb-theme-monochrome-home.png) | ![smoke](https://xwmx.github.io/misc/nb/images/nb-theme-smoke-web.png) |\n|:--:|:--:|\n| | |\n\n##### `unicorn`\n\n| ![unicorn](https://xwmx.github.io/misc/nb/images/nb-theme-unicorn-home.png) | ![unicorn](https://xwmx.github.io/misc/nb/images/nb-theme-unicorn-web.png) |\n|:--:|:--:|\n| | |\n\n##### `utility`\n\n| ![utility](https://xwmx.github.io/misc/nb/images/nb-theme-utility-home.png) | ![utility](https://xwmx.github.io/misc/nb/images/nb-theme-utility-web.png) |\n|:--:|:--:|\n| | |\n\n#### Custom Color Themes\n\nColor themes are\n[`nb` plugins](#-plugins) with a `.nb-theme` file extension.\n`.nb-theme` files are expected to contain one `if` statement\ntesting for the theme name\nand setting the color environment variables to `tput` ANSI color numbers:\n\n```bash\n# turquoise.nb-theme\nif [[ \"${NB_COLOR_THEME}\" == \"turquoise\" ]]\nthen\n export NB_COLOR_PRIMARY=43\n export NB_COLOR_SECONDARY=38\nfi\n```\n\nView this theme as a complete file:\n[`plugins/turquoise.nb-theme`](https://github.com/xwmx/nb/blob/master/plugins/turquoise.nb-theme)\n\nThemes can be installed using [`nb plugins`](#plugins):\n\n```bash\n❯ nb plugins install https://github.com/xwmx/nb/blob/master/plugins/turquoise.nb-theme\nPlugin installed:\n/home/example/.nb/.plugins/turquoise.nb-theme\n```\n\nOnce a theme is installed,\nuse [`nb set color_theme`](#color_theme) to set it as the current theme:\n\n```bash\n❯ nb set color_theme turquoise\nNB_COLOR_THEME set to turquoise\n```\n\nThe primary and secondary colors can also be overridden individually,\nmaking color themes easily customizable:\n\n```bash\n# open the settings prompt for the primary color\nnb set color_primary\n\n# open the settings prompt for the secondary color\nnb set color_secondary\n```\n\nTo view a table of available colors and numbers, run:\n\n```bash\nnb set colors\n```\n\n#### Terminal Syntax Highlighting Theme\n\n`nb` displays files with syntax highlighting when\n[`bat`](https://github.com/sharkdp/bat),\n[`highlight`](http://www.andre-simon.de/doku/highlight/en/highlight.php),\nor\n[Pygments](https://pygments.org/)\nis installed.\n\nWhen `bat` is installed, syntax highlighting\ncolor themes are available for both light and dark terminal backgrounds.\nTo view a list of available themes\nand set the syntax highlighting color theme,\nuse [`nb set syntax_theme`](#syntax_theme).\n\n#### GUI Web Syntax Highlighting\n\nSyntax highlighting is also available when\nviewing and editing items in text formats with\n[`nb browse --gui`](#browse---gui),\nwhich incorporates the color theme's primary color into the syntax theme:\n\n<div align=\"center\">\n <img src=\"https://xwmx.github.io/misc/nb/images/nb-web-pandoc-ruby-utility.png\"\n alt=\"nb syntax highlighting\"\n width=\"500\">\n</div>\n\n#### Indicators\n\n`nb` uses emoji characters to represent information about files in lists.\nThese characters are referred to internally as \"indicators\"\nand can be customized by assigning a different character to\nthe indicator's environment variable in your `~/.nbrc` file,\nwhich can be opened with [`nb settings edit`](#settings).\n\nFor example, to use a different indicator for pinned items,\nadd a line like the following to your `~/.nbrc` file:\n\n```bash\nexport NB_INDICATOR_PINNED=\"✨\"\n```\n\nTo turn off an indicator, assign the variable to an empty string:\n\n```bash\nexport NB_INDICATOR_PINNED=\"\"\n```\n\nAvailable indicator [variables](#-variables) with default values:\n\n```bash\nexport NB_INDICATOR_AUDIO=\"🔉\"\nexport NB_INDICATOR_BOOKMARK=\"🔖\"\nexport NB_INDICATOR_DOCUMENT=\"📄\"\nexport NB_INDICATOR_EBOOK=\"📖\"\nexport NB_INDICATOR_ENCRYPTED=\"🔒\"\nexport NB_INDICATOR_FOLDER=\"📂\"\nexport NB_INDICATOR_IMAGE=\"🌄\"\nexport NB_INDICATOR_PINNED=\"📌\"\nexport NB_INDICATOR_TODO=\"✔️ \"\nexport NB_INDICATOR_TODO_DONE=\"✅\"\nexport NB_INDICATOR_VIDEO=\"📹\"\n```\n\n### $ Shell Theme Support\n\n- [`astral` Zsh Theme](https://github.com/xwmx/astral) - Displays the\n current notebook name in the context line of the prompt.\n\n### 🔌 Plugins\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#plugin-help\">Plugin Help</a>,\n <a href=\"#plugins\"><code>nb plugins</code></a>\n </sup>\n</p>\n\n`nb` includes support for plugins, which can be used to create new\nsubcommands, design themes, and otherwise extend the functionality of `nb`.\n\n`nb` supports two types of plugins, identified by their file extensions:\n\n<dl>\n <dt><code>.nb-theme</code></dt>\n <dd>Plugins defining <a href=\"#custom-color-themes\">color themes</a>.</dd>\n <dt><code>.nb-plugin</code></dt>\n <dd>Plugins defining new subcommands and adding functionality.</dd>\n</dl>\n\nPlugins are managed with the [`nb plugins`](#plugins) subcommand and\nare installed in the `${NB_DIR}/.plugins` directory.\n\nPlugins can be installed from either a URL or a path using the\n[`nb plugins install`](#plugins) subcommand.\n\n```bash\n# install a plugin from a URL\nnb plugins install https://raw.githubusercontent.com/xwmx/nb/master/plugins/clip.nb-plugin\n\n# install a plugin from a standard GitHub URL\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/example.nb-plugin\n\n# install a theme from a standard GitHub URL\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/turquoise.nb-theme\n\n# install a plugin from a path\nnb plugins install plugins/example.nb-plugin\n```\n\nThe `<url>` should be the full URL to the plugin file.\n`nb` also recognizes regular GitHub URLs,\nwhich can be used interchangeably with raw GitHub URLs.\n\nInstalled plugins can be listed with [`nb plugins`](#plugins),\nwhich optionally takes a name and prints full paths:\n\n```bash\n❯ nb plugins\nclip.nb-plugin\nexample.nb-plugin\nturquoise.nb-theme\n\n❯ nb plugins clip.nb-plugin\nclip.nb-plugin\n\n❯ nb plugins --paths\n/home/example/.nb/.plugins/clip.nb-plugin\n/home/example/.nb/.plugins/example.nb-plugin\n/home/example/.nb/.plugins/turquoise.nb-theme\n\n❯ nb plugins turquoise.nb-theme --paths\n/home/example/.nb/.plugins/turquoise.nb-theme\n```\n\nUse [`nb plugins uninstall`](#plugins) to uninstall a plugin:\n\n```bash\n❯ nb plugins uninstall example.nb-plugin\nPlugin successfully uninstalled:\n/home/example/.nb/.plugins/example.nb-plugin\n```\n\n#### Creating Plugins\n\nPlugins are written in a Bash-compatible shell scripting language\nand have an `.nb-plugin` extension.\n\n`nb` includes a few example plugins:\n\n- [`example.nb-plugin`](https://github.com/xwmx/nb/blob/master/plugins/example.nb-plugin)\n- [`clip.nb-plugin`](https://github.com/xwmx/nb/blob/master/plugins/clip.nb-plugin)\n- [`ebook.nb-plugin`](https://github.com/xwmx/nb/blob/master/plugins/ebook.nb-plugin)\n\nCreate a new subcommand in three easy steps:\n\n##### 1. Add the new subcommand name with `_subcommands add <name>`:\n\n```bash\n_subcommands add \"example\"\n```\n\n##### 2. Define help and usage text with `_subcommands describe <subcommand> <usage>`:\n\n```bash\n_subcommands describe \"example\" <<HEREDOC\nUsage:\n nb example\n\nDescription:\n Print \"Hello, World!\"\nHEREDOC\n```\n\n##### 3. Define the subcommand as a function, named with a leading underscore:\n\n```bash\n_example() {\n printf \"Hello, World!\\\\n\"\n}\n```\n\nThat's it! 🎉\n\nView the complete plugin:\n[`plugins/example.nb-plugin`](https://github.com/xwmx/nb/blob/master/plugins/example.nb-plugin)\n\nWith `example.nb-plugin` installed, `nb` includes an `nb example` subcommand\nthat prints \"Hello, World!\"\n\nFor a full example,\n[`clip.nb-plugin`](https://github.com/xwmx/nb/blob/master/plugins/clip.nb-plugin)\nadd clipboard functionality to `nb` and demonstrates how to create a\nplugin using `nb` subcommands and simple shell scripting.\n\nYou can install any plugin you create locally with\n[`nb plugins install <path>`](#plugins),\nand you can publish it on GitHub, GitLab,\nor anywhere else online and install it with\n[`nb plugins install <url>`](#plugins).\n\n#### API\n\nThe `nb` API is the [command line interface](#nb-help), which is designed for\ncomposability and provides a variety of powerful options for interacting with\nnotes, bookmarks, notebooks, and `nb` functionality. Within plugins,\nsubcommands can be called using their function names, which are named with\nleading underscores. Options can be used to output information in formats\nsuitable for parsing and processing:\n\n```bash\n# print the content of note 3 to standard output with no color\n_show 3 --print --no-color\n\n# list all unarchived global notebook names\n_notebooks --names --no-color --unarchived --global\n\n# list all filenames in the current notebook\n_list --filenames --no-id --no-indicator\n\n# print the path to the current notebook\n_notebooks current --path\n```\n\n`nb` automatically scans arguments for\n[selectors](#-selectors) with notebook names\nand updates the current notebook if a valid one is found.\n\nIdentifier selectors are passed to subcommands as arguments along with\nany subcommand options. Use [`show <selector>`](#show) to query\ninformation about the file specified in the selector. For example, to\nobtain the filename of a selector-specified file, use\n[`show <selector> --filename`](#show):\n\n```bash\n_example() {\n local _selector=\"${1:-}\"\n [[ -z \"${_selector:-}\" ]] && printf \"Usage: example <selector>\\\\n\" && exit 1\n\n # Get the filename using the selector.\n local _filename=\n _filename=\"$(_show \"${_selector}\" --filename)\"\n\n # Rest of subcommand function...\n}\n```\n\n[`notebooks current --path`](#notebooks) returns the path to the current\nnotebook:\n\n```bash\n# _example() continued:\n\n# get the notebook path\nlocal _notebook_path=\n_notebook_path=\"$(_notebooks current --path)\"\n\n# print the file at \"${_notebook_path}/${_filename}\" to standard output\ncat \"${_notebook_path}/${_filename}\"\n```\n\nSee\n[`clip.nb-plugin`](https://github.com/xwmx/nb/blob/master/plugins/clip.nb-plugin)\nfor a practical example using both [`show <selector>`](#show) and\n[`notebooks current --path`](#notebooks) along with other\nsubcommands called using their underscore-prefixed function names.\n\n### `:/` Selectors\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a>\n </sup>\n</p>\n\nItems in `nb` are primarily identified using structured arguments called\n\"selectors.\" Selectors are like addresses for notebooks, folders, and items.\nA selector can be as simple as an id like `123` or folder path like `example/`,\nor it can combine multiple elements to identify\nan item in a nested folder within a particular notebook, such as:\n\n```bash\ncli:tools/shellcheck/home-page.bookmark.md\n```\n\nAn item, folder, or notebook selector is constructed by specifying the\nnotebook name, folder path, and / or item identifier\nin the following pattern:\n\n```text\nnotebook:folder/path/item-idenitifer\n```\n\nRepresented in a [docopt](http://docopt.org/)-like format:\n\n```text\n[<notebook>:][<folder-path>/][<id> | <filename> | <title>]\n```\n\nNotebooks are identified by the notebook name followed by a colon.\nFolder and item identifiers without a notebook name refer to\nitems within the current notebook.\nWhen a selector consists of notebook name and colon\nwith no folder path or item identifier,\nthe command runs in the root folder of the notebook:\n\n```bash\n# list items in the \"example\" notebook\nnb example:\n\n# add a new note named \"Example Title\" to the \"example\" notebook\nnb add example: --title \"Example Title\"\n\n# edit item with id \"123\" in the notebook \"example\"\nnb edit example:123\n```\n\nA notebook selector can be combined with a subcommand name to\nrun the command within the notebook:\n\n```bash\n# list all items in the \"example\" notebook and display excerpts\nnb example:list -e\n\n# edit item with id \"123\" in the \"example\" notebook\nnb example:edit 123\n\n# show the git history for the notebook named \"example\"\nnb example:history\n```\n\nFolders are identified by relative path from the notebook root.\nFolders can be referenced by either id or name, and segments\nin nested paths can mix and match names and ids:\n\n```bash\n# list items in the folder named \"sample\" in the folder named demo\"\nnb sample/demo/\n\n# add a new item to the folder named \"demo\" in the folder with id \"3\"\nnb add 3/demo/\n\n# show the history of the folder with id \"4\" in the folder named\n# \"sample\" in the notebook named \"example\"\nnb history example:sample/4/\n```\n\nA trailing slash indicates that the command is expected to operate on\nthe contents of the folder. When a trailing slash is omitted, the\nselector refers to the folder itself:\n\n```bash\n❯ nb list sample\n[1] 📂 sample\n\n❯ nb list sample/\n[sample/3] Title Three\n[sample/2] Title Two\n[sample/1] Title One\n```\n\nFor more information about folders, see [Folders](#-folders).\n\nAn item is identified by id, filename, or title, optionally preceded by\nnotebook name or folder path:\n\n```bash\n# edit item with id \"123\"\nnb edit 123\n\n# open the item titled \"demo title\" in the folder with id \"3\"\nnb open 3/demo\\ title\n\n# show \"file.md\" in the \"sample\" folder in the \"example\" notebook\nnb show example:sample/file.md\n```\n\nItems can also be specified using the full path:\n\n```bash\n# edit \"demo.md\" in the \"sample\" folder in the \"home\" notebook\nnb edit /home/example/.nb/home/sample/demo.md\n```\n\n##### Examples\n\n*Idenitifer Selectors*\n\n```text\n123\nexample.md\ntitle\nrelative/path/to/123\nrelative/path/to/demo.md\nrelative/path/to/title\n/full/path/to/sample.md\nnotebook:123\nnotebook:example.md\nnotebook:title\nnotebook:relative/path/to/123\nnotebook:relative/path/to/demo.md\nnotebook:relative/path/to/title\n```\n\n*Subcommand Selectors*\n\n```text\nnotebook:\nnotebook:show\nnotebook:history\nnotebook:a\nnotebook:q\n```\n\n### `01` Metadata\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#show\"><code>nb show</code></a>\n </sup>\n</p>\n\nMetadata in `nb` is primarily derived from git, the filesystem, and file\ncontent. For example, displayed timestamps are derived from\n[`git log`](https://git-scm.com/docs/git-log), with [`nb show --added`](#show)\ndisplaying the datetime of the first commit containing the file and\n[`nb show --updated`](#show) displaying the datetime of the last commit in\nwhich the file was modified. Meanwhile, the file system's modified\ntimestamp is used for sorting.\n\n`nb` also uses plain text files to store ids and state information in\ngit, including\n[`.index` files](#index-files),\n[`.pindex` files](#pindex-files),\nand [`.archived` files](#archived-notebooks).\n\n#### Front Matter\n\nUser-defined metadata can be added to notes in `nb` using [front\nmatter](https://jekyllrb.com/docs/front-matter/). Front matter is a\nsimple, human accessible, and future-friendly method for defining metadata\nfields in plain text and is well supported in tools for working with\nMarkdown.\n\nFront matter is defined within a Markdown file with triple-dashed lines\n(`---`) indicating the start and end of the block, with each field represented\nby a key name with a colon followed by the value:\n\n```markdown\n---\ntitle: Example Title\nauthor: xwmx\nyear: 2021\n---\n\nExample content.\n\nMore example content:\n\n- one\n- two\n- three\n```\n\nAny metadata can be placed in the front matter block. `nb` uses the\n`title:` field for listing, filtering, and selecting items, if one is\npresent, and ignores any other fields.\n\nThe simple `key: value` syntax is suitable for many metadata fields.\nMore complex data can be defined using additional\n[YAML](https://en.wikipedia.org/wiki/YAML)\ncapabilities.\n\n### `❯` Interactive Shell\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#shell\"><code>nb shell</code></a>\n </sup>\n</p>\n\n`nb` has an interactive shell that can be started with\n[`nb shell`](#shell), [`nb -i`](#nb-help), or [`nb --interactive`](#nb-help):\n\n```bash\n$ nb shell\n__ _\n\\ \\ _ __ | |__\n \\ \\ | '_ \\| '_ \\\n / / | | | | |_) |\n/_/ |_| |_|_.__/\n------------------\nnb shell started. Enter ls to list notes and notebooks.\nEnter help for usage information. Enter exit to exit.\nnb❯ ls\nhome\n----\n[3] Example\n[2] Sample\n[1] Demo\n\nnb❯ edit 3 --content \"New content.\"\nUpdated: [3] Example\n\nnb❯ bookmark https://example.com\nAdded: [4] 🔖 example.bookmark.md \"Example Title (example.com)\"\n\nnb❯ ls\nhome\n----\n[4] 🔖 Example Title (example.com)\n[3] Example\n[2] Sample\n[1] Demo\n\nnb❯ bookmark url 4\nhttps://example.com\n\nnb❯ search \"example\"\n[4] example.bookmark.md \"Example (example.com)\"\n-----------------------------------------------\n1:# Example (example.com)\n\n3:<https://example.com>\n\n[3] example.md \"Example\"\n------------------------\n1:# Example\n\nnb❯ exit\n$\n```\n\nThe `nb` shell recognizes all `nb` subcommands and options,\nproviding a streamlined, distraction-free approach for working with `nb`.\n\n### Shortcut Aliases\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a>\n </sup>\n</p>\n\nSeveral core `nb` subcommands have shortcut aliases to make\nthem faster to work with:\n\n```bash\n# `a` (add): add a new note named \"example.md\"\nnb a example.md\n\n# `+` (add): add a new note titled \"Example Title\"\nnb + --title \"Example Title\"\n\n# `b` (browse): open the folder named \"sample\" in the web browser\nnb b sample/\n\n# `o` (open): open the URL from bookmark 12 in your web browser\nnb o 12\n\n# `p` (peek): open the URL from bookmark 6 in your terminal browser\nnb p 6\n\n# `e` (edit): edit note 5\nnb e 5\n\n# `d` (delete): delete note 19\nnb d 19\n\n# `d` (delete): delete note 123 in the notebook named \"example:\"\nnb - example:123\n\n# `s` (show): show note 27\nnb s 27\n\n# `q` (search): search notes for \"example query\"\nnb q \"example query\"\n\n# `h` (help): display the help information for the `add` subcommand\nnb h add\n\n# `u` (use): switch to example-notebook\nnb u example-notebook\n```\n\nFor more commands and options, run\n[`nb help`](#nb-help) or\n[`nb help <subcommand>`](#subcommands)\n\n<div align=\"center\">\n <img src=\"https://xwmx.github.io/misc/nb/images/gui-browse-themes.png\"\n alt=\"nb browse themes\"\n width=\"700\">\n</div>\n\n### `?` Help\n\n<div align=\"center\">\n <a href=\"#nb-help\">nb</a> ·\n <a href=\"#bookmark-help\">bookmark</a> ·\n <a href=\"#subcommands\">subcommands</a> ·\n <a href=\"#plugin-help\">plugins</a>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n<div align=\"center\">\n <a href=\"#add\">add</a> ·\n <a href=\"#archive\">archive</a> ·\n <a href=\"#bookmark\">bookmark</a> ·\n <a href=\"#browse\">browse</a> ·\n <a href=\"#completions\">completions</a> ·\n <a href=\"#copy\">copy</a> ·\n <a href=\"#count\">count</a> ·\n <a href=\"#delete\">delete</a> ·\n <a href=\"#do\">do</a> ·\n <a href=\"#edit\">edit</a> ·\n <a href=\"#env\">env</a> ·\n <a href=\"#export\">export</a> ·\n <a href=\"#folders\">folders</a> ·\n <a href=\"#git\">git</a> ·\n <a href=\"#help\">help</a> ·\n <a href=\"#history\">history</a> ·\n <a href=\"#import\">import</a> ·\n <a href=\"#init\">init</a> ·\n <a href=\"#list\">list</a> ·\n <a href=\"#ls\">ls</a> ·\n <a href=\"#move\">move</a> ·\n <a href=\"#notebooks\">notebooks</a> ·\n <a href=\"#open\">open</a> ·\n <a href=\"#peek\">peek</a> ·\n <a href=\"#pin\">pin</a> ·\n <a href=\"#plugins\">plugins</a> ·\n <a href=\"#remote\">remote</a> ·\n <a href=\"#run\">run</a> ·\n <a href=\"#search\">search</a> ·\n <a href=\"#settings\">settings</a> ·\n <a href=\"#shell\">shell</a> ·\n <a href=\"#show\">show</a> ·\n <a href=\"#status\">status</a> ·\n <a href=\"#subcommands-1\">subcommands</a> ·\n <a href=\"#sync\">sync</a> ·\n <a href=\"#tasks\">tasks</a> ·\n <a href=\"#todo\">todo</a> ·\n <a href=\"#unarchive\">unarchive</a> ·\n <a href=\"#undo\">undo</a> ·\n <a href=\"#unpin\">unpin</a> ·\n <a href=\"#unset\">unset</a> ·\n <a href=\"#update\">update</a> ·\n <a href=\"#use\">use</a> ·\n <a href=\"#version\">version</a>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n<div align=\"center\">\n <a href=\"#overview\"> ↑ </a>\n</div>\n\n#### `nb help`\n\n[↑](#-help) · See also:\n[`help`](#help)\n\n```text\n__ _\n\\ \\ _ __ | |__\n \\ \\ | '_ \\| '_ \\\n / / | | | | |_) |\n/_/ |_| |_|_.__/\n\n[nb] Command line and local web note-taking, bookmarking, and archiving with\nplain text data storage, encryption, filtering and search, pinning, #tagging,\nGit-backed versioning and syncing, Pandoc-backed conversion, global and local\nnotebooks, customizable color themes, [[wiki-style linking]], plugins, and more\nin a single portable, user-friendly script.\n\nHelp:\n nb help Display this help information.\n nb help <subcommand> View help information for <subcommand>.\n nb help --colors View information about color settings.\n nb help --readme View the `nb` README file.\n\nUsage:\n nb\n nb [<ls-options>...] [<id> | <filename> | <path> | <title> | <notebook>]\n nb [<url>] [<bookmark options>...]\n nb add [<notebook>:][<folder-path>/][<filename>] [<content>]\n [-b | --browse] [-c <content> | --content <content>] [--edit]\n [-e | --encrypt] [-f <filename> | --filename <filename>]\n [--folder <folder-path>] [--no-template] [--tags <tag1>,<tag2>...]\n [--template <template>] [-t <title> | --title <title>] [--type <type>]\n nb add bookmark [<bookmark-options>...]\n nb add folder [<name>]\n nb add todo [<todo-options>...]\n nb archive [<notebook>]\n nb bookmark [<ls-options>...]\n nb bookmark [<notebook>:][<folder-path>/] <url>...\n [-c <comment> | --comment <comment>] [--edit] [-e | --encrypt]\n [-f <filename> | --filename <filename>] [--no-request]\n [-q <quote> | --quote <quote>] [--save-source]\n [-r (<url> | <selector>) | --related (<url> | <selector>)]...\n [-t <tag1>,<tag2>... | --tags <tag1>,<tag2>...] [--title <title>]\n nb bookmark [list [<list-options>...]]\n nb bookmark (open | peek | url) (<id> | <filename> | <path> | <title>)\n nb bookmark (edit | delete) (<id> | <filename> | <path> | <title>)\n nb bookmark search <query>\n nb browse [<notebook>:][<folder-path>/][<id> | <filename> | <title>] [--daemon]\n [-g | --gui] [-n | --notebooks] [-p | --print] [-q | --query <query>]\n [-s | --serve] [-t <tag> | --tag <tag> | --tags <tag1>,<tag2>...]\n nb browse add [<notebook>:][<folder-path>/][<filename>]\n [-c <content> | --content <content>] [--tags <tag1>,<tag2>...]\n [-t <title> | --title <title>]\n nb browse delete ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb browse edit ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb completions (check | install [-d | --download] | uninstall)\n nb copy ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [[<notebook>:][<folder-path>/]<filename>]\n nb count [<notebook>:][<folder-path>/]\n nb delete ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])...\n [-f | --force]\n nb do ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [<task-number>]\n nb edit ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [-c <content> | --content <content>] [--edit]\n [-e <editor> | --editor <editor>] [-l | --last] [--overwrite]\n [--prepend]\n nb env [-l | --long]\n nb env [install | update] [--ace | --mathjax]\n nb export ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n <path> [-f | --force] [<pandoc options>...]\n nb export notebook <name> [<path>]\n nb export pandoc ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [<pandoc options>...]\n nb folders (add | delete) [<notebook>:][<folder-path>/]<folder-name>\n nb folders <list-options>...\n nb git [checkpoint [<message>] | dirty]\n nb git <git-options>...\n nb help [<subcommand>] [-p | --print]\n nb help [-c | --colors] | [-r | --readme] | [-s | --short] [-p | --print]\n nb history [<notebook>:][<folder-path>/][<id> | <filename> | <title>]\n nb import [bookmarks | copy | download | move] (<path>... | <url>)\n [--convert] [<notebook>:][<folder-path>/][<filename>]\n nb import notebook <path> [<name>]\n nb init [<remote-url> [<branch>]] [--author] [--email <email>]\n [--name <name>]\n nb list [-e [<length>] | --excerpt [<length>]] [--filenames]\n [-f | --folders-first] [-n <limit> | --limit <limit> | --<limit>]\n [--no-id] [--no-indicator] [-p <number> | --page <number>] [--pager]\n [--paths] [-s | --sort] [-r | --reverse] [--tags]\n [-t <type> | --type <type> | --<type>]\n [<notebook>:][<folder-path>/][<id> | <filename> | <path> | <query>]\n nb ls [-a | --all] [-b | --browse] [-e [<length>] | --excerpt [<length>]]\n [--filenames] [-f | --folders-first] [-g | --gui]\n [-n <limit> | --limit <limit> | --<limit>] [--no-footer] [--no-header]\n [--no-id] [--no-indicator] [-p <number> | --page <number>] [--pager]\n [--paths] [-s | --sort] [-r | --reverse] [--tags]\n [-t <type> | --type <type> | --<type>]\n [<notebook>:][<folder-path>/][<id> | <filename> | <path> | <query>]\n nb move ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n ([<notebook>:][<path>] | --reset | --to-bookmark | --to-note |\n --to-title | --to-todo) [-f | --force]\n nb notebooks [<name> | <query>] [--ar | --archived] [--global] [--local]\n [--names] [--paths] [--unar | --unarchived]\n nb notebooks add ([<name>] [<remote-url> [<branch>... | --all]]) [--author]\n [--email <email>] [--name <name>]\n nb notebooks (archive | open | peek | status | unarchive) [<name>]\n nb notebooks author [<name> | <path>] [--email <email>] [--name <name>]\n nb notebooks current [--path | --selected | --filename [<filename>]]\n [--global | --local]\n nb notebooks delete <name> [-f | --force]\n nb notebooks (export <name> [<path>] | import <path>)\n nb notebooks init [<path> [<remote-url> [<branch>]]] [--author]\n [--email <email>] [--name <name>]\n nb notebooks rename <old-name> <new-name>\n nb notebooks select <selector>\n nb notebooks show (<name> | <path> | <selector>) [--ar | --archived]\n [--escaped | --name | --path | --filename [<filename>]]\n nb notebooks use <name>\n nb open ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb peek ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb pin ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb plugins [<name>] [--paths]\n nb plugins install [<path> | <url>] [--force]\n nb plugins uninstall <name> [--force]\n nb remote [branches [<url>] | remove | rename [<branch-name>] <name>]\n nb remote [delete <branch-name> | reset <branch-name>]\n nb remote set <url> [<branch-name>]\n nb run <command> [<arguments>...]\n nb search ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n <query>... [-a | --all] [--and <query>] [--not <query>] [--or <query>]\n [-l | --list] [--path] [-t <tag1>,<tag2>... | --tag <tag1>,<tag2>...]\n [-t | --tags] [--type <type> | --<type>] [--utility <name>]\n nb set [<name> [<value>] | <number> [<value>]]\n nb settings [colors [<number> | themes] | edit | list [--long]]\n nb settings (get | show | unset) (<name> | <number>)\n nb settings set (<name> | <number>) <value>\n nb shell [<subcommand> [<options>...] | --clear-history]\n nb show ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [[-a | --added] | [--authors] | [-b | --browse] | --filename | --id |\n --info-line | --path | [-p | --print] | --relative-path | [-r |\n --render] | --title | --type [<type>] | [-u | --updated]] [--no-color]\n nb show <notebook>\n nb status [<notebook>]\n nb subcommands [add <name>...] [alias <name> <alias>]\n [describe <name> <usage>]\n nb sync [-a | --all]\n nb tasks ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [open | closed]\n nb todo add [<notebook>:][<folder-path>/][<filename>] <title>\n [--description <description>] [--due <date>]\n [-r (<url> | <selector>) | --related (<url> | <selector>)]\n [--tags <tag1>,<tag2>...] [--task <title>...]\n nb todo do ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [<task-number>]\n nb todo undo ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [<task-number>]\n nb todos [<notebook>:][<folder-path>/] [open | closed] [--pager]\n [--tags <tag1>,<tag2>...]\n nb todos tasks ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [open | closed] [--pager]\n nb unarchive [<notebook>]\n nb undo ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [<task-number>]\n nb unpin ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb unset (<name> | <number>)\n nb update\n nb use <notebook>\n nb -h | --help | help [<subcommand> | --readme]\n nb -i | --interactive [<subcommand> [<options>...]]\n nb --no-color\n nb --version | version\n\nSubcommands:\n (default) List notes and notebooks. This is an alias for `nb ls`.\n When a <url> is provided, create a new bookmark.\n add Add a note, folder, or file.\n archive Archive the current or specified notebook.\n bookmark Add, open, list, and search bookmarks.\n browse Browse and manage linked items in terminal and GUI web browsers.\n completions Install and uninstall completion scripts.\n copy Copy or duplicate an item.\n count Print the number of items in a notebook or folder.\n delete Delete a note.\n do Mark a todo or task as done.\n edit Edit a note.\n env Print environment information and install dependencies.\n export Export a note to a variety of different formats.\n folders Add, delete, and list folders.\n git Run `git` commands within the current notebook.\n help View help information for the program or a subcommand.\n history View git history for the current notebook or a note.\n import Import a file into the current notebook.\n init Initialize the first notebook.\n list List notes in the current notebook.\n ls List notebooks and notes in the current notebook.\n move Move or rename a note.\n notebooks Manage notebooks.\n open Open a bookmarked web page or notebook folder, or edit a note.\n peek View a note, bookmarked web page, or notebook in the terminal.\n pin Pin an item so it appears first in lists.\n plugins Install and uninstall plugins and themes.\n remote Configure the remote URL and branch for the notebook.\n run Run shell commands within the current notebook.\n search Search notes.\n settings Edit configuration settings.\n shell Start the `nb` interactive shell.\n show Show a note or notebook.\n status Run `git status` in the current notebook.\n subcommands List, add, alias, and describe subcommands.\n status Print notebook status information.\n sync Sync local notebook with the remote repository.\n tasks List tasks in todos, notebooks, folders, and other items.\n todo Manage todos and tasks.\n unarchive Unarchive the current or specified notebook.\n undo Mark a todo or task as not done.\n unpin Unpin a pinned item.\n unset Return a setting to its default value.\n update Update `nb` to the latest version.\n use Switch to a notebook.\n version Display version information.\n\nNotebook Usage:\n nb <notebook>:[<subcommand>] [<identifier>] [<options>...]\n nb <subcommand> <notebook>:<identifier> [<options>...]\n\nProgram Options:\n -h, --help Display this help information.\n -i, --interactive Start the `nb` interactive shell.\n --no-color Print without color highlighting.\n --version Display version information.\n\nMore Information:\n https://github.com/xwmx/nb\n```\n\n#### `bookmark help`\n\n[↑](#-help) · See also:\n[Bookmarks](#-bookmarks),\n[`bookmark`](#bookmark),\n[`browse`](#browse)\n\n```text\n __ __ __\n / /_ ____ ____ / /______ ___ ____ ______/ /__\n / __ \\/ __ \\/ __ \\/ //_/ __ `__ \\/ __ `/ ___/ //_/\n / /_/ / /_/ / /_/ / ,< / / / / / / /_/ / / / ,<\n/_.___/\\____/\\____/_/|_/_/ /_/ /_/\\__,_/_/ /_/|_|\n\nbookmark -- Command line bookmarking with tagging, encryption,\nfull-text page content search with regular expression support,\nGUI and terminal browser support, and data stored in plain text\nMarkdown files with Git-backed versioning and syncing.\n\nUsage:\n bookmark [<ls-options>...]\n bookmark [<notebook>:][<folder-path>] <url>\n [-c <comment> | --comment <comment>] [--edit] [-e | --encrypt]\n [-f <filename> | --filename <filename>] [--no-request]\n [-q <quote> | --quote <quote>] [--save-source]\n [-r (<url> | <selector>) | --related (<url> | <selector>)]...\n [-t <tag1>,<tag2>... | --tags <tag1>,<tag2>...] [--title <title>]\n bookmark (edit | delete | open | peek | url)\n ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n bookmark search <query>\n\nOptions:\n -c, --comment <comment> A comment or description for this bookmark.\n --edit Open the bookmark in your editor before saving.\n -e, --encrypt Encrypt the bookmark with a password.\n -f, --filename <filename> The filename for the bookmark. It is\n recommended to omit the extension so the\n default bookmark extension is used.\n --no-request Don't request or download the target page.\n -q, --quote <quote> A quote or excerpt from the saved page.\n Alias: `--excerpt`\n -r, --related <selector> A selector for an item related to the\n bookmarked page.\n -r, --related <url> A URL for a page related to the bookmarked page.\n Multiple `--related` flags can be used in a\n command to save multiple related URLs.\n --save-source Save the page source as HTML.\n -t, --tags <tag1>,<tag2>... A comma-separated list of tags.\n --title <title> The bookmark title. When not specified,\n `nb` will use the html <title> tag.\n\nSubcommands:\n (default) Add a new bookmark for <url>, or list bookmarks.\n Bookmarks can also be added with `nb <url>`\n delete Delete a bookmark.\n edit Edit a bookmark.\n list List bookmarks in the current notebook.\n Shortcut Alias: `ls`\n open Open the bookmarked page in your system's primary web browser.\n Shortcut Alias: `o`\n peek Open the bookmarked page in your terminal web browser.\n Alias: `preview`\n Shortcut Alias: `p`\n search Search bookmarks for <query>.\n Shortcut Alias: `q`\n url Print the URL for the specified bookmark.\n\nDescription:\n Create, view, search, edit, and delete bookmarks.\n\n By default, the html page content is saved within the bookmark, making the\n bookmarked page available for full-text search. When Pandoc [1] is\n installed, the HTML content is converted to Markdown before saving.\n When readability-cli [2] is install, markup is cleaned up to focus on\n content.\n\n `peek` opens the page in `w3m` [3] or `links` [4] when available.\n To specify a preferred browser, set the `$BROWSER` environment variable\n in your .bashrc, .zshrc, or equivalent, e.g.: export BROWSER=\"lynx\"\n\n Bookmarks are identified by the `.bookmark.md` file extension. The\n bookmark URL is the first URL in the file within \"<\" and \">\" characters:\n\n <https://www.example.com>\n\n 1. https://pandoc.org/\n 2. https://gitlab.com/gardenappl/readability-cli\n 3. https://en.wikipedia.org/wiki/W3m\n 4. https://en.wikipedia.org/wiki/Links_(web_browser)\n\nRead More:\n https://github.com/xwmx/nb#-bookmarks\n\nSee Also:\n nb help browse\n nb help open\n nb help peek\n nb help show\n\nExamples:\n bookmark https://example.com\n bookmark https://example.com --encrypt\n bookmark https://example.com --tags example,sample,demo\n bookmark https://example.com/about -c \"Example comment.\"\n bookmark https://example.com/faqs -f example-filename\n bookmark https://example.com --quote \"Example quote or excerpt.\"\n bookmark list\n bookmark search \"example query\"\n bookmark open 5\n\n------------------------------------------\nPart of `nb` (https://github.com/xwmx/nb).\nFor more information, see: `nb help`.\n```\n\n### Subcommands\n\n<div align=\"center\">\n <a href=\"#add\">add</a> ·\n <a href=\"#archive\">archive</a> ·\n <a href=\"#bookmark\">bookmark</a> ·\n <a href=\"#browse\">browse</a> ·\n <a href=\"#completions\">completions</a> ·\n <a href=\"#copy\">copy</a> ·\n <a href=\"#count\">count</a> ·\n <a href=\"#delete\">delete</a> ·\n <a href=\"#do\">do</a> ·\n <a href=\"#edit\">edit</a> ·\n <a href=\"#env\">env</a> ·\n <a href=\"#folders\">folders</a> ·\n <a href=\"#export\">export</a> ·\n <a href=\"#git\">git</a> ·\n <a href=\"#help\">help</a> ·\n <a href=\"#history\">history</a> ·\n <a href=\"#import\">import</a> ·\n <a href=\"#init\">init</a> ·\n <a href=\"#list\">list</a> ·\n <a href=\"#ls\">ls</a> ·\n <a href=\"#move\">move</a> ·\n <a href=\"#notebooks\">notebooks</a> ·\n <a href=\"#open\">open</a> ·\n <a href=\"#peek\">peek</a> ·\n <a href=\"#pin\">pin</a> ·\n <a href=\"#plugins\">plugins</a> ·\n <a href=\"#remote\">remote</a> ·\n <a href=\"#run\">run</a> ·\n <a href=\"#search\">search</a> ·\n <a href=\"#settings\">settings</a> ·\n <a href=\"#shell\">shell</a> ·\n <a href=\"#show\">show</a> ·\n <a href=\"#status\">status</a> ·\n <a href=\"#subcommands-1\">subcommands</a> ·\n <a href=\"#sync\">sync</a> ·\n <a href=\"#tasks\">tasks</a> ·\n <a href=\"#todo\">todo</a> ·\n <a href=\"#unarchive\">unarchive</a> ·\n <a href=\"#undo\">undo</a> ·\n <a href=\"#unpin\">unpin</a> ·\n <a href=\"#unset\">unset</a> ·\n <a href=\"#update\">update</a> ·\n <a href=\"#use\">use</a> ·\n <a href=\"#version\">version</a>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n<div align=\"center\">\n <a href=\"#overview\"> ↑ </a>\n</div>\n\n#### `add`\n\n[↑](#-help) · See also:\n[Adding](#adding),\n[`bookmark`](#bookmark),\n[`browse`](#browse),\n[`delete`](#delete),\n[`edit`](#edit),\n[`folders`](#folders),\n[`import`](#import),\n[`show`](#show),\n[`todo`](#todo)\n\n```text\nUsage:\n nb add [<notebook>:][<folder-path>/][<filename>] [<content>]\n [-b | --browse] [-c <content> | --content <content>] [--edit]\n [-e | --encrypt] [-f <filename> | --filename <filename>]\n [--folder <folder-path>] [--no-template] [--tags <tag1>,<tag2>...]\n [--template <template>] [-t <title> | --title <title>] [--type <type>]\n nb add bookmark [<bookmark-options>...]\n nb add folder [<name>]\n nb add todo [<todo-options>...]\n\nOptions:\n -b, --browse Add using a terminal or GUI web browser.\n -c, --content <content> The content for the new note.\n --edit Open the note in the editor before saving when\n content is piped or passed as an argument.\n -e, --encrypt Encrypt the note with a password.\n -f, --filename <filename> The filename for the new note.\n --folder <folder-path> Add within the folder located at <folder-path>.\n --no-template Skip the template when one is assigned.\n --tags <tag1>,<tag2>... A comma-separated list of tags.\n --template <template> A string template or path to a template file.\n -t, --title <title> The title for a new note. If `--title` is\n present, the filename is derived from the\n title, unless `--filename` is specified.\n --type <type> The file type for the new note, as a file\n extension.\n\nDescription:\n Create a new note or folder.\n\n If no arguments are passed, a new blank note file is opened with `$EDITOR`,\n currently set to: example\n\n If a non-option argument is passed, `nb` will treat it as a <filename≥\n if a file extension is found. If no file extension is found, `nb` will\n treat the string as <content> and will create a new note without opening the\n editor. `nb add` can also create a new note with piped content.\n\n `nb` creates Markdown files by default. To create a note with a\n different file type, use the extension in the filename or use the `--type`\n option. To change the default file type, use `nb set default_extension`.\n\n When the `-e` / `--encrypt` option is used, `nb` will encrypt the\n note with AES-256 using OpenSSL by default, or GPG, if configured in\n `nb set encryption_tool`.\n\nRead More:\n https://github.com/xwmx/nb#adding\n\nSee Also:\n nb help bookmark\n nb help browse\n nb help delete\n nb help edit\n nb help folders\n nb help import\n nb help show\n nb help todo\n\nExamples:\n nb add\n nb add example.md\n nb add \"Note content.\"\n nb add example.md --title \"Example Title\" --content \"Example content.\"\n echo \"Note content.\" | nb add\n nb add -t \"Secret Document\" --encrypt\n nb add example/document.md\n nb add folder sample/demo\n nb example:add\n nb example:add -t \"Title\"\n nb a\n nb a \"Note content.\"\n nb example:a\n nb example:a -t \"Title\"\n\nAliases:\n nb create\n nb new\n\nShortcut Aliases:\n nb a\n nb +\n```\n\n#### `archive`\n\n[↑](#-help) · See also:\n[Archiving Notebooks](#archiving-notebooks),\n[`notebooks`](#notebooks),\n[`status`](#status),\n[`unarchive`](#unarchive)\n\n```text\nUsage:\n nb archive [<name>]\n\nDescription:\n Set the current notebook or notebook <name> to \"archived\" status.\n\n This is an alias for `nb notebooks archive`.\n\nRead More:\n https://github.com/xwmx/nb#archiving-notebooks\n\nSee Also:\n nb help notebooks\n nb help status\n nb help unarchive\n\nExamples:\n nb archive\n nb archive example\n\nShortcut Alias:\n nb ar\n```\n\n#### `bookmark`\n\n[↑](#-help) · See also:\n[Bookmarks](#-bookmarks),\n[`browse`](#browse),\n[`open`](#open),\n[`peek`](#peek),\n[`show`](#show)\n\n```text\nUsage:\n nb bookmark [<ls-options>...]\n nb bookmark [<notebook>:][<folder-path>/] <url>...\n [-c <comment> | --comment <comment>] [--edit] [-e | --encrypt]\n [-f <filename> | --filename <filename>] [--no-request]\n [-q <quote> | --quote <quote>] [--save-source]\n [-r (<url> | <selector>) | --related (<url> | <selector>)]...\n [-t <tag1>,<tag2>... | --tags <tag1>,<tag2>...] [--title <title>]\n nb bookmark list [<list-options>...]\n nb bookmark (edit | delete | open | peek | url)\n ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb bookmark search <query>\n\nOptions:\n -c, --comment <comment> A comment or description for this bookmark.\n --edit Open the bookmark in your editor before saving.\n -e, --encrypt Encrypt the bookmark with a password.\n -f, --filename <filename> The filename for the bookmark. It is\n recommended to omit the extension so the\n default bookmark extension is used.\n --no-request Don't request or download the target page.\n -q, --quote <quote> A quote or excerpt from the saved page.\n Alias: `--excerpt`\n -r, --related <selector> A selector for an item related to the\n bookmarked page.\n -r, --related <url> A URL for a page related to the bookmarked page.\n Multiple `--related` flags can be used in a\n command to save multiple related URLs.\n --save-source Save the page source as HTML.\n -t, --tags <tag1>,<tag2>... A comma-separated list of tags.\n --title <title> The bookmark title. When not specified,\n `nb` will use the html <title> tag.\n\nSubcommands:\n (default) Add a new bookmark for <url>, or list bookmarks.\n Bookmarks can also be added with `nb <url>`\n delete Delete a bookmark.\n edit Edit a bookmark.\n list List bookmarks in the current notebook.\n Shortcut Alias: `ls`\n open Open the bookmarked page in your system's primary web browser.\n Shortcut Alias: `o`\n peek Open the bookmarked page in your terminal web browser.\n Alias: `preview`\n Shortcut Alias: `p`\n search Search bookmarks for <query>.\n Shortcut Alias: `q`\n url Print the URL for the specified bookmark.\n\nDescription:\n Create, view, search, edit, and delete bookmarks.\n\n By default, the html page content is saved within the bookmark, making the\n bookmarked page available for full-text search. When Pandoc [1] is\n installed, the HTML content is converted to Markdown before saving.\n When readability-cli [2] is install, markup is cleaned up to focus on\n content.\n\n `peek` opens the page in `w3m` [3] or `links` [4] when available.\n To specify a preferred browser, set the `$BROWSER` environment variable\n in your .bashrc, .zshrc, or equivalent, e.g.: export BROWSER=\"lynx\"\n\n Bookmarks are identified by the `.bookmark.md` file extension. The\n bookmark URL is the first URL in the file within \"<\" and \">\" characters:\n\n <https://www.example.com>\n\n 1. https://pandoc.org/\n 2. https://gitlab.com/gardenappl/readability-cli\n 3. https://en.wikipedia.org/wiki/W3m\n 4. https://en.wikipedia.org/wiki/Links_(web_browser)\n\nRead More:\n https://github.com/xwmx/nb#-bookmarks\n\nSee Also:\n nb help browse\n nb help open\n nb help peek\n nb help show\n\nExamples:\n nb https://example.com\n nb example: https://example.com\n nb https://example.com --encrypt\n nb https://example.com --tags example,sample,demo\n nb https://example.com/about -c \"Example comment.\"\n nb https://example.com/faqs -f example-filename\n nb https://example.com --quote \"Example quote or excerpt.\"\n nb bookmark list\n nb bookmark search \"example query\"\n nb bookmark open 5\n nb bk\n\nShortcut Aliases:\n nb bk\n nb bm\n```\n\n#### `browse`\n\n[↑](#-help) · See also:\n[Browsing](#-browsing),\n[Images](#-images),\n[Linking](#-linking),\n[`add`](#add),\n[`delete`](#delete),\n[`edit`](#edit),\n[`list`](#list),\n[`ls`](#ls),\n[`open`](#open),\n[`peek`](#peek),\n[`pin`](#pin),\n[`search`](#search),\n[`show`](#show)\n\n```text\nUsage:\n nb browse [<notebook>:][<folder-path>/][<id> | <filename> | <title>] [--daemon]\n [-g | --gui] [-n | --notebooks] [-p | --print] [-q | --query <query>]\n [-s | --serve] [-t <tag> | --tag <tag> | --tags <tag1>,<tag2>...]\n nb browse add [<notebook>:][<folder-path>/][<filename>]\n [-c <content> | --content <content>] [--tags <tag1>,<tag2>...]\n [-t <title> | --title <title>]\n nb browse delete ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb browse edit ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n\nSubcommands:\n (default) Open a notebook, folder, or item in the terminal or GUI web browser.\n add Open the add view in the browser.\n Shortcut Aliases: `a`, `+`\n delete Open the delete view in the browser.\n Shortcut Aliases: `d`, `-`\n edit Open the edit view in the browser.\n Shortcut Alias: `e`\n\nOptions:\n -c, --content <content> Add content to the new note.\n --daemon Start the web server. Close with <CTRL-C>.\n -g, --gui Open in the system's primary GUI web browser.\n -n, --notebooks Browse notebooks.\n -p, --print Print to standard output.\n -q, --query <query> Open to the search results for <query>.\n -s, --serve Start the web server. Close with any key.\n -t, --tag <tag> Search for a tag.\n --tags <tag1>,<tag2>... A comma-separated list of tags.\n -t, --title <title> Add a title to the new note.\n\nDescription:\n Browse, view, and edit linked notes, bookmarks, notebooks, folders, and\n other items using terminal and GUI web browsers.\n\n `browse` includes an embedded web application designed for terminal\n and GUI web browsers that renders [[wiki-style links]] and #tags as\n internal links, providing the ability to browse notes and notebooks,\n as well as seamlessly browse to and from the offsite links in\n bookmarks and notes.\n\n To link to a note or bookmark from another, include the selector for the\n target item within double square brackets anywhere in the linking document:\n\n # link to item 123 in the \"sample\" folder in the \"example\" notebook\n [[example:sample/123]]\n\n # link to the item titled \"Example Title\" in the \"demo\" notebook\n [[demo:Example Title]]\n\n `browse` supports `w3m` [1] and `links` [2], and depends on\n `ncat` [3] or `socat` [4] and `pandoc` [5]:\n\n 1. https://en.wikipedia.org/wiki/W3m\n 2. https://en.wikipedia.org/wiki/Links_(web_browser)\n 3. https://nmap.org/ncat/\n 4. https://www.kali.org/tools/socat/\n 5. https://pandoc.org/\n\nRead More:\n https://github.com/xwmx/nb#-browsing\n\nSee Also:\n nb help add\n nb help delete\n nb help edit\n nb help list\n nb help ls\n nb help open\n nb help peek\n nb help pin\n nb help search\n nb help show\n nb help unpin\n\nExamples:\n nb browse\n nb browse example:\n nb browse Example\\ Folder/\n nb browse 123\n nb browse demo:456\n nb br\n\nShortcut Alias:\n nb b\n```\n\n#### `completions`\n\n[↑](#-help) · See also:\n[Tab Completion](https://github.com/xwmx/nb/tree/master/etc),\n[`env`](#env)\n\n```text\nUsage:\n nb completions (check | install [-d | --download] | uninstall)\n\nOptions:\n -d, --download Download the completion scripts and install.\n\nDescription:\n Manage completion scripts.\n\nRead More:\n https://github.com/xwmx/nb/blob/master/etc/README.md\n\nSee Also:\n nb help env\n```\n\n#### `copy`\n\n[↑](#-help) · See also:\n[Moving & Renaming](#-moving--renaming),\n[`move`](#move)\n\n```text\nUsage:\n nb copy ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [[<notebook>:][<folder-path>/]<filename>]\n\nDescription:\n Copy or duplicate an item.\n\nRead More:\n https://github.com/xwmx/nb#-moving--renaming\n\nSee Also:\n nb help move\n\nExamples:\n nb copy 321\n nb copy 456 example:\n nb copy sample/demo.md\n\nAlias:\n nb duplicate\n```\n\n#### `count`\n\n[↑ ](#-help)\n\n```text\nUsage:\n nb count [<notebook>:][<folder-path>/]\n\nDescription:\n Print the number of items in the first level of the current notebook,\n <notebook>, or the folder at <folder-path>.\n```\n\n#### `delete`\n\n[↑](#-help) · See also:\n[Deleting](#deleting),\n[`add`](#add),\n[`browse`](#browse),\n[`edit`](#edit),\n[`move`](#move),\n[`show`](#show)\n\n```text\nUsage:\n nb delete ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])...\n [-f | --force]\n\nOptions:\n -f, --force Skip the confirmation prompt.\n\nDescription:\n Delete one or more items.\n\nRead More:\n https://github.com/xwmx/nb#deleting\n\nSee Also:\n nb help add\n nb help browse\n nb help edit\n nb help move\n nb help show\n\nExamples:\n nb delete 3\n nb delete example.md\n nb delete \"A Document Title\"\n nb 3 delete --force\n nb example:delete 12\n nb delete example:12\n nb example:12 delete\n nb d 3\n nb 3 d\n nb d example:12\n nb example:12 d\n\nAliases:\n nb rm\n nb trash\n\nShortcut Aliases:\n nb d\n nb -\n```\n\n#### `do`\n\n[↑](#-help) · See also:\n[Todos](#-todos),\n[Tasks](#%EF%B8%8F-tasks),\n[`tasks`](#tasks),\n[`todo`](#todo),\n[`undo`](#undo)\n\n```text\nUsage:\n nb do ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [<task-number>]\n\nDescription:\n Mark a todo or task as done.\n\nRead More:\n https://github.com/xwmx/nb#-todos\n\nSee Also:\n nb help tasks\n nb help todo\n nb help undo\n\nExamples:\n nb do 123\n nb do example:sample/321\n nb do 543 7\n```\n\n#### `edit`\n\n[↑](#-help) · See also:\n[Editing](#editing),\n[`add`](#add),\n[`browse`](#browse),\n[`delete`](#delete),\n[`move`](#move),\n[`show`](#show)\n\n```text\nUsage:\n nb edit ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [-c <content> | --content <content>] [--edit]\n [-e <editor> | --editor <editor>] [-l | --last] [--overwrite]\n [--prepend]\n\nOptions:\n -c, --content <content> Content to add to the item.\n --edit Open the note in the editor before saving when\n content is piped or passed as an argument.\n -e, --editor <editor> Edit the note with <editor>, overriding the editor\n specified in the `$EDITOR` environment variable.\n -l, --last Edit the last modified item.\n --overwrite Overwrite existing content with <content> and\n standard input.\n --prepend Prepend <content> and standard input before\n existing content.\n\nDescription:\n Open the specified note in `$EDITOR` or <editor> if specified.\n Content piped to `nb edit` or passed using the `--content` option\n is appended to the file without opening it in the editor,\n unless the `--edit` flag is specified.\n\n Non-text files are opened in your system's preferred app or program for\n that file type.\n\nRead More:\n https://github.com/xwmx/nb#editing\n\nSee Also:\n nb help add\n nb help browse\n nb help delete\n nb help move\n nb help show\n\nExamples:\n nb edit 3\n nb edit example.md\n nb edit \"A Document Title\"\n echo \"Content to append.\" | nb edit 1\n nb 3 edit\n nb example:edit 12\n nb edit example:12\n nb example:12 edit\n nb e 3\n nb 3 e\n nb e example:12\n nb example:12 e\n\nShortcut Alias:\n nb e\n```\n\n#### `env`\n\n[↑](#-help) · See also:\n[Installation](#installation),\n[`completions`](#completions),\n[`init`](#init),\n[`update`](#update),\n[`version`](#version)\n\n```text\nUsage:\n nb env [-l | --long]\n nb env [install | update] [--ace | --mathjax]\n\nSubcommands:\n (default) Print environment and configuration information.\n install Install dependencies on supported systems.\n update Update dependencies.\n\nOptions:\n --ace Install or update Ace editor [1][2].\n -l, --long Print additional environmental information.\n --mathjax Install or update MathJax [3].\n\n 1. https://github.com/ajaxorg/ace\n 2. https://github.com/ajaxorg/ace-builds\n 3. https://github.com/mathjax/MathJax\n\nDescription:\n Print program environment and configuration information, or install\n dependencies.\n\nRead More:\n https://github.com/xwmx/nb#installation\n\nSee Also:\n nb help completions\n nb help init\n nb help update\n nb help version\n```\n\n#### `export`\n\n[↑](#-help) · See also:\n[Import / Export](#%EF%B8%8F-import--export),\n[`browse`](#browse),\n[`import`](#import)\n\n```text\nUsage:\n nb export ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n <path> [-f | --force] [<pandoc options>...]\n nb export notebook <name> [<path>]\n nb export pandoc ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [<pandoc options>...]\n\nOptions:\n -f, --force Skip the confirmation prompt when overwriting an existing file.\n\nSubcommands:\n (default) Export a file to <path>. If <path> has a different extension\n than the source note, convert the note using `pandoc`.\n notebook Export the notebook <name> to the current directory or <path>.\n Alias for `nb notebooks export`.\n pandoc Export the file to standard output or a file using `pandoc`.\n `export pandoc` prints to standard output by default.\n\nDescription:\n Export a file or notebook.\n\n If Pandoc [1] is available, convert the note from its current format\n to the format of the output file as indicated by the file extension\n in <path>. Any additional arguments are passed directly to Pandoc.\n See the Pandoc help information for available options.\n\n 1. https://pandoc.org/\n\nRead More:\n https://github.com/xwmx/nb#%EF%B8%8F-import--export\n\nSee Also:\n nb help browse\n nb help import\n\nExamples:\n # Export an Org note\n nb export example.org /path/to/example.org\n\n # Export a Markdown note to HTML and print to standard output\n nb export pandoc example.md --from=markdown_strict --to=html\n\n # Export a Markdown note to a .docx Microsoft Office Word document\n nb export example.md /path/to/example.docx\n\n # Export note 12 in the \"sample\" notebook to HTML\n nb export sample:12 /path/to/example.html\n```\n\n#### `folders`\n\n[↑](#-help) · See also:\n[Folders](#-folders),\n[`add`](#add),\n[`delete`](#delete),\n[`list`](#list),\n[`ls`](#ls)\n\n```text\nUsage:\n nb folders add [<notebook>:][<folder-path>/]<folder-name>\n nb folders delete [<notebook>:][<folder-path>/]<folder-name>\n nb folders <list-options>...\n\nSubcommands:\n (default) List folders.\n add Add a new folder.\n delete Delete a folder.\n\nDescription:\n Add, delete, and list folders.\n\nRead More:\n https://github.com/xwmx/nb#-folders\n\nSee Also:\n nb help add\n nb help delete\n nb help list\n nb help ls\n\nExamples:\n nb folders\n nb folders add example\n nb folders delete example:sample\n\nAlias:\n nb folder\n\nShortcut Alias:\n nb f\n```\n\n#### `git`\n\n[↑](#-help) · See also:\n[Git Sync](#-git-sync),\n[History](#-revision-history),\n[`history`](#history),\n[`remote`](#remote),\n[`run`](#run),\n[`status`](#status),\n[`sync`](#sync)\n\n```text\nUsage:\n nb git [checkpoint [<message>] | dirty]\n nb git <git-options>...\n\nSubcommands:\n checkpoint Create a new git commit in the current notebook and sync with\n the remote if `nb set auto_sync` is enabled.\n dirty 0 (success, true) if there are uncommitted changes in the\n current notebook. 1 (error, false) if the notebook is clean.\n\nDescription:\n Run `git` commands within the current notebook directory.\n\nRead More:\n https://github.com/xwmx/nb#-git-sync\n https://github.com/xwmx/nb#-revision-history\n\nSee Also:\n nb help history\n nb help remote\n nb help run\n nb help status\n nb help sync\n\nExamples:\n nb git status\n nb git diff\n nb git log\n nb example:git status\n```\n\n#### `help`\n\n[↑](#-help) · See also:\n[`nb help`](#nb-help)\n\n```text\nUsage:\n nb help [<subcommand>] [-p | --print]\n nb help [-c | --colors] | [-r | --readme] | [-s | --short] [-p | --print]\n\nOptions:\n -c, --colors View information about color themes and color settings.\n -p, --print Print to standard output / terminal.\n -r, --readme View the `nb` README file.\n -s, --short Print shorter help without subcommand descriptions.\n\nDescription:\n Print the program help information. When a subcommand name is passed, print\n the help information for the subcommand.\n\nExamples:\n nb help\n nb help add\n nb help import\n nb h notebooks\n nb h e\n\nShortcut Alias:\n nb h\n```\n\n#### `history`\n\n[↑](#-help) · See also:\n[History](#-revision-history),\n[Git Sync](#-git-sync),\n[`git`](#git),\n[`remote`](#remote),\n[`status`](#status),\n[`sync`](#sync)\n\n```text\nUsage:\n nb history [<notebook>:][<folder-path>/][<id> | <filename> | <title>]\n\nDescription:\n Display notebook history using `tig` [1] (if available) or `git log`.\n When a note is specified, the history for that note is displayed.\n\n 1. https://github.com/jonas/tig\n\nRead More:\n https://github.com/xwmx/nb#-revision-history\n https://github.com/xwmx/nb#-git-sync\n\nSee Also:\n nb help git\n nb help remote\n nb help status\n nb help sync\n\nExamples:\n nb history\n nb history example.md\n nb 3 history\n nb history example:\n nb example:history\n nb example:history 12\n nb history example:12\n nb example:12 history\n```\n\n#### `import`\n\n[↑](#-help) · See also:\n[Import / Export](#%EF%B8%8F-import--export),\n[Images](#-images),\n[`add`](#add),\n[`export`](#export)\n\n```text\nUsage:\n nb import [bookmarks | copy | download | move] (<path>... | <url>)\n [--convert] [<notebook>:][<folder-path>/][<filename>]\n nb import notebook <path> [<name>]\n\nOptions:\n --convert Convert HTML content to Markdown.\n\nSubcommands:\n (default) Copy or download the file(s) at <path> or <url>.\n bookmarks Import bookmarks from a Chrome, Firefox, or Edge export file.\n copy Copy the file(s) at <path> into the current notebook.\n download Download the file at <url> into the current notebook.\n move Move the file(s) at <path> into the current notebook.\n notebook Import the local notebook at <path> to make it global.\n\nDescription:\n Copy, move, or download files into `nb`, import bookmarks, or import\n a local notebook to make it global.\n\nDescription:\n Copy, move, or download files into the current notebook or import\n a local notebook to make it global.\n\nRead More:\n https://github.com/xwmx/nb#%EF%B8%8F-import--export\n\nSee Also:\n nb help add\n nb help export\n\nExamples:\n nb import ~/Pictures/example.png\n nb import ~/Documents/example.docx\n nb import https://example.com/example.pdf\n nb example:import https://example.com/example.jpg\n nb import ./*\n nb import ./*.md\n nb import ~/Pictures/example.png example-notebook:\n nb import ~/Documents/example.docx example-folder/\n\nShortcut Alias:\n nb i\n```\n\n#### `init`\n\n[↑](#-help) · See also: [`notebooks`](#notebooks)\n\n```text\nUsage:\n nb init [<remote-url> [<branch>]] [--author] [--email <email>]\n [--name <name>]\n\nOptions:\n --author Display the local email and name config prompt.\n --email <email> Set the local commit author email address to <email>.\n --name <name> Set the local commit author name to <name>.\n\nDescription:\n Initialize the initial \"home\" notebook and generate a configuration file at:\n\n ~/.nbrc\n\n Pass optional <remote-url> and <branch> arguments to create the initial\n \"home\" notebook using a clone of an existing notebook.\n\nSee Also:\n nb help notebooks\n\nExamples:\n nb init\n nb init https://github.com/example/example.git\n nb init https://github.com/example/example.git example-branch\n```\n\n#### `list`\n\n[↑](#-help) · See also:\n[Listing & Filtering](#listing--filtering),\n[`browse`](#browse),\n[`ls`](#ls),\n[`pin`](#pin),\n[`search`](#search),\n[`unpin`](#unpin)\n\n```text\nUsage:\n nb list [-e [<length>] | --excerpt [<length>]] [--filenames]\n [-f | --folders-first] [-n <limit> | --limit <limit> | --<limit>]\n [--no-id] [--no-indicator] [-p <number> | --page <number>] [--pager]\n [--paths] [-s | --sort] [-r | --reverse] [--tags]\n [-t <type> | --type <type> | --<type>]\n [<notebook>:][<folder-path>/][<id> | <filename> | <path> | <query>]\n\nOptions:\n -e, --excerpt [<length>] Print an excerpt <length> lines long under\n each note's filename [default: 3].\n --filenames Print the filename for each note.\n -f, --folders-first Print folders before other items.\n -n, --limit <limit>, --<limit> The maximum number of notes to list.\n --no-id Don't include the id in list items.\n --no-indicator Don't include the indicator in list items.\n -p, --page <number> The page to view in the list paginated by\n a <limit> option or `nb set limit`.\n --pager Display output in the pager.\n --paths Print the full path to each item.\n -s, --sort Order notes by id.\n -r, --reverse List items in reverse order.\n --tags List tags in the notebook or folder.\n -t, --type <type>, --<type> List items of <type>. <type> can be a file\n extension or one of the following types:\n archive, audio, book, bookmark, document,\n folder, image, note, text, video\n\nDescription:\n List notes in the current notebook.\n\n When <id>, <filename>, <path>, or <title> are present, the listing for the\n matching note is displayed. When no match is found, titles and filenames\n are searched for any that match <query> as a case-insensitive regular\n expression.\n\nRead More:\n https://github.com/xwmx/nb#listing--filtering\n\nIndicators:\n 🔉 Audio\n 📖 Book\n 🔖 Bookmark\n 🔒 Encrypted\n 📂 Folder\n 🌄 Image\n 📄 PDF, Word, or Open Office document\n 📹 Video\n\nSee Also:\n nb help browse\n nb help ls\n nb help pin\n nb help search\n nb help unpin\n\nExamples:\n nb list\n nb list example.md -e 10\n nb list --excerpt --no-id\n nb list --filenames --reverse\n nb list \"^Example.*\"\n nb list --10\n nb list --type document\n nb example:list\n```\n\n#### `ls`\n\n[↑](#-help) · See also:\n[Listing & Filtering](#listing--filtering),\n[`browse`](#browse),\n[`list`](#list),\n[`pin`](#pin),\n[`search`](#search),\n[`unpin`](#unpin)\n\n```text\nUsage:\n nb ls [-a | --all] [-b | --browse] [-e [<length>] | --excerpt [<length>]]\n [--filenames] [-f | --folders-first] [-g | --gui]\n [-n <limit> | --limit <limit> | --<limit>] [--no-footer] [--no-header]\n [--no-id] [--no-indicator] [-p <number> | --page <number>] [--pager]\n [--paths] [-s | --sort] [-r | --reverse] [--tags]\n [-t <type> | --type <type> | --<type>]\n [<notebook>:][<folder-path>/][<id> | <filename> | <path> | <query>]\n\nOptions:\n -a, --all Print all items in the notebook. Equivalent\n to no limit.\n -b, --browse Open the specified item or current notebook\n with `browse` in a terminal web browser.\n -e, --excerpt [<length>] Print an excerpt <length> lines long under\n each note's filename [default: 3].\n --filenames Print the filename for each note.\n -f, --folders-first Print folders before other items.\n -g, --gui Open the specified item or current notebook\n with `browse` in a GUI web browser.\n -n, --limit <limit>, --<limit> The maximum number of listed items.\n [default: 15]\n --no-footer Print without footer.\n --no-header Print without header.\n --no-id Don't include the id in list items.\n --no-indicator Don't include the indicator in list items.\n -p, --page <number> The page to view in the list paginated by\n a <limit> option or `nb set limit`.\n --pager Display output in the pager.\n --paths Print the full path to each item.\n -s, --sort Order notes by id.\n -r, --reverse List items in reverse order.\n --tags List tags in the notebook or folder.\n -t, --type <type>, --<type> List items of <type>. <type> can be a file\n extension or one of the following types:\n archive, audio, book, bookmark, document,\n folder, image, note, text, video\n\nDescription:\n List notebooks and notes in the current notebook, displaying note titles\n when available. `nb ls` is a combination of `nb notebooks` and\n `nb list` in one view.\n\n When <id>, <filename>, <path>, or <title> are present, the listing for the\n matching note is displayed. When no match is found, titles and filenames\n are searched for any that match <query> as a case-insensitive regular\n expression.\n\n Options are passed through to `list`. For more information, see\n `nb help list`.\n\nRead More:\n https://github.com/xwmx/nb#listing--filtering\n\nIndicators:\n 🔉 Audio\n 📖 Book\n 🔖 Bookmark\n 🔒 Encrypted\n 📂 Folder\n 🌄 Image\n 📄 PDF, Word, or Open Office document\n 📹 Video\n\nSee Also:\n nb help browse\n nb help list\n nb help pin\n nb help search\n nb help unpin\n\nExamples:\n nb\n nb --all\n nb ls\n nb ls example.md -e 10\n nb ls --excerpt --no-id\n nb ls --reverse\n nb ls \"^Example.*\"\n nb ls --10\n nb ls --type document\n nb example:\n nb example: -ae\n nb example:ls\n\nShortcut Alias:\n nb\n```\n\n#### `move`\n\n[↑](#-help) · See also:\n[Moving & Renaming](#-moving--renaming),\n[`copy`](#copy),\n[`delete`](#delete),\n[`edit`](#edit)\n\n```text\nUsage:\n nb move ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n ([<notebook>:][<path>] | --reset | --to-bookmark | --to-note |\n --to-title | --to-todo) [-f | --force]\n\nOptions:\n -f, --force Skip the confirmation prompt.\n --reset Reset the filename to the last modified timestamp.\n --to-bookmark Preserve the existing filename and replace the extension\n with \".bookmark.md\" to convert the note to a bookmark.\n --to-note Preserve the existing filename and replace the bookmark's\n \".bookmark.md\" extension with \".md\" to convert the bookmark\n to a Markdown note.\n --to-title Set the filename to the note title, lowercased with spaces\n and disallowed filename characters replaced with underscores.\n --to-todo Preserve the existing filename and replace the extension\n with \".todo.md\" to convert the note to a todo.\n\nDescription:\n Move or rename a note. Move the note to <path> or change the file type.\n When the file extension is omitted, the existing extension is used.\n When only a file extension is specified, only the extension will be updated.\n\n `nb move` and `nb rename` are aliases and can be used interchangeably.\n\nRead More:\n https://github.com/xwmx/nb#-moving--renaming\n\nSee Also:\n nb help copy\n nb help delete\n nb help edit\n\nExamples:\n # move \"example.md\" to \"sample.org\"\n nb move example.md sample.org\n\n # rename note 3 (\"example.md\") to \"New Name.md\"\n nb rename 3 \"New Name\"\n\n # rename \"example.bookmark.md\" to \"New Name.bookmark.md\"\n nb move example.bookmark.md \"New Name\"\n\n # rename note 3 (\"example.md\") to a bookmark named \"example.bookmark.md\"\n nb rename 3 --to-bookmark\n\n # move note 12 into \"Sample Folder\" in the \"demo\" notebook\n nb move example:12 demo:Sample\\ Folder/\n\n # rename note 12 in the \"example\" notebook to \"sample.md\"\n nb rename example:12 \"sample.md\"\n\n # change the file extension of note 5 to .org\n nb rename 5 .org\n\nAlias:\n nb rename\n\nShortcut Alias:\n nb mv\n```\n\n#### `notebooks`\n\n[↑](#-help) · See also:\n[Notebooks](#-notebooks),\n[`archive`](#archive),\n[`history`](#history),\n[`move`](#move),\n[`remote`](#remote),\n[`status`](#status),\n[`sync`](#sync),\n[`unarchive`](#unarchive),\n[`use`](#use)\n\n```text\nUsage:\n nb notebooks [<name> | <query>] [--ar | --archived] [--global] [--local]\n [--names] [--paths] [--unar | --unarchived]\n nb notebooks add ([<name>] [<remote-url> [<branch>... | --all]]) [--author]\n [--email <email>] [--name <name>]\n nb notebooks (archive | open | peek | status | unarchive) [<name>]\n nb notebooks author [<name> | <path>] [--email <email>] [--name <name>]\n nb notebooks current [--path | --selected | --filename [<filename>]]\n [--global | --local]\n nb notebooks delete <name> [-f | --force]\n nb notebooks (export <name> [<path>] | import <path>)\n nb notebooks init [<path> [<remote-url> [<branch>]]] [--author]\n [--email <email>] [--name <name>]\n nb notebooks rename <old-name> <new-name>\n nb notebooks select <selector>\n nb notebooks show (<name> | <path> | <selector>) [--ar | --archived]\n [--escaped | --name | --path | --filename [<filename>]]\n nb notebooks use <name>\n\nOptions:\n --all Add notebooks from all remote branches.\n --ar, --archived List archived notebooks, or return archival status\n with `show`.\n --author Set the notebook's commit author email and name.\n --email <email> Set the notebook's commit author email to <email>.\n --escaped Print the notebook name with spaces escaped.\n --filename [<filename>] Print an available filename for the notebooks. When\n <filename> is provided, check for an existing file\n and provide a filename with an appended sequence\n number for uniqueness.\n -f, --force Skip the confirmation prompt.\n --global List global notebooks or the notebook set globally\n with `use`.\n --local Exit with 0 if current within a local notebook,\n otherwise exit with 1.\n --name, --names Print the notebook name.\n --name <name> Set the notebook's commit author name to <name>.\n --path, --paths Print the notebook path.\n --selected Exit with 0 if the current notebook differs from\n the current global notebook, otherwise exit with 1.\n --unar, --unarchived Only list unarchived notebooks.\n\nSubcommands:\n (default) List notebooks.\n add Create a new global notebook. When <remote-url> is specified,\n create one or more new global notebook by cloning selected\n or specified <branch>es from <remote-url>.\n Aliases: `nb notebooks create`, `nb notebooks new`\n archive Set the current notebook or notebook <name> to \"archived\" status.\n author Configure the commit author email and name for the notebook.\n current Print the current notebook name or path.\n delete Delete a notebook.\n export Export the notebook <name> to the current directory or <path>,\n making it usable as a local notebook.\n import Import the local notebook at <path> to make it global.\n init Create a new local notebook. Specify a <path> or omit to\n initialize the current working directory as a local notebook.\n Specify <remote-url> to clone an existing notebook.\n open Open the current notebook directory or notebook <name> in the\n file browser, explorer, or finder.\n Shortcut Alias: `o`\n peek Open the current notebook directory or notebook <name> in the\n first tool found in the following list:\n `ranger` [1], `mc` [2], `vifm` [3], `joshuto` [4], `lsd` [5],\n `eza` [6], or `ls`.\n Shortcut Alias: `p`\n rename Rename a notebook. Aliases: `move`, `mv`\n select Set the current notebook from a colon-prefixed selector.\n Not persisted. Selection format: <notebook>:<identifier>\n status Print the archival status of the current notebook or\n notebook <name>.\n show Show and return information about a specified notebook.\n unarchive Remove \"archived\" status from the current notebook or notebook <name>.\n use Switch to a notebook.\n\n 1. https://ranger.github.io/\n 2. https://en.wikipedia.org/wiki/Midnight_Commander\n 3. https://vifm.info/\n 4. https://github.com/kamiyaa/joshuto\n 5. https://github.com/lsd-rs/lsd\n 6. https://github.com/eza-community/eza\n\nDescription:\n Manage notebooks.\n\nRead More:\n https://github.com/xwmx/nb#-notebooks\n\nSee Also:\n nb help archive\n nb help history\n nb help move\n nb help remote\n nb help status\n nb help sync\n nb help unarchive\n nb help use\n\nExamples:\n nb notebooks --names\n nb notebooks add sample\n nb notebooks add example https://github.com/example/example.git\n nb nb current --path\n nb nb archive example\n\nShortcut Aliases:\n nb n\n nb nb\n```\n\n#### `open`\n\n[↑](#-help) · See also:\n[Viewing Bookmarks](#viewing-bookmarks),\n[Images](#-images),\n[`bookmark`](#bookmark),\n[`browse`](#browse),\n[`peek`](#peek),\n[`show`](#show)\n\n```text\nUsage:\n nb open ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n\nDescription:\n Open an item or notebook. When the item is a bookmark, open the bookmarked\n page in your system's primary web browser. When the item is in a text format\n or any other file type, `open` is the equivalent of `edit`. `open`\n with a notebook opens the notebook folder in the system's file browser.\n\nRead More:\n https://github.com/xwmx/nb#viewing-bookmarks\n\nSee also:\n nb help bookmark\n nb help browse\n nb help peek\n nb help show\n\nExamples:\n nb open 3\n nb open example.bookmark.md\n nb 3 open\n nb example:open 12\n nb open example:12\n nb example:12 open\n nb o 3\n nb 3 o\n nb o example:12\n nb example:12 o\n\nShortcut Alias:\n nb o\n```\n\n#### `peek`\n\n[↑](#-help) · See also:\n[Viewing Bookmarks](#viewing-bookmarks),\n[`bookmark`](#bookmark),\n[`browse`](#browse),\n[`open`](#open),\n[`show`](#show)\n\n```text\nUsage:\n nb peek ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n\nDescription:\n View an item or notebook in the terminal. When the item is a bookmark, view\n the bookmarked page in your terminal web browser. When the note is in a text\n format or any other file type, `peek` is the equivalent of `show`. When\n used with a notebook, `peek` opens the notebook folder first tool found in\n the following list: `ranger` [1], `mc` [2], `vifm` [3], `joshuto` [4],\n `lsd` [5], eza` [6], or `ls`.\n\n 1. https://ranger.github.io/\n 2. https://en.wikipedia.org/wiki/Midnight_Commander\n 3. https://vifm.info/\n 4. https://github.com/kamiyaa/joshuto\n 5. https://github.com/lsd-rs/lsd\n 6. https://github.com/eza-community/eza\n\nRead More:\n https://github.com/xwmx/nb#viewing-bookmarks\n\nSee also:\n nb help bookmark\n nb help browse\n nb help open\n nb help show\n\nExamples:\n nb peek 3\n nb peek example.bookmark.md\n nb 3 peek\n nb example:peek 12\n nb peek example:12\n nb example:12 peek\n nb p 3\n nb 3 p\n nb p example:12\n nb example:12 p\n\nAlias:\n nb preview\n\nShortcut Alias:\n nb p\n```\n\n#### `pin`\n\n[↑](#-help) · See also:\n[Pinning](#-pinning),\n[`browse`](#browse),\n[`list`](#list),\n[`ls`](#ls),\n[`unpin`](#unpin)\n\n```text\nUsage:\n nb pin ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n\nDescription:\n Pin an item so it appears first in lists.\n\nRead More:\n https://github.com/xwmx/nb#-pinning\n\nSee Also:\n nb help browse\n nb help list\n nb help ls\n nb help unpin\n\nExamples:\n nb pin 123\n nb pin example:sample/321\n```\n\n#### `plugins`\n\n[↑](#-help) · See also:\n[Plugins](#-plugins),\n[Plugin Help](#plugin-help),\n[`subcommands`](#subcommands-1)\n\n```text\nUsage:\n nb plugins [<name>] [--paths] [--force]\n nb plugins install [<path> | <url>] [--force]\n nb plugins uninstall <name>\n\nOptions:\n --paths Print the full path to each plugin.\n\nSubcommands:\n (default) List plugins.\n install Install a plugin from a <path> or <url>.\n uninstall Uninstall the specified plugin.\n\nDescription:\n Manage plugins and themes.\n\nRead More:\n https://github.com/xwmx/nb#-plugins\n\nPlugin Extensions:\n .nb-theme Plugins defining color themes.\n .nb-plugin Plugins defining new subcommands and functionality.\n\nSee Also:\n nb help subcommands\n\nAlias:\n nb plugin\n```\n\n#### `remote`\n\n[↑](#-help) · See also:\n[Git Sync](#-git-sync),\n[History](#-revision-history),\n[`history`](#history),\n[`notebooks`](#notebooks),\n[`status`](#status),\n[`sync`](#sync)\n\n```text\nUsage:\n nb remote\n nb remote branches [<url>]\n nb remote delete <branch-name>\n nb remote remove\n nb remote rename [<branch-name>] <name>\n nb remote reset <branch-name>\n nb remote set <url> [<branch-name>]\n\nSubcommands:\n (default) Print the remote URL and branch for the notebook.\n branches List branches on the current or given remote.\n delete Delete <branch-name> from the remote.\n Caveat: only orphan branches can be deleted.\n remove Remove the remote URL from the notebook.\n Alias: `unset`\n rename Rename the current orphan branch or <branch-name> to <name>.\n Caveat: only orphan branches can be renamed.\n reset Reset <branch-name> on the remote to a blank initial state.\n set Set the remote URL and branch for the notebook.\n\nDescription:\n Configure the remote repository URL and branch for the current notebook.\n\nRead More:\n https://github.com/xwmx/nb#-git-sync\n https://github.com/xwmx/nb#-revision-history\n\nSee Also:\n nb help history\n nb help notebooks\n nb help status\n nb help sync\n\nExamples:\n nb remote set https://github.com/example/example.git\n nb remote remove\n nb example-notebook:remote set https://github.com/example/example.git\n```\n\n#### `run`\n\n[↑](#-help) · See also: [`git`](#git), [`shell`](#shell)\n\n```text\nUsage:\n nb run <command> [<arguments>...]\n\nDescription:\n Run shell commands within the current notebook directory.\n\nSee Also:\n nb help git\n nb help shell\n\nExamples:\n nb run ls -la\n nb run find . -name 'example*'\n nb run rg example\n```\n\n#### `search`\n\n[↑](#-help) · See also:\n[Search](#-search),\n[`browse`](#browse),\n[`list`](#list),\n[`ls`](#ls)\n\n```text\nUsage:\n nb search ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n <query>... [-a | --all] [--and <query>] [--not <query>] [--or <query>]\n [-l | --list] [--path] [-t <tag1>,<tag2>... | --tag <tag1>,<tag2>...]\n [-t | --tags] [--type <type> | --<type>] [--utility <name>]\n\nOptions:\n -a, --all Search all unarchived notebooks.\n --and <query> Add a AND query.\n -l, --list Print the id, filename, and title listing for\n each matching file, without the excerpt.\n --not <query> Add a NOT query.\n --or <query> Add an OR query.\n --path Print the full path for each matching file.\n -t, --tag <tag1>,<tag2>... A comma-separated list of tags.\n -t, --tags List all tags found in the notebook.\n --type <type>, --<type> Search items of <type>. <type> can be a file\n extension or one of the following types:\n archive, audio, book, bookmark, document,\n folder, image, note, text, video\n --utility <name> The name of the search utility to search with.\n\nDescription:\n Perform a full text search.\n\n Multiple query arguments are treated as AND queries, returning items that\n match all queries. AND queries can also be specified with the --and <query>\n option. The --or <query> option can be used to specify an OR query,\n returning items that match at least one of the queries. --not <query>\n excludes items matching <query>.\n\n `nb search` is powered by Git's built-in `git grep` tool. `nb` also\n supports performing searches with alternative search tools using the\n --utility <name> option.\n\n Supported alternative search tools:\n 1. `rga` https://github.com/phiresky/ripgrep-all\n 2. `rg` https://github.com/BurntSushi/ripgrep\n 3. `ag` https://github.com/ggreer/the_silver_searcher\n 4. `ack` https://beyondgrep.com/\n 5. `grep` https://en.wikipedia.org/wiki/Grep\n\nRead More:\n https://github.com/xwmx/nb#-search\n\nSee Also:\n nb help browse\n nb help list\n nb help ls\n\nExamples:\n # search current notebook for \"example query\"\n nb search \"example query\"\n\n # search the notebook \"example\" for \"example query\"\n nb search example: \"example query\"\n\n # search all notebooks for \"example query\" and list matching items\n nb search \"example query\" --all --list\n\n # search for items matching \"Example\" AND \"Demo\"\n nb search \"Example\" \"Demo\"\n nb search \"Example\" --and \"Demo\"\n\n # search for items matching \"Example\" OR \"Sample\"\n nb search \"Example|Sample\"\n nb search \"Example\" --or \"Sample\"\n\n # search for items matching both \"Example\" AND \"Sample\", and NOT \"Demo\"\n nb search \"Example\" --and \"Sample\" --not \"Demo\"\n\n # search with a regular expression\n nb search \"\\d\\d\\d-\\d\\d\\d\\d\"\n\n # search for tags\n nb search --tag tag1 -t tag2\n\n # search the current notebook for \"example query\"\n nb q \"example query\"\n\n # search all notebooks for \"example query\" and list matching items\n nb q -la \"example query\"\n\nShortcut Alias:\n nb q\n```\n\n#### `settings`\n\n[↑](#-help) · See also:\n[`set` & `settings`](#%EF%B8%8F-set--settings),\n[Variables](#-variables),\n[`unset`](#unset)\n\n```text\nUsage:\n nb set [<name> [<value>] | <number> [<value>]]\n nb settings colors [<number> | themes]\n nb settings edit\n nb settings get (<name> | <number>)\n nb settings list [--long]\n nb settings set (<name> | <number>) <value>\n nb settings show (<name> | <number>)\n nb settings unset (<name> | <number>)\n\nSubcommands:\n (default) Open the settings prompt, to <name> or <number>, if present.\n When <value> is also present, assign <value> to the setting.\n colors Print a table of available colors and their xterm color numbers.\n When <number> is provided, print the number in its color.\n `settings colors themes` prints a list of installed themes.\n edit Open the `nb` configuration file in `$EDITOR`.\n get Print the value of a setting.\n list List information about available settings.\n set Assign <value> to a setting.\n show Print the help information and current value of a setting.\n unset Unset a setting, returning it to the default value.\n\nDescription:\n Configure `nb`. Use `nb settings set` to customize a setting and\n `nb settings unset` to restore the default for a setting.\n\n Use the `nb set` alias to quickly assign values to settings:\n\n nb set color_theme blacklight\n nb set limit 40\n\nRead More:\n https://github.com/xwmx/nb#%EF%B8%8F-set--settings\n\nSee Also:\n nb help unset\n\nExamples:\n nb settings\n nb set 5 \"org\"\n nb set color_primary 105\n nb set unset color_primary\n nb set color_secondary unset\n nb settings colors\n nb settings colors 105\n nb set limit 15\n\nAlias:\n nb set\n```\n\n##### `auto_sync`\n\n[↑](#-help) · See also: [Git Sync](#-git-sync)\n\n```text\n[1] auto_sync\n ---------\n By default, operations that trigger a git commit like `add`, `edit`,\n and `delete` will sync notebook changes to the remote repository, if\n the notebook's remote is set. To disable this behavior, set this to \"0\".\n\n • Default Value: 1\n```\n\n##### `color_primary`\n\n[↑](#-help) · See also: [Color Themes](#-color-themes), [Custom Color Themes](#custom-color-themes)\n\n```text\n[2] color_primary\n -------------\n The primary color used to highlight identifiers and messages.\n\n • Supported Values: xterm color numbers 0 through 255.\n • Default Value: 68 (blue) for 256 color terminals,\n 4 (blue) for 8 color terminals.\n```\n\n##### `color_secondary`\n\n[↑](#-help) · See also: [Color Themes](#-color-themes), [Custom Color Themes](#custom-color-themes)\n\n```text\n[3] color_secondary\n ---------------\n The color used for lines and footer elements.\n\n • Supported Values: xterm color numbers 0 through 255.\n • Default Value: 8\n```\n\n##### `color_theme`\n\n[↑](#-help) · See also: [Color Themes](#-color-themes)\n\n```text\n[4] color_theme\n -----------\n The color theme.\n\n To view screenshots of the built-in themes, visit:\n\n https://git.io/nb-docs-color-themes\n\n `nb` supports custom, user-defined themes. To learn more, run:\n\n nb help --colors\n\n To change the syntax highlighting theme, use:\n\n nb set syntax_theme\n\n • Available themes:\n\n blacklight\n console\n desert\n electro\n forest\n nb\n ocean\n raspberry\n smoke\n unicorn\n utility\n\n • Default Value: nb\n```\n\n##### `default_extension`\n\n[↑](#-help) · See also: [Adding](#adding)\n\n```text\n[5] default_extension\n -----------------\n The default extension to use for note files. Change to \"org\" for\n Org files, \"rst\" for reStructuredText, \"txt\" for plain text, or\n whatever you prefer.\n\n • Default Value: md\n```\n\n##### `editor`\n\n[↑](#-help) · See also: [Editing](#editing), [Adding](#adding)\n\n```text\n[6] editor\n ------\n The command line text editor used by `nb`.\n\n • Example Values:\n\n atom\n code\n emacs\n hx\n macdown\n mate\n micro\n nano\n pico\n subl\n vi\n vim\n```\n\n##### `encryption_tool`\n\n[↑](#-help) · See also: [Password-Protected Encrypted Notes and Bookmarks](#password-protected-encrypted-notes-and-bookmarks)\n\n```text\n[7] encryption_tool\n ---------------\n The tool used for encrypting notes.\n\n • Supported Values: openssl, gpg\n • Default Value: openssl\n```\n\n##### `footer`\n\n[↑](#-help) · See also: [Listing & Filtering](#listing--filtering)\n\n```text\n[8] footer\n ------\n By default, `nb` and `nb ls` include a footer with example commands.\n To hide this footer, set this to \"0\".\n\n • Default Value: 1\n```\n\n##### `header`\n\n[↑](#-help) · See also: [Listing & Filtering](#listing--filtering)\n\n```text\n[9] header\n ------\n By default, `nb` and `nb ls` include a header listing available notebooks.\n Set the alignment, or hide the header with \"0\".\n\n • Supported Values:\n\n 0 Hide Header\n 1 Dynamic Alignment\n - Left justified when list is shorter than terminal width.\n - Center aligned when list is longer than terminal width.\n 2 Center Aligned (default)\n 3 Left Justified\n\n • Default Value: 1\n```\n\n##### `limit`\n\n[↑](#-help) · See also: [Listing & Filtering](#listing--filtering)\n\n```text\n[10] limit\n -----\n The maximum number of items included in the `nb` and `nb ls` lists.\n Set to `auto` to automatically limit output to the current terminal height.\n Set a maximum auto limit with `auto^<max>`, e.g., `auto^15`.\n Subtract an auto limit offset for multiline prompts with `auto-<offset>`.\n Add an auto limit offet with `auto+<offset>`.\n Combine both modifiers with `auto-<offset>^<max>` or `auto+<offset>^<max>`.\n\n • Example Values:\n\n 15\n auto\n auto^15\n auto-2\n auto+2\n auto-2^15\n auto+2^15\n\n • Default Value: 15\n```\n\n##### `nb_dir`\n\n[↑ ](#-help)\n\n```text\n[11] nb_dir\n ------\n The location of the directory that contains the notebooks.\n\n For example, to sync all notebooks with Dropbox, create a folder at\n `~/Dropbox/Notes` and run: `nb settings set nb_dir ~/Dropbox/Notes`\n\n • Default Value: ~/.nb\n```\n\n##### `syntax_theme`\n\n[↑](#-help) · See also: [Terminal Syntax Highlighting](#terminal-syntax-highlighting-theme)\n\n```text\n[12] syntax_theme\n ------------\n The syntax highlighting theme. View examples with:\n\n bat --list-themes\n\n • Available themes:\n\n 1337\n DarkNeon\n Dracula\n GitHub\n Monokai Extended\n Monokai Extended Bright\n Monokai Extended Light\n Monokai Extended Origin\n Nord\n OneHalfDark\n OneHalfLight\n Solarized (dark)\n Solarized (light)\n Sublime Snazzy\n TwoDark\n ansi-dark\n ansi-light\n base16\n base16-256\n gruvbox\n gruvbox-light\n gruvbox-white\n zenburn\n\n • Default Value: base16\n```\n\n#### `shell`\n\n[↑](#-help) · See also:\n[Interactive Shell](#-interactive-shell),\n[`run`](#run)\n\n```text\nUsage:\n nb shell [<subcommand> [<options>...] | --clear-history]\n\nOptions:\n --clear-history Clear the `nb` shell history.\n\nDescription:\n Start the `nb` interactive shell. Type \"exit\" to exit.\n\n `nb shell` recognizes all `nb` subcommands and options, providing\n a streamlined, distraction-free approach for working with `nb`.\n\n When <subcommand> is present, the command will run as the shell is opened.\n\nRead More:\n https://github.com/xwmx/nb#-interactive-shell\n\nSee Also:\n nb help run\n\nExample:\n $ nb shell\n nb> ls 3\n [3] Example\n\n nb> edit 3 --content \"New content.\"\n Updated: [3] Example\n\n nb> notebook\n home\n\n nb> exit\n $\n```\n\n#### `show`\n\n[↑](#-help) · See also:\n[Viewing](#viewing),\n[Images](#-images),\n[`browse`](#browse),\n[`open`](#open),\n[`peek`](#peek)\n\n```text\nUsage:\n nb show ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [[-a | --added] | [--authors] | [-b | --browse] | --filename | --id |\n --info-line | --path | [-p | --print] | --relative-path | [-r |\n --render] | --title | --type [<type>] | [-u | --updated]] [--no-color]\n nb show <notebook>\n\nOptions:\n -a, --added Print the date and time when the item was added.\n --authors List the git commit authors of an item.\n -b, --browse Open the item with `nb browse`.\n --filename Print the filename of the item.\n --id Print the id number of the item.\n --info-line Print the id, filename, and title of the item.\n --no-color Show without syntax highlighting.\n --path Print the full path of the item.\n -p, --print Print to standard output / terminal.\n --relative-path Print the item's path relative within the notebook.\n -r, --render Use `pandoc` [1] to render the file to HTML and display\n in the terminal web browser. If either `pandoc` or a\n browser are unavailable, `-r` / `--render` is ignored.\n --title Print the title of the note.\n --type [<type>] Print the file extension or, when <type> is specified,\n return true if the item matches <type>. <type> can be a\n file extension or one of the following types:\n archive, audio, bookmark, document, folder, image,\n text, video\n -u, --updated Print the date and time of the last recorded change.\n\nDescription:\n Show an item or notebook. Notes in text file formats can be rendered or\n printed to standard output. Non-text files are opened in your system's\n preferred app or program for that file type.\n\n By default, the item is opened using `less` or the program configured\n in the `$PAGER` environment variable. Use the following keys to navigate\n in `less` (see `man less` for more information):\n\n Key Function\n --- --------\n mouse scroll Scroll up or down\n arrow up or down Scroll one line up or down\n f Jump forward one window\n b Jump back one window\n d Jump down one half window\n u Jump up one half window\n /<query> Search for <query>\n n Jump to next <query> match\n q Quit\n\n To skip the pager and print to standard output, use the `-p` / `--print`\n option.\n\n `-r` / `--render` automatically uses either `w3m` [2] or `links` [3].\n To specify a preferred browser, set the `$BROWSER` environment variable\n in your .bashrc, .zshrc, or equivalent, e.g.: export BROWSER=\"links\"\n\n If `bat` [4], `highlight` [5], or Pygments [6] is installed, notes are\n printed with syntax highlighting.\n\n 1. https://pandoc.org/\n 2. https://en.wikipedia.org/wiki/W3m\n 3. https://en.wikipedia.org/wiki/Links_(web_browser)\n 4. https://github.com/sharkdp/bat\n 5. http://www.andre-simon.de/doku/highlight/en/highlight.php\n 6. https://pygments.org/\n\nRead More:\n https://github.com/xwmx/nb#viewing\n\nSee Also:\n nb help browse\n nb help open\n nb help peek\n\nExamples:\n nb show 1\n nb show example.md --render\n nb show \"A Document Title\" --print --no-color\n nb 1 show\n nb example:show 12\n nb show example:12\n nb example:12 show\n nb s 1\n nb 1 s\n nb s example:12\n nb example:12 s\n\nAlias:\n nb view\n\nShortcut Alias:\n nb s\n```\n\n#### `status`\n\n[↑](#-help) · See also:\n[Git Sync](#-git-sync),\n[History](#-revision-history),\n[`archive`](#archive),\n[`history`](#history),\n[`notebooks`](#notebooks),\n[`remote`](#remote),\n[`sync`](#sync),\n[`unarchive`](#unarchive)\n\n```text\nUsage:\n nb status [<notebook>]\n\nDescription:\n Print archival, git, and remote status for the current notebook or <notebook>.\n\nRead More:\n https://github.com/xwmx/nb#-git-sync\n https://github.com/xwmx/nb#-revision-history\n\nSee Also:\n nb help archive\n nb help history\n nb help notebooks\n nb help remote\n nb help sync\n nb help unarchive\n\nExamples:\n nb status\n nb status example\n\nShortcut Alias:\n nb st\n```\n\n#### `subcommands`\n\n[↑](#-help) · See also:\n[Plugins](#-plugins),\n[`plugins`](#plugins)\n\n```text\nUsage:\n nb subcommands [add <name>...] [alias <name> <alias>]\n [describe <name> <usage>]\n\nSubcommands:\n add Add a new subcommand.\n alias Create an <alias> of a given subcommand <name>, with linked help.\n Note that aliases must also be added with `subcommands add`.\n describe Set the usage text displayed with `nb help <subcommand>`.\n This can be assigned as a heredoc, which is recommended, or\n as a string argument.\n\nDescription:\n List, add, alias, and describe subcommands. New subcommands, aliases, and\n descriptions are not persisted, so `add`, `alias`, `describe` are\n primarily for plugins.\n\nRead More:\n https://github.com/xwmx/nb#-plugins\n\nSee Also:\n nb help plugins\n```\n\n#### `sync`\n\n[↑](#-help) · See also:\n[Git Sync](#-git-sync),\n[History](#-revision-history),\n[`history`](#history),\n[`notebooks`](#notebooks),\n[`remote`](#remote),\n[`status`](#status)\n\n```text\nUsage:\n nb sync [-a | --all]\n\nOptions:\n -a, --all Sync all unarchived notebooks.\n\nDescription:\n Sync the current notebook with its remote.\n\nPrivate Repositories and Git Credentials:\n Syncing with private repositories requires configuring git to not prompt\n for credentials.\n\n For repositories cloned over HTTPS, credentials can be cached with git.\n For repositories cloned over SSH, keys can be added to the ssh-agent.\n\n More Information:\n https://github.com/xwmx/nb#private-repositories-and-git-credentials\n\nSync Conflict Resolution:\n When `nb sync` encounters a conflict in a text file and can't merge\n overlapping local and remote changes, both versions are saved in the\n file, separated by git conflict markers. Use `nb edit` to remove the\n conflict markers and delete any unwanted text.\n\n When `nb sync` encounters a conflict in a binary file, such as an\n encrypted note or bookmark, both versions of the file are saved in the\n notebook as individual files, one with `--conflicted-copy` appended to\n the filename.\n\n More Information:\n https://github.com/xwmx/nb#sync-conflict-resolution\n\nRead More:\n https://github.com/xwmx/nb#-git-sync\n https://github.com/xwmx/nb#-revision-history\n\nSee Also:\n nb help history\n nb help notebooks\n nb help remote\n nb help status\n\nExamples:\n nb sync\n nb sync --all\n```\n\n#### `tasks`\n\n[↑](#-help) · See also:\n[Tasks](#%EF%B8%8F-tasks),\n[Todos](#-todos),\n[`do`](#do),\n[`todo`](#todo),\n[`undo`](#undo)\n\n```text\nUsage:\n nb tasks ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [open | closed] [--pager]\n\nOptions:\n --pager Display output in the pager.\n\nDescription:\n List tasks in todos, notebooks, folders, and other items.\n\nRead More:\n https://github.com/xwmx/nb#%EF%B8%8F-tasks\n https://github.com/xwmx/nb#-todos\n\nSee Also:\n nb help do\n nb help todo\n nb help undo\n\nExamples:\n nb tasks\n nb tasks open\n nb tasks closed\n nb tasks 123\n nb example:tasks open\n nb tasks closed sample/\n nb tasks closed demo:456\n\nShortcut Alias:\n nb t\n```\n\n#### `todo`\n\n[↑](#-help) · See also:\n[Todos](#-todos),\n[`do`](#do),\n[`tasks`](#tasks),\n[`undo`](#undo)\n\n```text\nUsage:\n nb todo add [<notebook>:][<folder-path>/][<filename>] <title>\n [--description <description>] [--due <date>]\n [-r (<url> | <selector>) | --related (<url> | <selector>)]\n [--tags <tag1>,<tag2>...] [--task <title>...]\n nb todo delete ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n nb todo do ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [<task-number>]\n nb todo undo ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [<task-number>]\n nb todos [<notebook>:][<folder-path>/] [open | closed] [--pager]\n [--tags <tag1>,<tag2>...]\n nb todos tasks ([<notebook>:][<folder-path>/][<id> | <filename> | <description>])\n [open | closed] [--pager]\n\nOptions:\n --description <description> Description for the todo.\n --due <date> Due date and / or time for the todo.\n --pager Display output in the pager.\n -r, --related (<url> | <selector>) Related URL or selector.\n --tags <tag1>,<tag2>... Comma-separated list of tags.\n --task <title> Task to add to the tasklist.\n\nSubcommands:\n (default) List todos.\n add Add a new todo.\n Shortcut Aliases: `nb todo a`, `nb todo +`\n delete Delete a todo.\n Shortcut Aliases: `nb todo -`\n do Mark a todo or task as done.\n tasks List tasks in todos, notebooks, folders, and other item.\n undo Unmark a todo or task as done.\n\nDescription:\n Manage todos and tasks.\n\nRead More::\n https://github.com/xwmx/nb#-todos\n\nSee Also:\n nb help do\n nb help tasks\n nb help undo\n\nExamples:\n nb todo add \"Example todo title.\"\n nb todo add Example todo title.\n nb todo add \"Sample title.\" --tags tag1,tag2 --related demo:567\n nb todos\n nb todos open\n nb todos closed\n nb example:todos open\n nb todos closed sample/\n\nAlias:\n nb todos\n\nShortcut Alias:\n nb to\n```\n\n#### `unarchive`\n\n[↑](#-help) · See also:\n[Archiving Notebooks](#archiving-notebooks),\n[`archive`](#archive),\n[`notebooks`](#notebooks),\n[`status`](#status)\n\n```text\nUsage:\n nb unarchive [<name>]\n\nDescription:\n Remove \"archived\" status from the current notebook or notebook <name>.\n\n This is an alias for `nb notebooks unarchive`.\n\nRead More:\n https://github.com/xwmx/nb#archiving-notebooks\n\nSee Also:\n nb help archive\n nb help notebooks\n nb help status\n\nExamples:\n nb unarchive\n nb unarchive example\n\nShortcut Alias:\n nb unar\n```\n\n#### `undo`\n\n[↑](#-help) · See also:\n[Todos](#-todos),\n[Tasks](#%EF%B8%8F-tasks),\n[`do`](#do),\n[`tasks`](#tasks),\n[`todo`](#todo)\n\n```text\nUsage:\n nb undo ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n [<task-number>]\n\nDescription:\n Mark a todo or task as not done.\n\nRead More:\n https://github.com/xwmx/nb#-todos\n\nSee Also:\n nb help do\n nb help tasks\n nb help todo\n\nExamples:\n nb undo 123\n nb undo example:sample/321\n nb undo 543 7\n```\n\n#### `unpin`\n\n[↑](#-help) · See also:\n[Pinning](#-pinning),\n[`browse`](#browse),\n[`list`](#list),\n[`ls`](#ls),\n[`pin`](#pin)\n\n```text\nUsage:\n nb unpin ([<notebook>:][<folder-path>/][<id> | <filename> | <title>])\n\nDescription:\n Unpin a pinned item.\n\nRead More:\n https://github.com/xwmx/nb#-pinning\n\nSee Also:\n nb help browse\n nb help list\n nb help ls\n nb help pin\n\nExamples:\n nb unpin 123\n nb unpin example:sample/321\n```\n\n#### `unset`\n\n[↑](#-help) · See also:\n[`set` & `settings`](#%EF%B8%8F-set--settings),\n[`settings`](#settings)\n\n```text\nUsage:\n nb unset (<name> | <number>)\n\nDescription:\n Unset a setting, returning it to the default value.\n\n This is an alias for `nb settings unset`.\n\nRead More:\n https://github.com/xwmx/nb#%EF%B8%8F-set--settings\n\nSee Also:\n nb help settings\n\nExamples:\n nb unset color_primary\n nb unset 2\n\nAlias:\n nb reset\n```\n\n#### `update`\n\n[↑](#-help) · See also:\n[Installation](#installation),\n[`env`](#env),\n[`version`](#version)\n\n```text\nUsage:\n nb update\n\nDescription:\n Update `nb` to the latest version. You will be prompted for\n your password if administrator privileges are required.\n\n If `nb` was installed using a package manager like npm or\n Homebrew, use the package manager's upgrade functionality instead\n of this command.\n\nRead More:\n https://github.com/xwmx/nb#installation\n\nSee Also:\n nb help env\n nb help version\n```\n\n#### `use`\n\n[↑](#-help) · See also:\n[Notebooks](#-notebooks),\n[`notebooks`](#notebooks)\n\n```text\nUsage:\n nb use <notebook>\n\nDescription:\n Switch to the specified notebook. Shortcut for `nb notebooks use`.\n\nRead More:\n https://github.com/xwmx/nb#-notebooks\n\nSee Also:\n nb help notebooks\n\nExample:\n nb use example\n\nShortcut Alias:\n nb u\n```\n\n#### `version`\n\n[↑](#-help) · See also:\n[Installation](#installation),\n[`env`](#env),\n[`update`](#update)\n\n```text\nUsage:\n nb version\n\nDescription:\n Display version information.\n\nSee Also:\n nb help env\n nb help update\n```\n\n### Plugin Help\n\n<p>\n <sup>\n <a href=\"#-help\">↑</a> ·\n <a href=\"#-plugins\">Plugins</a>,\n <a href=\"#plugins\"><code>nb plugins</code></a>\n </sup>\n</p>\n\n<div align=\"center\">\n <a href=\"#backlink\">backlink</a> ·\n <a href=\"#bump\">bump</a> ·\n <a href=\"#clip\">clip</a> ·\n <a href=\"#daily\">daily</a> ·\n <a href=\"#ebook\">ebook</a> ·\n <a href=\"#example\">example</a> ·\n <a href=\"#weather\">weather</a>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n<div align=\"center\">\n <a href=\"#-help\"> ↑ </a>\n</div>\n\n#### `backlink`\n\n[↑ ](#plugin-help)\n\n##### Install\n\n```bash\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/backlink.nb-plugin\n```\n\n##### Help\n\n```text\nUsage:\n nb backlink [--force]\n\nDescription:\n Add backlinks to notes. Crawl notes in a notebook for [[wiki-style links]]\n and append a \"Backlinks\" section to each linked file that lists passages\n referencing the note.\n\n To link to a note from within another note, surround the title of the\n target note in double square brackets:\n\n Example with link to [[Target Note Title]] in content.\n\n Depends on note-link-janitor:\n https://github.com/andymatuschak/note-link-janitor\n\n Requirement: every note in the notebook must have a title.\n```\n\n#### `bump`\n\n[↑ ](#plugin-help)\n\n##### Install\n\n```bash\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/bump.nb-plugin\n```\n\n##### Help\n\n```text\nUsage:\n nb bump [<notebook>:][<folder-path>/][<id>][<filename>][<title>]\n\nDescription:\n Bump an item to the top of the list.\n\n `bump` updates the item's modification timestamp without editing the item\n or creating a new commit.\n\nExamples:\n nb bump 123\n nb bump example:sample/456\n\nAlias:\n nb touch\n```\n\n#### `clip`\n\n[↑ ](#plugin-help)\n\n##### Install\n\n```bash\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/clip.nb-plugin\n```\n\n##### Help\n\n```text\nUsage:\n nb clip [<notebook>:][<id> | <filename> | <path> | <title> | <extension>]\n\nDescription:\n Save the clipboard contents and copy contents of text or markdown items to\n the clipboard.\n\n When called with no arguments or when no matching file is found, the text\n content on the clipboard is saved to a new file, pending a prompt.\n\nExamples:\n # copy the content of item 123 to the clipboard\n nb clip 123\n\n # save the clipboard contents to a new file with a `.js` file extension\n nb clip .js\n\n # save the clipboard contents as a new `.cr` file in the \"snippets\" notebook\n nb snippets:clip .cr\n```\n\n#### `daily`\n\n[↑ ](#plugin-help)\n\n##### Install\n\n```bash\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/daily.nb-plugin\n```\n\n##### Help\n\n```text\nUsage:\n nb daily [<content>] [--prev [<number>]]\n\nOptions:\n --prev [<number>] List previous days and show day by previous <number>.\n\nDescription:\n Add notes to a daily log. When called without arguments, the current day's\n log is displayed. When passed `<content>`, a new timestamped entry is added\n to the current day's log, which is created if it doesn't yet exist.\n\n Previous day's logs can be listed with the `--prev` option. View a previous\n day's log by passing its `<number>` in the list.\n\nExamples:\n nb daily \"Example note content.\"\n nb daily\n nb daily --prev\n nb daily --prev 3\n```\n\n#### `ebook`\n\n[↑ ](#plugin-help)\n\n##### Install\n\n```bash\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/ebook.nb-plugin\n```\n\n##### Help\n\n```text\nUsage:\n nb ebook new <name>\n nb ebook publish\n\nSubcommands:\n ebook new Create a new notebook initialized with placeholder files for\n authoring an ebook.\n ebook publish Generate a .epub file using the current notebook contents.\n\nDescription:\n Ebook authoring with `nb`.\n\n `nb ebook new` creates a notebook populated with initial placeholder files\n for creating an ebook. Edit the title page and chapters using normal `nb`\n commands, then use `nb ebook publish` to generate an epub file.\n\n Chapters are expected to be markdown files with sequential numeric\n filename prefixes for ordering:\n\n 01-example.md\n 02-sample.md\n 03-demo.md\n\n Create new chapters with `nb add`:\n\n nb add --filename \"04-chapter4.md\"\n\n title.txt contains the book metadata in a YAML block. For more information\n about the fields for this file, visit:\n\n https://pandoc.org/MANUAL.html#epub-metadata\n\n stylesheet.css contains base styling for the generated ebook. It can be used\n as it is and can also be edited using `nb edit`.\n\n As with all `nb` notebooks, changes are recorded automatically in git,\n providing automatic version control for all ebook content, source, and\n metadata files.\n\n Generated epub files are saved in the notebook and can be previewed in the\n terminal with `nb show`. Export a generated epub file with `nb export`:\n\n nb export 12 .\n\nMore info:\n https://pandoc.org/epub.html\n```\n\n#### `example`\n\n[↑ ](#plugin-help)\n\n##### Install\n\n```bash\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/example.nb-plugin\n```\n\n##### Help\n\n```text\nUsage:\n nb example\n\nDescription:\n Print \"Hello, World!\"\n```\n\n#### `weather`\n\n[↑ ](#plugin-help)\n\n##### Install\n\n```bash\nnb plugins install https://github.com/xwmx/nb/blob/master/plugins/weather.nb-plugin\n```\n\n##### Help\n\n```text\nUsage:\n nb weather [<option>...]\n\nDescription:\n Display weather information from wttr.in.\n\nMore Info:\n https://github.com/chubin/wttr.in\n https://wttr.in\n\nExamples:\n nb weather\n nb weather Tokyo\n nb weather lax\n\nShortcut Alias:\n nb w\n```\n\n### `$` Variables\n\n<p>\n <sup>\n <a href=\"#overview\">↑</a> ·\n <a href=\"#%EF%B8%8F-set--settings\"><code>set</code>&<code>settings</code></a>,\n <a href=\"#settings\"><code>nb settings</code></a>\n </sup>\n</p>\n\n<div align=\"center\">\n <sup>\n <a href=\"#editor-1\"><code>$EDITOR</code></a> ·\n <a href=\"#nb_ace_enabled\"><code>$NB_ACE_ENABLED</code></a> ·\n <a href=\"#nb_ace_md_gutter\"><code>$NB_ACE_MD_GUTTER</code></a> ·\n <a href=\"#nb_ace_relative_line_numbers\"><code>$NB_ACE_RELATIVE_LINE_NUMBERS</code></a> ·\n <a href=\"#nb_ace_soft_tabs\"><code>$NB_ACE_SOFT_TABS</code></a> ·\n <a href=\"#nb_ace_keyboard\"><code>$NB_ACE_KEYBOARD</code></a> ·\n <a href=\"#nb_audio_tool\"><code>$NB_AUDIO_TOOL</code></a> ·\n <a href=\"#nb_auto_sync\"><code>$NB_AUTO_SYNC</code></a> ·\n <a href=\"#nb_auto_sync_seconds\"><code>$NB_AUTO_SYNC_SECONDS</code></a> ·\n <a href=\"#nb_bookmark_content_cleanup_tool\"><code>$NB_BOOKMARK_CONTENT_CLEANUP_TOOL</code></a> ·\n <a href=\"#nb_bookmark_content_conversion_tool\"><code>$NB_BOOKMARK_CONTENT_CONVERSION_TOOL</code></a> ·\n <a href=\"#nb_browse_markdown_reader\"><code>$NB_BROWSE_MARKDOWN_READER</code></a> ·\n <a href=\"#nb_browse_server_tool\"><code>$NB_BROWSE_SERVER_TOOL</code></a> ·\n <a href=\"#nb_browse_support_links\"><code>$NB_BROWSE_SUPPORT_LINKS</code></a> ·\n <a href=\"#nb_browser\"><code>$NB_BROWSER</code></a> ·\n <a href=\"#nb_color_primary\"><code>$NB_COLOR_PRIMARY</code></a> ·\n <a href=\"#nb_color_secondary\"><code>$NB_COLOR_SECONDARY</code></a> ·\n <a href=\"#nb_color_theme\"><code>$NB_COLOR_THEME</code></a> ·\n <a href=\"#nb_custom_css\"><code>$NB_CUSTOM_CSS</code></a> ·\n <a href=\"#nb_custom_css_url\"><code>$NB_CUSTOM_CSS_URL</code></a> ·\n <a href=\"#nb_custom_javascript\"><code>$NB_CUSTOM_JAVASCRIPT</code></a> ·\n <a href=\"#nb_custom_javascript_url\"><code>$NB_CUSTOM_JAVASCRIPT_URL</code></a> ·\n <a href=\"#nb_data_tool\"><code>$NB_DATA_TOOL</code></a> ·\n <a href=\"#nb_default_extension\"><code>$NB_DEFAULT_EXTENSION</code></a> ·\n <a href=\"#nb_default_template\"><code>$NB_DEFAULT_TEMPLATE</code></a> ·\n <a href=\"#nb_dir-1\"><code>$NB_DIR</code></a> ·\n <a href=\"#nb_directory_tool\"><code>$NB_DIRECTORY_TOOL</code></a> ·\n <a href=\"#nb_editor\"><code>$NB_EDITOR</code></a> ·\n <a href=\"#nb_encryption_tool\"><code>$NB_ENCRYPTION_TOOL</code></a> ·\n <a href=\"#nb_folders_first\"><code>$NB_FOLDERS_FIRST</code></a> ·\n <a href=\"#nb_footer\"><code>$NB_FOOTER</code></a> ·\n <a href=\"#nb_gui_browser\"><code>$NB_GUI_BROWSER</code></a> ·\n <a href=\"#nb_header\"><code>$NB_HEADER</code></a> ·\n <a href=\"#nb_image_tool\"><code>$NB_IMAGE_TOOL</code></a> ·\n <a href=\"#nb_indicator_audio\"><code>$NB_INDICATOR_AUDIO</code></a> ·\n <a href=\"#nb_indicator_bookmark\"><code>$NB_INDICATOR_BOOKMARK</code></a> ·\n <a href=\"#nb_indicator_document\"><code>$NB_INDICATOR_DOCUMENT</code></a> ·\n <a href=\"#nb_indicator_ebook\"><code>$NB_INDICATOR_EBOOK</code></a> ·\n <a href=\"#nb_indicator_encrypted\"><code>$NB_INDICATOR_ENCRYPTED</code></a> ·\n <a href=\"#nb_indicator_folder\"><code>$NB_INDICATOR_FOLDER</code></a> ·\n <a href=\"#nb_indicator_image\"><code>$NB_INDICATOR_IMAGE</code></a> ·\n <a href=\"#nb_indicator_pinned\"><code>$NB_INDICATOR_PINNED</code></a> ·\n <a href=\"#nb_indicator_todo\"><code>$NB_INDICATOR_TODO</code></a> ·\n <a href=\"#nb_indicator_todo_done\"><code>$NB_INDICATOR_TODO_DONE</code></a> ·\n <a href=\"#nb_indicator_video\"><code>$NB_INDICATOR_VIDEO</code></a> ·\n <a href=\"#nb_limit\"><code>$NB_LIMIT</code></a> ·\n <a href=\"#nb_mathjax_enabled\"><code>$NB_MATHJAX_ENABLED</code></a> ·\n <a href=\"#nb_markdown_tool\"><code>$NB_MARKDOWN_TOOL</code></a> ·\n <a href=\"#nb_pinned_pattern\"><code>$NB_PINNED_PATTERN</code></a> ·\n <a href=\"#nb_server_host\"><code>$NB_SERVER_HOST</code></a> ·\n <a href=\"#nb_server_port\"><code>$NB_SERVER_PORT</code></a> ·\n <a href=\"#nb_syntax_theme\"><code>$NB_SYNTAX_THEME</code></a> ·\n <a href=\"#nb_user_agent\"><code>$NB_USER_AGENT</code></a> ·\n <a href=\"#nbrc_path\"><code>$NBRC_PATH</code></a>\n </sup>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n<div align=\"center\">\n <a href=\"#overview\"> ↑ </a>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n[Settings](#%EF%B8%8F-set--settings) are set in the `~/.nbrc` configuration\nfile using environment variables. Settings can be set through `nb`\nusing [`set` & `settings`](#%EF%B8%8F-set--settings) or by\nassigning a value to the variable directly in the `~/.nbrc` file, which\ncan be opened in your `$EDITOR` with [`nb settings edit`](#settings).\n\nExample assignment:\n\n```bash\nexport NB_INDICATOR_PINNED=\"🔮\"\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$EDITOR`\n\n```text\nThe terminal editor command for editing items.\n\nSee also: `$NB_EDITOR`\n\nExample Values: 'code', 'emacs', 'hx', 'vim'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_ACE_ENABLED`\n\n```text\nDefault: '0'\n\nExample Values: '0', '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_ACE_MD_GUTTER`\n\n```text\nDefault: '1'\n\nExample Values: '0', '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_ACE_RELATIVE_LINE_NUMBERS`\n\n```text\nDefault: '0'\n\nExample Values: '0', '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_ACE_SOFT_TABS`\n\n```text\nDefault: '0'\n\nExample Values: '0', '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_ACE_KEYBOARD`\n\n```text\nDefault: 'ace'\n\nExample Values: 'emacs', 'sublime', 'vim', 'vscode'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_AUDIO_TOOL`\n\n```text\nDefault: '' (first available)\n\nExample Values: 'mplayer', 'afplay'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_AUTO_SYNC`\n\n```text\nDefault: '1'\n\nWhen set to '1', each `_git checkpoint()` call will automativally run\n`$_ME sync`. To disable this behavior, set the value to '0'.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_AUTO_SYNC_SECONDS`\n\n```text\nDefault: '60'\n\nThe minimum number of seconds between automatic Git sync operations when\n`$NB_AUTO_SYNC` is enabled.\n\nSupported Values: '0' or any positive integer\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_BOOKMARK_CONTENT_CLEANUP_TOOL`\n\n```text\nDefault: 'readability'\n\nThe tool used to clean up HTML content before conversion to markdown\nwhen creating bookmarks.\n\nSupported Tools:\n\n- https://www.npmjs.com/package/readability-cli\n- https://github.com/eafer/rdrview\n\nSupported Values: '', 'rdrview', 'readability'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_BOOKMARK_CONTENT_CONVERSION_TOOL`\n\n```text\nDefault: 'pandoc'\n\nThe tool used to convert HTML content to markdown when creating\nbookmarks.\n\nSupported Tools:\n\n- https://github.com/JohannesKaufmann/html-to-markdown\n- https://github.com/microsoft/markitdown\n- https://pandoc.org\n\nSupported Values: '', 'html-to-markdown', 'markitdown', 'pandoc'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_BROWSE_MARKDOWN_READER`\n\n```text\n$NB_BROWSE_MARKDOWN_READER\n\nDefault: 'markdown+emoji+raw_html+east_asian_line_breaks'\n\nThe Pandoc reader, including extensions, to use for converting Markdown to\nHTML in `nb browse`.\n\nMore information:\n https://pandoc.org/MANUAL.html#extensions\n https://pandoc.org/MANUAL.html#general-options-1\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_BROWSE_SERVER_TOOL`\n\n```text\nDefault: first available: 'ncat', 'socat', 'netcat', 'bash' (5.2+ only), ''\n\nThe tool used to listen on the server host and port and respond to\nincoming requests.\n\nSupported Values: 'accept', 'bash', 'nc', 'ncat', netcat', 'socat'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_BROWSE_SUPPORT_LINKS`\n\n```text\nDefault: '1'\n\nSet to '0' to hide the 'Donate' and 'Sponsor' links in `nb browse`.\n\nSupported Values: '0' '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_BROWSER`\n\n```text\nDefault: value of $BROWSER\n\nExample Values: 'links', 'w3m'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_COLOR_PRIMARY`\n\n```text\nDefault: Value depends on terminal capabilities.\n\nSet highlighting color. This should be set to an xterm color number, usually\na value between 1 and 256. For a table of common colors and their numbers\nrun:\n\n nb settings colors\n\nSupported Values: [0..255+]\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_COLOR_SECONDARY`\n\n```text\nDefault: '8'\n\nColor for lines and other accents. This should be set to an xterm color\nnumber, usually a value between 1 and 256. For a table of common colors and\ntheir numbers, run:\n\n nb settings colors\n\nSupported Values: [0..255+]\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_COLOR_THEME`\n\n```text\nDefault: 'nb'\n\nThe color theme.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_CUSTOM_CSS`\n\n```text\nDefault: ''\n\nA style sheet to be included inline in a `<style>` element on pages\nrendered by `nb browse`.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_CUSTOM_CSS_URL`\n\n```text\nDefault: ''\n\nA URL to a style sheet to be included in a `<link rel=\"stylesheet\">`\nelement on pages rendered by `nb browse`.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_CUSTOM_JAVASCRIPT`\n\n```text\nDefault: ''\n\nA block of JavaScript code to be included inline in a `<script>` element\non pages rendered by `nb browse`.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_CUSTOM_JAVASCRIPT_URL`\n\n```text\nDefault: ''\n\nA URL to a JavaScript file to be included in a `<script src=//url>`\nelement on pages rendered by `nb browse`.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_DATA_TOOL`\n\n```text\nDefault: '' (first available)\n\nExample Values: 'visidata', 'sc-im'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_DEFAULT_EXTENSION`\n\n```text\nDefault: 'md'\n\nExample Values: 'md' 'org'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_DEFAULT_TEMPLATE`\n\n```text\nDefault: ''\n\nA string template or a path to a template file.\n\nExample Values: '/path/to/template/file' '# {{title}} {{content}}'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_DIR`\n\n```text\nDefault: `$HOME/.nb`\n\nThe location of the directory that contains the notebooks.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_DIRECTORY_TOOL`\n\n```text\nDefault: '' (nb browse)\n\nExample Values: 'ranger', 'mc'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_EDITOR`\n\n```text\nDefault: the value of `$EDITOR`\n\nThe terminal editor command for editing items. Overrides the value of\n`$EDITOR` in the environment.\n\nSee also: `$EDITOR`\n\nExample Values: 'code', 'emacs', 'hx', 'vim'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_ENCRYPTION_TOOL`\n\n```text\nDefault: 'openssl'\n\nSupported Values: 'gpg' 'openssl'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_FOLDERS_FIRST`\n\n```text\nDefault: '0'\n\nWhen set to '1', folders are printed before other items in `nb`, `nb ls`,\nand `nb browse`.\n\nSupported Values: '0' '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_FOOTER`\n\n```text\nDefault: '1'\n\nSupported Values: '0' '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_GUI_BROWSER`\n\n```text\nDefault: ''\n\nExample Value: 'firefox'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_HEADER`\n\n```text\nDefault: '2'\n\nSupported Values: '0' '1' '2' '3'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_IMAGE_TOOL`\n\n```text\nDefault: '' (first available)\n\nExample Values: 'imgcat', 'catimg'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_AUDIO`\n\n```text\nDefault: 🔉\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_BOOKMARK`\n\n```text\nDefault: 🔖\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_DOCUMENT`\n\n```text\nDefault: 📄\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_EBOOK`\n\n```text\nDefault: 📖\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_ENCRYPTED`\n\n```text\nDefault: 🔒\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_FOLDER`\n\n```text\nDefault: 📂\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_IMAGE`\n\n```text\nDefault: 🌄\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_PINNED`\n\n```text\nDefault: 📌\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_TODO`\n\n```text\nDefault: ✔️\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_TODO_DONE`\n\n```text\nDefault: ✅\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_INDICATOR_VIDEO`\n\n```text\nDefault: 📹\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_LIMIT`\n\n```text\nDefault: '15'\n\nSet to a positive number to limit the output of `nb` and `nb ls` to that value.\nSet to \"auto\" to automatically limit output to the current terminal height.\nSet a maximum auto limit with `auto^<max>`, e.g., `auto^15`.\nSubtract an auto limit offset for multiline prompts with `auto-<offset>`.\nAdd an auto limit offet with `auto+<offset>`.\nCombine both modifiers with `auto-<offset>^<max>` or `auto+<offset>^<max>`.\n\nSupported Values:\n - <max>\n - auto\n - auto^<max>\n - auto-<offset>\n - auto+<offset>\n - auto-<offset>^<max>\n - auto+<offset>^<max>\n\nExample Values:\n - 15\n - auto\n - auto^15\n - auto-2\n - auto+2\n - auto-2^15\n - auto+2^15\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_MATHJAX_ENABLED`\n\n```text\nDefault: '0'\n\nExample Values: '0', '1'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_MARKDOWN_TOOL`\n\n```text\nDefault: '' (default pager)\n\nSupported Values: 'bat', 'glow', 'lowdown', 'mdcat', 'mdless', 'mdv'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_PINNED_PATTERN`\n\n```text\nExample Value: '#pinned'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_SERVER_HOST`\n\n```text\nDefault: 'localhost'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_SERVER_PORT`\n\n```text\nDefault: '6789'\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_SYNTAX_THEME`\n\n```text\nDefault: 'base16'\n\nSupported Values: Theme names listed with `bat --list-themes`\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NB_USER_AGENT`\n\n```text\nDefault: '' (`curl` or `wget` default user agent)\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n##### `$NBRC_PATH`\n\n```text\nDefault: `$HOME/.nbrc`\n\nThe location of the .nbrc configuration file.\n```\n\n<p>\n <sup>\n <a href=\"#-variables\">↑</a>\n </sup>\n</p>\n\n## Specifications\n\n<div align=\"center\">\n <a href=\"#nb-markdown-bookmark-file-format\">Bookmark File Format</a> ·\n <a href=\"#nb-markdown-todo-file-format\">Todo File Format</a> ·\n <a href=\"#nb-notebook-specification\">Notebook Specification</a>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n<div align=\"center\">\n <a href=\"#-help\"> ↑ </a>\n</div>\n\n<p align=\"center\"></p><!-- spacer -->\n\n### `nb` Markdown Bookmark File Format\n\n<p>\n <sup>\n <a href=\"#specifications\">↑</a> ·\n <a href=\"#-bookmarks\">Bookmarks</a>,\n <a href=\"#bookmark\"><code>nb bookmark</code></a>\n </sup>\n</p>\n\n#### Extension\n\n`.bookmark.md`\n\n#### Description\n\n`nb` bookmarks are Markdown documents created using a combination of\nuser input and data from the bookmarked page. The `nb` bookmark format\nis intended to be readable, editable, convertible, renderable, and\nclearly organized for greatest accessibility.\n\nBookmarks are identified by a `.bookmark.md` file extension. The\nbookmark URL is the first URL in the file within `<` and `>` characters.\nTo create a minimally valid bookmark file with [`nb add`](#add):\n\n```bash\nnb add example.bookmark.md --content \"<https://example.com>\"\n```\n\nThis creates a file with the name `example.bookmark.md` containing:\n\n```markdown\n<https://example.com>\n```\n\nIn a full bookmark, information is separated into sections,\nwith each bookmark section indicated by a Markdown `h2` heading.\n\n#### Example\n\n````markdown\n# Example Title (example.com)\n\n<https://example.com>\n\n## Description\n\nExample description.\n\n## Quote\n\n> Example quote line one.\n>\n> Example quote line two.\n\n## Comment\n\nExample comment.\n\n## Related\n\n- <https://example.net>\n- <https://example.org>\n- [[example:123]]\n\n## Tags\n\n#tag1 #tag2\n\n## Content\n\nExample Title\n=============\n\nThis domain is for use in illustrative examples in documents. You may\nuse this domain in literature without prior coordination or asking for\npermission.\n\n[More information\\...](https://www.iana.org/domains/example)\n\n## Source\n\n```html\n<!doctype html>\n<html>\n <head>\n <title>Example Title\n \n \n\n \n

Example Title

\n

\n This domain is for use in illustrative examples in documents. You may\n use this domain in literature without prior coordination or asking for\n permission.\n

\n

\n More information...\n

\n \n\n```\n````\n\n#### Elements\n\n##### Title\n\n`Optional`\n\nA [Markdown atx-style `h1` heading\n](https://daringfireball.net/projects/markdown/syntax#header)\ncontaining the content of the bookmarked page's\nHTML `` or [`og:title`](https://ogp.me/) tag, if present, followed by\nthe domain within parentheses.\n\n###### Examples\n\n```markdown\n# Example Title (example.com)\n```\n```markdown\n# (example.com)\n```\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### URL\n\n`Required`\n\nThe URL of the bookmarked resource, with surrounding angle brackets\n(`<`, `>`).\n\nThis is the only required element.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Description`\n\n`Optional`\n\nA text element containing the content of the bookmarked page's meta description\nor [`og:description`](https://ogp.me/) tag, if present.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Quote`\n\n`Optional`\n\nA markdown quote block containing a user-specified excerpt from the bookmarked\nresource.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Comment`\n\n`Optional`\n\nA text element containing a comment written by the user.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Related`\n\n`Optional`\n\nA Markdown list of\nangle bracketed (`<`, `>`) URLs and\n[[[wiki-style links]]](#-linking)\nthat are related to the bookmarked resource.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Tags`\n\n`Optional`\n\nA list of [#tags](#-tagging)\nrepresented as `#hashtags`\nseparated by individual spaces.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Content`\n\n`Optional`\n\nThe full content of the bookmarked page, converted to Markdown.\n\nThe `## Content` section makes the page content available locally for\nfull-text search and viewing of page content. The source HTML is converted\nto inline Markdown to reduce the amount of markup, make it more readable,\nand make page content easily viewable in the terminal as markdown and\nstreamlined HTML in web browsers.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Source`\n\n`Optional`\n\nA fenced code block with `html` language identifier containing the source HTML\nfrom the bookmarked page.\n\n`nb` does not save the page source by default. `nb` uses this section to save\nthe source HTML page content when `pandoc` is not available to convert it to\nMarkdown.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-bookmark-file-format\">↑</a>\n </sup>\n</p>\n\n### `nb` Markdown Todo File Format\n\n<p>\n <sup>\n <a href=\"#specifications\">↑</a> ·\n <a href=\"#-todos\">Todos</a>,\n <a href=\"#todo\"><code>nb todo</code></a>\n </sup>\n</p>\n\n#### Extension\n\n`.todo.md`\n\n#### Description\n\n`nb` todos are Markdown documents identified by a `.todo.md` file extension.\nTodos contain a Markdown `h1` heading\nstarting with a Markdown checkbox (`[ ]` / `[x]`) indicating\nthe todo completion state, followed by the todo title.\n\n#### Example\n\n```markdown\n# [x] Example todo title.\n\n## Due\n\n2100-01-01\n\n## Description\n\nExample description.\n\n## Tasks\n\n- [ ] One\n- [x] Two\n- [ ] Three\n\n## Related\n\n- [[example:123]]\n- <https://example.org>\n\n## Tags\n\n#tag1 #tag2\n```\n\n#### Elements\n\n##### Title\n\n`Required`\n\nA [Markdown atx-style `h1` heading\n](https://daringfireball.net/projects/markdown/syntax#header)\ncontaining a Markdown checkbox followed by the todo title.\nAn `x` within the checkbox (`[ ]`) indicates that the todo is done.\n\n###### Examples\n\n```markdown\n# [ ] Example undone / open todo title.\n```\n```markdown\n# [x] Example done / closed todo title.\n```\n\n<p>\n <sup>\n <a href=\"#nb-markdown-todo-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Due`\n\n`Optional`\n\nA text element containing a value referencing\na due date and / or time for the todo.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-todo-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Description`\n\n`Optional`\n\nA text element containing a description for the todo.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-todo-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Tasks`\n\n`Optional`\n\nA markdown tasklist containing sub-tasks for the todo.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-todo-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Related`\n\n`Optional`\n\nA Markdown list of\nangle bracketed (`<`, `>`) URLs and\n[[[wiki-style links]]](#-linking)\nthat are related to the todo.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-todo-file-format\">↑</a>\n </sup>\n</p>\n\n##### `## Tags`\n\n`Optional`\n\nA list of [#tags](#-tagging)\nrepresented as `#hashtags`\nseparated by individual spaces.\n\n<p>\n <sup>\n <a href=\"#nb-markdown-todo-file-format\">↑</a>\n </sup>\n</p>\n\n### `nb` Notebook Specification\n\n<p>\n <sup>\n <a href=\"#specifications\">↑</a> ·\n <a href=\"#-notebooks\">Notebooks</a>,\n <a href=\"#notebooks\"><code>nb notebooks</code></a>\n </sup>\n</p>\n\nAn `nb` notebook is a directory that contains a valid `.git` directory,\nindicating that it has been initialized as a git repository, and a `.index`\nfile in the root directory.\n\n#### `.index` Files\n\nA notebook folder index is a text file named `.index` in any folder\nwithin the notebook directory. `.index` contains a list of visible\nfilenames within the folder, one per line, and the line number of each\nfilename represents the id. `.index` files are included in the git repository\nso ids are preserved across systems.\n\n##### Operations\n\n<dl>\n <dt><code>add</code></dt>\n <dd>Append a new line containing the filename to <code>.index</code>.</dd>\n <dt><code>update</code></dt>\n <dd>Overwrite the existing filename in <code>.index</code> with the new filename.</dd>\n <dt><code>delete</code></dt>\n <dd>Delete the filename, preserving the newline, leaving the line blank.</dd>\n <dt><code>reconcile</code></dt>\n <dd>Remove duplicate lines, preserving existing blank lines, <code>add</code> entries for new files, and <code>delete</code> entries for deleted files.</dd>\n <dt><code>rebuild</code></dt>\n <dd>Delete and rebuild <code>.index</code>, listing files by most recently modified, reversed.</dd>\n</dl>\n\n##### `index` Subcommand\n\n`nb` manages the `.index` of each folder within a notebook using an internal\n`index` subcommand.\n\n###### `nb help index`\n\n```text\nUsage:\n nb index add <filename>\n nb index delete <filename>\n nb index edit\n nb index get_basename <id>\n nb index get_id <filename>\n nb index get_max_id\n nb index rebuild [--ancestors]\n nb index reconcile [--ancestors] [--commit]\n nb index show\n nb index update <existing-filename> <new-filename>\n nb index verify\n nb index <subcommand> <options>... [<folder-path>]\n\nOptions:\n --ancestors Perform the action on all folders within the notebook that\n are ancestors of the current folder.\n --commit Commit changes to git.\n\nSubcommands:\n add Add <filename> to the index.\n delete Delete <filename> from the index.\n edit Open the index file in `$EDITOR`.\n get_basename Print the filename / basename at the specified <id>.\n get_id Get the id for <filename>.\n get_max_id Get the maximum id for the folder.\n rebuild Rebuild the index, listing files by last modified, reversed.\n Some ids will change. Prefer `nb index reconcile`.\n reconcile Remove duplicates and update index for added and deleted files.\n show Print the index.\n update Overwrite the <existing-filename> entry with <new-filename>.\n verify Verify that the index matches the folder contents.\n\nDescription:\n Manage the index for the current folder or the folder at <folder-path>,\n which can be passed as the final argument to any `index` subcommand.\n\n `index` is used internally by `nb` and using it manually will\n probably corrupt the index. If something goes wrong with an index,\n fix it with `nb index reconcile`.\n\n An index is a text file named '.index' in any folder within a notebook.\n .index contains a list of filenames and the line number of each filename\n represents the id. .index files are included in the git repository so\n ids are preserved across systems.\n```\n\n<p>\n <sup>\n <a href=\"#nb-notebook-specification\">↑</a>\n </sup>\n</p>\n\n#### `.pindex` Files\n\nAny folder may contain an optional plain text file named `.pindex`\ncontaining a list of basenames from that folder, one per line, that should\nbe treated as [pinned](#-pinning), meaning they appear first in some\nlist operations, including `nb` and [`nb ls`](#ls). Entries are added to a\n`.pindex` file with [`nb pin`](#pin) and removed with [`nb unpin`](#unpin).\n\n<p>\n <sup>\n <a href=\"#nb-notebook-specification\">↑</a>\n </sup>\n</p>\n\n#### Archived Notebooks\n\nA notebook is considered [archived](#archiving-notebooks)\nwhen it contains a file named `.archived`\nat the root level of the notebook directory.\n\n<p>\n <sup>\n <a href=\"#nb-notebook-specification\">↑</a>\n </sup>\n</p>\n\n## Tests\n\nWith more than 2,200 tests spanning tens of thousands of lines,\n`nb` is really mostly a\n[test suite](https://github.com/xwmx/nb/tree/master/test).\nTests run continuously [via GitHub Actions](https://github.com/xwmx/nb/actions)\non recent versions of both Ubuntu and macOS to account for differences between\nBSD and GNU tools and Bash versions.\nTo run the tests locally, install\n[Bats](https://github.com/bats-core/bats-core)\nand the [recommended dependencies](#optional),\nthen run `bats test` within the project root directory. Run groups of\ntests with globbing, e.g., `bats test/browse*` and `bats test/folders*`.\n\n<div align=\"center\">\n <span>\n <a href=\"#overview\"> ↑ </a>\n </span>\n\n <br/>\n</div>\n\n---\n\n<div align=\"center\">\n <span>\n Copyright (c) 2015-present ·\n <a href=\"https://www.williammelody.com/\">William Melody</a> ·\n <a href=\"https://github.com/xwmx/nb/blob/master/LICENSE\">AGPLv3</a>\n </span>\n\n <br/>\n <br/>\n</div>\n\n<div align=\"center\">\n <span>\n <a href=\"https://xwmx.github.io/nb\">xwmx.github.io/nb</a> ·\n <a href=\"https://github.com/xwmx/nb\">github.com/xwmx/nb</a>\n </span>\n\n <br/>\n <br/>\n</div>\n\n<div align=\"center\">\n <span>\n 📝🔖🔒🔍📔\n </span>\n\n <br/>\n <br/>\n</div>\n" }, { "path": "docs/index.previous.html", "content": "<!DOCTYPE html>\n<!--\n__ _\n\\ \\ _ __ | |__\n \\ \\ | '_ \\| '_ \\\n / / | | | | |_) |\n/_/ |_| |_|_.__/\n-->\n<html>\n <head>\n <meta charset=\"utf-8\">\n <meta http-equiv=\"x-ua-compatible\" content=\"ie=edge\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, shrink-to-fit=no\">\n\n <title>nb • cli plain text note-taking, bookmarking, and archiving.\n\n \n \n \n\n \n \n \n
\n
\n
\n
\n \n

\n nb\n

\n \n
\n
\n\n
\n
\n

\n Command line note-taking, bookmarking, and archiving with\n plain text data storage,\n encryption,\n filtering and search,\n Git-backed versioning and syncing,\n Pandoc-backed conversion,\n global and local notebooks,\n customizable color themes,\n and more, all in a single portable, user-friendly script.\n

\n
\n
\n\n
\n
\n \n
\n
\n
\n
\n \n\n\n" }, { "path": "etc/README.md", "content": "# `nb` Tab Completion\n\n## Homebrew\n\nInstalling via Homebrew with `brew install nb` will also\ninstall the completion scripts.\n\nA one-time setup might be needed to [enable completion for all Homebrew\nprograms](https://docs.brew.sh/Shell-Completion).\n\n## npm, bpkg, Make\n\nWhen `nb` is installed with `npm`, `bpkg`, or Make, an install hook will\ncheck the environment and attempt to install completions. If it's successful,\nyou should see a message similar to:\n\n```bash\nCompletion script installed: /usr/local/etc/bash_completion.d/nb\nCompletion script installed: /usr/local/share/fish/vendor_completions.d/nb.fish\nCompletion script installed: /usr/local/share/zsh/site-functions/_nb\n```\n\nIf completion is working after installing through any of these methods, then\nyou don't need to do anything else.\n\n## `nb completions`\n\nThe `nb completions` subcommand can be used for installing and uninstalling\ncompletion scripts. Depending on your configuration, you might need to use\n`sudo` to install completion scripts easily:\n\n```bash\n> sudo nb completions check\nCompletion scripts not found.\n\n> sudo nb completions install\nCompletion script installed: /usr/share/bash-completion/completions/nb\nCompletion script installed: /usr/local/share/fish/vendor_completions.d/nb.fish\nCompletion script installed: /usr/local/share/zsh/site-functions/_nb\n\n> sudo nb completions check\nExists: /usr/share/bash-completion/completions/nb\nExists: /usr/local/share/fish/vendor_completions.d/nb.fish\nExists: /usr/local/share/zsh/site-functions/_nb\n\n> sudo nb completions uninstall\nCompletion script removed: /usr/share/bash-completion/completions/nb\nCompletion script removed: /usr/local/share/fish/vendor_completions.d/nb.fish\nCompletion script removed: /usr/local/share/zsh/site-functions/_nb\n```\n\nIf you installed `nb` manually by downloading just the `nb` script,\nthe completion scripts won't be immediately available for\n`nb completions install`. You can try installing the completions with\nthe `--download` flag, which will get the latest version from GitHub:\n\n```bash\nsudo nb completions install --download\n```\n\n`nb completions` will try to determine the completion script directories\nfrom your environment. If `nb completions` isn't able to install\nthe completion scripts, you can try installing them manually.\n\n## Manual Installation\n\n### bash\n\n#### Linux\n\nOn a current Linux OS (in a non-minimal installation), bash completion should\nbe available.\n\nPlace the completion script in `/etc/bash_completion.d/`:\n\n```bash\nsudo curl -L https://raw.githubusercontent.com/xwmx/nb/master/etc/nb-completion.bash -o /etc/bash_completion.d/nb\n```\n\n#### macOS\n\nIf you aren't installing with homebrew, source the completion script in\n`.bash_profile`:\n\n```sh\nif [[ -f /path/to/nb-completion.bash ]]\nthen\n source /path/to/nb-completion.bash\nfi\n```\n\n### zsh\n\nPlace the completion script in your `/path/to/zsh/completion` (typically\n`~/.zsh/completion/`):\n\n```bash\n$ mkdir -p ~/.zsh/completion\n$ curl -L https://raw.githubusercontent.com/xwmx/nb/master/etc/nb-completion.zsh > ~/.zsh/completion/_nb\n```\nInclude the directory in your `$fpath` by adding in `~/.zshrc`:\n\n```bash\nfpath=(~/.zsh/completion $fpath)\n```\n\nMake sure `compinit` is loaded or do it by adding in `~/.zshrc`:\n\n```bash\nautoload -Uz compinit && compinit -i\n```\n\nThen reload your shell:\n\n```bash\nexec $SHELL -l\n```\n" }, { "path": "etc/Vagrantfile", "content": "# frozen_string_literal: true\n\n# -*- mode: ruby -*-\n# vi: set ft=ruby :\n\n# rubocop:disable all\n\n# NOTE: Uncomment box config block for `vagrant up` / `vagrant provision`.\n\n# All Vagrant configuration is done below. The \"2\" in Vagrant.configure\n# configures the configuration version (we support older styles for\n# backwards compatibility). Please don't change it unless you know what\n# you're doing.\nVagrant.configure(\"2\") do |config|\n # The most common configuration options are documented and commented below.\n # For a complete reference, please see the online documentation at\n # https://docs.vagrantup.com.\n\n #############################################################################\n # VMs & Boxes\n # -----------\n #\n # Resources:\n # https://www.vagrantup.com/docs/multi-machine\n # https://www.vagrantup.com/docs/provisioning/shell\n #\n # Every Vagrant development environment requires a box. You can search for\n # boxes at https://vagrantcloud.com/search.\n\n #############################################################################\n # Arch Boxes\n\n $arch_setup = <<-HEREDOC\nsudo su root\n\n# https://bbs.archlinux.org/viewtopic.php?id=282796\npacman --noconfirm -Sy archlinux-keyring && pacman --noconfirm -Syu\n\n# install nvm (https://github.com/nvm-sh/nvm)\ncurl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.36.0/install.sh | bash\n\n# add project root to $PATH\nif grep -q -v vagrant \"${HOME}/.bashrc\"\nthen\n printf \"\\\\nexport PATH=\\\"/vagrant:\\${PATH}\\\"\\\\n\" >> \"${HOME}/.bashrc\"\nfi\n\nsudo pacman \\\n --noconfirm \\\n -Syu \\\n bash-bats \\\n elinks \\\n fish \\\n git \\\n lynx \\\n nmap \\\n pandoc-cli \\\n python-pygments \\\n vim \\\n w3m\nHEREDOC\n\n ######\n # Arch\n #\n # https://app.vagrantup.com/archlinux/boxes/archlinux\n\n # config.vm.define \"arch\" do |arch|\n # arch.vm.box = \"archlinux/archlinux\"\n # arch.vm.provision :shell, inline: $arch_setup, privileged: false\n # end\n\n #############################################################################\n # CentOS Boxes\n\n $centos_setup = <<-HEREDOC\n# install nvm (https://github.com/nvm-sh/nvm)\ncurl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.36.0/install.sh | bash\n\n# add project root to $PATH\nif grep -q -v vagrant \"${HOME}/.bashrc\"\nthen\n printf \"\\\\nexport PATH=\\\"/vagrant:\\${PATH}\\\"\\\\n\" >> \"${HOME}/.bashrc\"\nfi\nHEREDOC\n\n ##########\n # CentOS 8\n\n # config.vm.define \"centos8\" do |centos8|\n # centos8.vm.box = \"centos/8\"\n # centos8.vm.box_version = \"1905.1\"\n # centos8.vm.provision :shell, inline: $centos_setup, privileged: false\n # end\n\n ##########\n # CentOS 7\n\n # config.vm.define \"centos7\" do |centos7|\n # centos7.vm.box = \"centos/7\"\n # centos7.vm.provision :shell, inline: $centos_setup, privileged: false\n # end\n\n #############################################################################\n # Debian Boxes\n\n $debian_setup = <<-HEREDOC\n# install node and npm\n# sudo apt update -y\n# sudo apt install nodejs -y\n# sudo apt install npm -y\n\n# install nvm (https://github.com/nvm-sh/nvm)\ncurl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.36.0/install.sh | bash\n\n# add project root to $PATH\nif grep -q -v vagrant \"${HOME}/.bashrc\"\nthen\n printf \"\\\\nexport PATH=\\\"/vagrant:\\${PATH}\\\"\\\\n\" >> \"${HOME}/.bashrc\"\nfi\n\n# install dependencies\nsudo apt-get update\nsudo apt-get install bats -y\nsudo apt-get install elinks -y\nsudo apt-get install lynx -y\nsudo apt-get install ncat -y\nsudo apt-get install python3-pygments -y\nsudo apt-get install w3m -y\n\n# install latest pandoc\ncurl -LO https://github.com/jgm/pandoc/releases/download/3.1.11.1/pandoc-3.1.11.1-1-amd64.deb\nsudo dpkg -i pandoc-3.1.11.1-1-amd64.deb\n\n# install latest bat\ncurl -LO https://github.com/sharkdp/bat/releases/download/v0.16.0/bat_0.16.0_amd64.deb\nsudo dpkg -i bat_0.16.0_amd64.deb\n\n# install latest git\nsudo add-apt-repository ppa:git-core/ppa\nsudo apt update\nsudo apt install git -y\n\ngit config --global user.name \"Example Name\"\ngit config --global user.email \"example@example.test\"\n\n# set locale\nsudo apt-get clean\nsudo apt-get update\nsudo apt-get install locales -y\nsudo locale-gen en_US.UTF-8\n\nprintf \"%s\\\\n\" \"LANG=en_US.UTF-8\" | sudo tee /etc/default/locale > /dev/null\nHEREDOC\n\n # config.vm.define \"debian12\" do |debian12|\n # debian12.vm.box = \"debian/bookworm64\"\n # debian12.vm.provision :shell, inline: $debian_setup, privileged: false\n # end\n\n #############################################################################\n # EndeavorOS Boxes\n\n # NOTE: uses $arch_setup\n\n # config.vm.define \"endeavor\" do |endeavor|\n # endeavor.vm.box = \"altafsaljooq/EndeavousOS\"\n # endeavor.vm.provision :shell, inline: $arch_setup, privileged: false\n # end\n\n #############################################################################\n # Fedora Boxes\n\n $fedora_setup = <<-HEREDOC\n# install dependencies\nsudo dnf -y update\nsudo dnf -y install bats\nsudo dnf -y install elinks\nsudo dnf -y install git\nsudo dnf -y install lynx\nsudo dnf -y install nmap-ncat\nsudo dnf -y install pandoc\nsudo dnf -y install python3-pygments\nsudo dnf -y install w3m\n\n# install nvm (https://github.com/nvm-sh/nvm)\ncurl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash\n\n# add project root to $PATH\nif [[ -f \"${HOME}/.bashrc\" ]] && grep -q -v vagrant \"${HOME}/.bashrc\"\nthen\n touch \"${HOME}/.bashrc\"\n printf \"\\\\nexport PATH=\\\"/vagrant:\\${PATH}\\\"\\\\n\" >> \"${HOME}/.bashrc\"\nfi\nHEREDOC\n\n ###########\n # Fedora 41\n\n # https://app.vagrantup.com/fedora/boxes/41-cloud-base\n # config.vm.define \"fedora41\" do |fedora41|\n # fedora41.vm.box = \"fedora/41-cloud-base\"\n # fedora41.vm.provision :shell, inline: $fedora_setup, privileged: false\n # end\n\n ###########\n # Fedora 38\n\n # https://app.vagrantup.com/fedora/boxes/38-cloud-base\n # config.vm.define \"fedora38\" do |fedora38|\n # fedora38.vm.box = \"fedora/38-cloud-base\"\n # fedora38.vm.box_version = \"38.20230413.1\"\n # fedora38.vm.provision :shell, inline: $fedora_setup, privileged: false\n # end\n\n ###########\n # Fedora 36\n\n # https://app.vagrantup.com/fedora/boxes/36-cloud-base\n # config.vm.define \"fedora36\" do |fedora36|\n # fedora36.vm.box = \"fedora/36-cloud-base\"\n # fedora36.vm.box_version = \"36-20220504.1\"\n # fedora36.vm.provision :shell, inline: $fedora_setup, privileged: false\n # end\n\n #############################################################################\n # FreeBSD Boxes\n\n $freebsd_setup = <<-HEREDOC\nsudo pkg update -f\nsudo pkg install -y git\nHEREDOC\n\n ##############\n # FreeBSD 12.5\n\n # config.vm.define \"freebsd124\" do |freebsd124|\n # freebsd124.vm.box = \"freebsd/FreeBSD-12.4-STABLE\"\n # freebsd124.vm.provision :shell, inline: $freebsd_setup, privileged: false\n # end\n\n #############################################################################\n # NixOS Boxes\n\n $nixos_setup = <<-HEREDOC\n# install git\nnix-env -iA nixos.pkgs.gitAndTools.gitFull\n\n# install nvm (https://github.com/nvm-sh/nvm)\ncurl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.36.0/install.sh | bash\n\n# add project root to $PATH\nif [[ -f \"${HOME}/.bashrc\" ]] && grep -q -v vagrant \"${HOME}/.bashrc\"\nthen\n touch \"${HOME}/.bashrc\"\n printf \"\\\\nexport PATH=\\\"/vagrant:\\${PATH}\\\"\\\\n\" >> \"${HOME}/.bashrc\"\nfi\nHEREDOC\n\n #############\n # NixOS 24.11\n\n # config.vm.define \"nixos2411\" do |nixos2411|\n # nixos2411.vm.box = \"boxen/nixos-24.11\"\n # nixos2411.vm.box_version = \"2025.04.02.21\"\n # nixos2411.vm.provision :shell, inline: $nixos_setup, privileged: false\n # end\n\n #############\n # NixOS 24.05\n\n # config.vm.define \"nixos2405\" do |nixos2405|\n # nixos2405.vm.box = \"nixbox/nixos\"\n # nixos2405.vm.box_version = \"24.05\"\n # nixos2405.vm.provision :shell, inline: $nixos_setup, privileged: false\n # end\n\n #############\n # NixOS 23.11\n\n # config.vm.define \"nixos2311\" do |nixos2311|\n # nixos2311.vm.box = \"nixbox/nixos\"\n # nixos2311.vm.box_version = \"23.11\"\n # nixos2311.vm.provision :shell, inline: $nixos_setup, privileged: false\n # end\n\n #############\n # NixOS 23.05\n\n # https://license.hashicorp.com/boxen/boxes/nixos-23.05-x86_64\n # config.vm.define \"nixos2305\" do |nixos2305|\n # nixos2305.vm.box = \"boxen/nixos-23.05-x86_64\"\n # nixos2305.vm.box_version = \"2023.8.14.0\"\n # nixos2305.vm.provision :shell, inline: $nixos_setup, privileged: false\n # end\n\n #############\n # NixOS 20.03\n\n # https://app.vagrantup.com/nixos/boxes/nixos-20.03-test\n # config.vm.define \"nixos2003\" do |nixos2003|\n # nixos2003.vm.box = \"nixos/nixos-20.03-test\"\n # nixos2003.vm.box_version = \"0.0.1\"\n # nixos2003.vm.provision :shell, inline: $nixos_setup, privileged: false\n # end\n\n #############\n # NixOS 18.03\n\n # https://app.vagrantup.com/nixos/boxes/nixos-18.03-i686\n # config.vm.define \"nixos1803\" do |nixos1803|\n # nixos1803.vm.box = \"nixos/nixos-18.03-i686\"\n # nixos1803.vm.provision :shell, inline: $nixos_setup, privileged: false\n # end\n\n #############################################################################\n # OpenBSD Boxes\n\n $openbsd_setup = <<-HEREDOC\n# TODO\n# sudo su\n# echo \"https://ftp.eu.OpenBSD.org/pub/OpenBSD\" > /etc/installurl\n# pkg_add git\n# pkg_add bash\n# pkg_add vim\nHEREDOC\n\n ###########\n # OpenBSD 7\n\n # https://app.vagrantup.com/fnichol/boxes/openbsd-7.0\n # https://app.vagrantup.com/generic/boxes/openbsd7\n # https://app.vagrantup.com/roboxes/boxes/openbsd7\n # https://app.vagrantup.com/twingly/boxes/openbsd-7.1-amd64\n # config.vm.define \"openbsd7\" do |openbsd7|\n # # openbsd7.vm.box = \"fnichol/openbsd-7.0\"\n # # openbsd7.vm.box = \"generic/openbsd7\"\n # # openbsd7.vm.box = \"jcmdln/openbsd\"\n # # openbsd7.vm.box = \"roboxes/openbsd7\"\n # openbsd7.vm.box = \"twingly/openbsd-7.1-amd64\"\n # openbsd7.vm.provision :shell, inline: $openbsd_setup, privileged: false\n # end\n\n ###########\n # OpenBSD 6\n\n # https://app.vagrantup.com/twingly/boxes/openbsd-6.9-amd64\n # config.vm.define \"openbsd6\" do |openbsd6|\n # openbsd6.vm.box = \"twingly/openbsd-6.9-amd64\"\n # openbsd6.vm.provision :shell, inline: $openbsd_setup, privileged: false\n # end\n\n #############################################################################\n # Ubuntu Boxes:\n #\n # https://app.vagrantup.com/ubuntu\n\n $ubuntu_setup = <<-HEREDOC\n# install node and npm\n# sudo apt update -y\n# sudo apt install nodejs -y\n# sudo apt install npm -y\n\n# install nvm (https://github.com/nvm-sh/nvm)\ncurl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.36.0/install.sh | bash\n\n# add project root to $PATH\nif grep -q -v vagrant \"${HOME}/.bashrc\"\nthen\n printf \"\\\\nexport PATH=\\\"/vagrant:\\${PATH}\\\"\\\\n\" >> \"${HOME}/.bashrc\"\nfi\n\n# install dependencies\nsudo apt-get update\nsudo apt-get install bat -y\nsudo apt-get install bats -y\nsudo apt-get install elinks -y\nsudo apt-get install lynx -y\nsudo apt-get install ncat -y\nsudo apt-get install python3-pygments -y\nsudo apt-get install w3m -y\n\n# install latest pandoc\ncurl -LO https://github.com/jgm/pandoc/releases/download/3.1.11.1/pandoc-3.1.11.1-1-amd64.deb\nsudo dpkg -i pandoc-3.1.11.1-1-amd64.deb\n\n# install latest git\nsudo add-apt-repository ppa:git-core/ppa\nsudo apt update\nsudo apt install git -y\n\ngit config --global user.name \"Example Name\"\ngit config --global user.email \"example@example.test\"\nHEREDOC\n\n ##############\n # Ubuntu 24.04\n\n # config.vm.define \"ubuntu2404\" do |ubuntu2404|\n # ubuntu2404.vm.box = \"ubuntu/noble64\"\n # ubuntu2404.vm.provision :shell, inline: $ubuntu_setup, privileged: false\n # end\n\n ##############\n # Ubuntu 22.10\n\n # config.vm.define \"ubuntu2210\" do |ubuntu2210|\n # ubuntu2210.vm.box = \"ubuntu/kinetic64\"\n # ubuntu2210.vm.provision :shell, inline: $ubuntu_setup, privileged: false\n # end\n\n ##############\n # Ubuntu 22.04\n\n # config.vm.define \"ubuntu2204\" do |ubuntu2204|\n # ubuntu2204.vm.box = \"ubuntu/jammy64\"\n # ubuntu2204.vm.provision :shell, inline: $ubuntu_setup, privileged: false\n # end\n\n ##############\n # Ubuntu 20.10\n\n # config.vm.define \"ubuntu2010\" do |ubuntu2010|\n # ubuntu2010.vm.box = \"ubuntu/impish64\"\n # ubuntu2010.vm.provision :shell, inline: $ubuntu_setup, privileged: false\n # end\n\n ##################\n # Ubuntu 20.04 LTS\n\n # config.vm.define \"ubuntu2004\" do |ubuntu2004|\n # ubuntu2004.vm.box = \"ubuntu/focal64\"\n # ubuntu2004.vm.provision :shell, inline: $ubuntu_setup, privileged: false\n # end\n\n ##################\n # Ubuntu 18.04 LTS\n\n # config.vm.define \"ubuntu1804\" do |ubuntu1804|\n # ubuntu1804.vm.box = \"hashicorp/bionic64\"\n # ubuntu1804.vm.provision :shell, inline: $ubuntu_setup, privileged: false\n # end\n\n ################\n # Ubuntu Desktop\n\n # config.vm.define \"ubuntu_desktop\" do |ubuntu_desktop|\n # # https://app.vagrantup.com/gusztavvargadr/boxes/ubuntu-desktop\n # ubuntu_desktop.vm.box = \"gusztavvargadr/ubuntu-desktop\"\n # ubuntu_desktop.vm.provision :shell, inline: $ubuntu_setup, privileged: false\n # end\n\n ######################\n # Ubuntu 20.04 Desktop\n\n # config.vm.define \"ubuntu_desktop\" do |ubuntu_desktop|\n # # https://app.vagrantup.com/peru/boxes/ubuntu-20.04-desktop-amd64\n # ubuntu_desktop.vm.box = \"peru/ubuntu-20.04-desktop-amd64\"\n # ubuntu_desktop.vm.provision :shell, inline: $ubuntu_setup, privileged: false\n # end\n\n #############################################################################\n # Configuration\n # -------------\n\n # Link project root to /vagrant in guest.\n config.vm.synced_folder \"../\", \"/vagrant\"\n\n #############################################################################\n\n # Disable automatic box update checking. If you disable this, then\n # boxes will only be checked for updates when the user runs\n # `vagrant box outdated`. This is not recommended.\n # config.vm.box_check_update = false\n\n # Create a forwarded port mapping which allows access to a specific port\n # within the machine from a port on the host machine. In the example below,\n # accessing \"localhost:8080\" will access port 80 on the guest machine.\n # NOTE: This will enable public access to the opened port\n # config.vm.network \"forwarded_port\", guest: 80, host: 8080\n\n # Create a forwarded port mapping which allows access to a specific port\n # within the machine from a port on the host machine and only allow access\n # via 127.0.0.1 to disable public access\n # config.vm.network \"forwarded_port\", guest: 80, host: 8080, host_ip: \"127.0.0.1\"\n\n # Create a private network, which allows host-only access to the machine\n # using a specific IP.\n # config.vm.network \"private_network\", ip: \"192.168.33.10\"\n\n # Create a public network, which generally matched to bridged network.\n # Bridged networks make the machine appear as another physical device on\n # your network.\n # config.vm.network \"public_network\"\n\n # Share an additional folder to the guest VM. The first argument is\n # the path on the host to the actual folder. The second argument is\n # the path on the guest to mount the folder. And the optional third\n # argument is a set of non-required options.\n # config.vm.synced_folder \"../data\", \"/vagrant_data\"\n\n # Provider-specific configuration so you can fine-tune various\n # backing providers for Vagrant. These expose provider-specific options.\n # Example for VirtualBox:\n #\n # config.vm.provider \"virtualbox\" do |vb|\n # # Display the VirtualBox GUI when booting the machine\n # vb.gui = true\n #\n # # Customize the amount of memory on the VM:\n # vb.memory = \"1024\"\n # end\n #\n # View the documentation for the provider you are using for more\n # information on available options.\n\n # Enable provisioning with a shell script. Additional provisioners such as\n # Ansible, Chef, Docker, Puppet and Salt are also available. Please see the\n # documentation for more information about their specific syntax and use.\n # config.vm.provision \"shell\", inline: <<-SHELL\n # apt-get update\n # apt-get install -y apache2\n # SHELL\nend\n" }, { "path": "etc/debian/changelog", "content": "nb (4.1.5-1) unstable; urgency=medium\n\n * Initial release.\n\n -- William Melody Sun, 24 May 2020 04:48:17 +0000\n" }, { "path": "etc/debian/control", "content": "Source: nb\nSection: misc\nPriority: optional\nMaintainer: William Melody \nBuild-Depends: debhelper-compat (= 12)\nStandards-Version: 4.4.1\nHomepage: https://github.com/xwmx/nb\nVcs-Browser: https://github.com/xwmx/nb\nVcs-Git: https://github.com/xwmx/nb.git\n\nPackage: nb\nArchitecture: all\nDepends: bash-completion, pandoc, python3-pygments, ripgrep, tig, w3m, ${misc:Depends}\nDescription: CLI note-taking, bookmarking, and archiving.\n CLI note-taking, bookmarking, and archiving with encryption,\n search, Git-backed versioning and syncing, tagging, and more in a single\n portable script.\n" }, { "path": "etc/debian/copyright", "content": "Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/\nUpstream-Name: nb\nUpstream-Contact: William Melody \nSource: https://github.com/xwmx/nb\n\nFiles: *\nCopyright: 2015 William Melody \nLicense: AGPL-3\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as\n published by the Free Software Foundation, either version 3 of the\n License, or (at your option) any later version.\n .\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU Affero General Public License for more details.\n .\n You should have received a copy of the GNU Affero General Public License\n along with this program. If not, see .\n" }, { "path": "etc/debian/rules", "content": "#!/usr/bin/make -f\n# See debhelper(7) (uncomment to enable)\n# output every command that modifies files on the build system.\n#export DH_VERBOSE = 1\n\n\n# see FEATURE AREAS in dpkg-buildflags(1)\n#export DEB_BUILD_MAINT_OPTIONS = hardening=+all\n\n# see ENVIRONMENT in dpkg-buildflags(1)\n# package maintainers to append CFLAGS\n#export DEB_CFLAGS_MAINT_APPEND = -Wall -pedantic\n# package maintainers to append LDFLAGS\n#export DEB_LDFLAGS_MAINT_APPEND = -Wl,--as-needed\n\n\n%:\n\tdh $@\n\n\n# dh_make generated override targets\n# This is example for Cmake (See https://bugs.debian.org/641051 )\n#override_dh_auto_configure:\n#\tdh_auto_configure -- #\t-DCMAKE_LIBRARY_PATH=$(DEB_HOST_MULTIARCH)\n\n" }, { "path": "etc/nb-completion.bash", "content": "#!/usr/bin/env bash\n###############################################################################\n# __ _\n# \\ \\ _ __ | |__\n# \\ \\ | '_ \\| '_ \\\n# / / | | | | |_) |\n# /_/ |_| |_|_.__/\n#\n# [nb] Command line and local web note-taking, bookmarking, and archiving with\n# plain text data storage, encryption, filtering and search, pinning, #tagging,\n# Git-backed versioning and syncing, Pandoc-backed conversion, global and local\n# notebooks, customizable color themes, [[wiki-style linking]], plugins, and\n# more in a single portable, user-friendly script.\n#\n# https://github.com/xwmx/nb\n###############################################################################\n\n_nb_subcommands() {\n # _nb_cache_completions()\n #\n # Usage:\n # _nb_cache_completions \n #\n # Description:\n # Cache completions for `nb`. Generating completions can be slow and\n # native shell caching doesn't appear to help.\n _nb_cache_completions() {\n local _cache_path=\"${1:-}\"\n\n [[ -z \"${_cache_path:-}\" ]] && return 0\n\n # Remove outdated cache files.\n\n local _base_cache_path=\"${_cache_path%-*}\"\n\n local __suffix=\n for __suffix in \"zsh\" \"v1\"\n do\n if [[ -e \"${_base_cache_path:?}-${__suffix:?}\" ]]\n then\n \\rm -f \"${_base_cache_path:?}-${__suffix:?}\"\n fi\n done\n\n # Rebuild completion cache.\n\n local _commands=()\n IFS=$'\\n' _commands=($(nb subcommands))\n\n local _notebooks=()\n IFS=$'\\n' _notebooks=($(nb notebooks --names --no-color --unarchived))\n\n local _completions=()\n IFS=$'\\n' _completions=(${_commands[@]})\n\n local _commands_cached=\n local _notebooks_cached=\n\n if [[ -e \"${_cache_path}\" ]]\n then\n local _counter=0\n\n while IFS= read -r __line\n do\n _counter=$((_counter+1))\n\n if [[ \"${_counter}\" == 1 ]]\n then\n _commands_cached=\"${__line}\"\n elif [[ \"${_counter}\" == 2 ]]\n then\n _notebooks_cached=\"${__line}\"\n else\n break\n fi\n done < \"${_cache_path}\"\n fi\n\n if [[ \"${_commands_cached}\" != \"${_commands[*]:-}\" ]] ||\n [[ \"${_notebooks_cached}\" != \"${_notebooks[*]:-}\" ]]\n then\n # Construct : completions.\n local __notebook=\n for __notebook in \"${_notebooks[@]}\"\n do\n local __command=\n for __command in \"${_commands[@]}\"\n do\n if [[ -n \"${__notebook:-}\" ]] &&\n [[ -n \"${__command:-}\" ]]\n then\n _completions+=(\"${__notebook}:${__command}\")\n fi\n done\n done\n\n local _directory_path=\n _directory_path=\"$(dirname \"${_cache_path}\")\"\n\n mkdir -p \"${_directory_path}\"\n\n if [[ -f \"${_cache_path:?}\" ]]\n then\n \\rm -f \"${_cache_path:?}\"\n fi\n\n touch \"${_cache_path:?}\"\n\n {\n (IFS=$' '; printf \"%s\\\\n\" \"${_commands[*]}\")\n (IFS=$' '; printf \"%s\\\\n\" \"${_notebooks[*]}\")\n printf \"%s\\\\n\" \"${_completions[@]}\"\n } >> \"${_cache_path}\"\n fi\n }\n\n local _nb_dir=\n _nb_dir=\"$(nb env | grep 'NB_DIR' | cut -d = -f 2)\"\n\n if [[ -z \"${_nb_dir:?}\" ]] ||\n [[ ! -e \"${_nb_dir}\" ]]\n then\n return 0\n elif [[ -L \"${_nb_dir}\" ]]\n then\n if hash \"realpath\" 2>/dev/null\n then\n _nb_dir=\"$(realpath \"${_nb_dir}\")\"\n else\n _nb_dir=\"$(readlink \"${_nb_dir}\")\"\n fi\n fi\n\n if [[ ! -d \"${_nb_dir}\" ]]\n then\n return 0\n fi\n\n local _cache_path=\"${_nb_dir:?}/.cache/nb-completion-cache-v2\"\n local _completions_cached=()\n\n if [[ ! -e \"${_cache_path}\" ]]\n then\n _nb_cache_completions \"${_cache_path}\"\n fi\n\n if [[ -e \"${_cache_path}\" ]]\n then\n local _counter=0\n\n local __line=\n while IFS= read -r __line\n do\n _counter=$((_counter+1))\n\n if [[ \"${_counter}\" -gt 2 ]]\n then\n _completions_cached+=(\"${__line}\")\n fi\n done < \"${_cache_path}\"\n\n (_nb_cache_completions \"${_cache_path}\" &)\n fi\n\n local _current=\"${COMP_WORDS[COMP_CWORD]}\"\n COMPREPLY=()\n\n COMPREPLY=($(compgen -W \"${_completions_cached[*]}\" -- \"${_current}\"))\n}\n\ncomplete -F _nb_subcommands nb\n" }, { "path": "etc/nb-completion.fish", "content": "#!/usr/bin/env fish\n###############################################################################\n# __ _\n# \\ \\ _ __ | |__\n# \\ \\ | '_ \\| '_ \\\n# / / | | | | |_) |\n# /_/ |_| |_|_.__/\n#\n# [nb] Command line and local web note-taking, bookmarking, and archiving with\n# plain text data storage, encryption, filtering and search, pinning, #tagging,\n# Git-backed versioning and syncing, Pandoc-backed conversion, global and local\n# notebooks, customizable color themes, [[wiki-style linking]], plugins, and\n# more in a single portable, user-friendly script.\n#\n# https://github.com/xwmx/nb\n###############################################################################\n\nfunction _nb_subcommands\n # _cache_completions()\n #\n # Usage:\n # _cache_completions [-e/--erase file] \n #\n # Description:\n # Cache completions for `nb`. Generating completions can be slow and\n # native shell caching doesn't appear to help.\n #\n # This function will be written into a temporary file and executed.\n # You can remove the file after executing itself by the -e/--erase option.\n function _cache_completions\n argparse -n _cache_completions -N 1 \"e/erase=\" -- $argv\n or return 1\n set _cache_path $argv[1]\n\n set _commands (nb subcommands)\n set _notebooks (nb notebooks --names --no-color --unarchived)\n\n if test -e $_cache_path\n set __lines (head -n2 $_cache_path)\n set _commands_cached $__lines[1]\n set _notebooks_cached $__lines[2]\n end\n\n if test \"$_commands_cached\" != (string join \" \" $_commands)\n or test \"$_notebooks_cached\" != (string join \" \" $_notebooks)\n\n # Construct : completions.\n for __notebook in $_notebooks\n for __command in $_commands\n if test -n $__notebook\n and test -n $__command\n if eval set -q __desc_$__command\n eval set -a _completions \\$__notebook:\\$__command\\\\t\\$__desc_$__command\n else\n set -a _completions $__notebook:$__command\n end\n end\n end\n end\n\n set _directory_path (dirname $_cache_path)\n mkdir -p $_directory_path\n\n begin\n echo $_commands\n echo $_notebooks\n printf \"%s\\n\" $_completions\n end > $_cache_path\n end\n\n if set -q _flag_erase\n rm $_flag_erase\n end\n end\n\n set _nb_dir (nb env | string replace -fr \"^NB_DIR=\" \"\")\n\n if test -z $_nb_dir\n or not test -e $_nb_dir\n return\n else if test -L $_nb_dir\n set _nb_dir (realpath $_nb_dir)\n end\n\n if not test -d $_nb_dir\n return\n end\n\n set _cache_path $_nb_dir/.cache/nb-completion-cache-v2\n\n if not test -e $_cache_path\n _cache_completions $_cache_path\n end\n\n if test -e $_cache_path\n tail -n+3 $_cache_path\n\n # write the func itself into a temporary file and execute it in background\n set _tmp_file (mktemp -t nb-completion.XXXXXX)\n begin\n functions _cache_completions\n echo \"_cache_completions -e $_tmp_file $_cache_path\"\n end > $_tmp_file\n fish $_tmp_file &\n end\nend\n\ncomplete -c nb -n \"__fish_use_subcommand\" -fa \"(_nb_subcommands)\"\n" }, { "path": "etc/nb-completion.zsh", "content": "#compdef nb\n###############################################################################\n# __ _\n# \\ \\ _ __ | |__\n# \\ \\ | '_ \\| '_ \\\n# / / | | | | |_) |\n# /_/ |_| |_|_.__/\n#\n# [nb] Command line and local web note-taking, bookmarking, and archiving with\n# plain text data storage, encryption, filtering and search, pinning, #tagging,\n# Git-backed versioning and syncing, Pandoc-backed conversion, global and local\n# notebooks, customizable color themes, [[wiki-style linking]], plugins, and\n# more in a single portable, user-friendly script.\n#\n# https://github.com/xwmx/nb\n###############################################################################\n_nb_subcommands() {\n # _nb_cache_completions()\n #\n # Usage:\n # _nb_cache_completions \n #\n # Description:\n # Cache completions for `nb`. Generating completions can be slow and\n # native shell caching doesn't appear to help.\n _nb_cache_completions() {\n local _cache_path=\"${1:-}\"\n\n [[ -z \"${_cache_path:-}\" ]] && return 0\n\n # Remove outdated cache files.\n\n local _base_cache_path=\"${_cache_path%-*}\"\n\n local __suffix=\n for __suffix in \"zsh\" \"v1\"\n do\n if [[ -e \"${_base_cache_path:?}-${__suffix:?}\" ]]\n then\n \\rm -f \"${_base_cache_path:?}-${__suffix:?}\"\n fi\n done\n\n # Rebuild completion cache.\n\n local _commands=\n IFS=$'\\n' _commands=($(nb subcommands))\n\n local _notebooks=\n IFS=$'\\n' _notebooks=($(nb notebooks --names --no-color --unarchived))\n\n local _completions=()\n IFS=$'\\n' _completions=(${_commands[@]})\n\n local _commands_cached=\n local _notebooks_cached=\n\n if [[ -e \"${_cache_path}\" ]]\n then\n local _counter=0\n\n local __line=\n while IFS= read -r __line\n do\n _counter=$((_counter+1))\n\n if [[ \"${_counter}\" == 1 ]]\n then\n _commands_cached=\"${__line}\"\n elif [[ \"${_counter}\" == 2 ]]\n then\n _notebooks_cached=\"${__line}\"\n else\n break\n fi\n done < \"${_cache_path}\"\n fi\n\n if [[ \"${_commands_cached}\" != \"${_commands[*]:-}\" ]] ||\n [[ \"${_notebooks_cached}\" != \"${_notebooks[*]:-}\" ]]\n then\n # Construct : completions.\n local __notebook=\n for __notebook in \"${_notebooks[@]}\"\n do\n local __command=\n for __command in \"${_commands[@]}\"\n do\n if [[ -n \"${__notebook:-}\" ]] &&\n [[ -n \"${__command:-}\" ]]\n then\n _completions+=(\"${__notebook}:${__command}\")\n fi\n done\n done\n\n local _directory_path=\n _directory_path=\"$(dirname \"${_cache_path}\")\"\n\n mkdir -p \"${_directory_path}\"\n\n if [[ -f \"${_cache_path:?}\" ]]\n then\n \\rm -f \"${_cache_path:?}\"\n fi\n\n touch \"${_cache_path:?}\"\n\n {\n (IFS=$' '; printf \"%s\\\\n\" \"${_commands[*]}\")\n (IFS=$' '; printf \"%s\\\\n\" \"${_notebooks[*]}\")\n printf \"%s\\\\n\" \"${_completions[@]}\"\n } >> \"${_cache_path}\"\n fi\n }\n\n local _nb_dir=\n _nb_dir=\"$(nb env | grep 'NB_DIR' | cut -d = -f 2)\"\n\n if [[ -z \"${_nb_dir:?}\" ]] ||\n [[ ! -e \"${_nb_dir}\" ]]\n then\n return 0\n elif [[ -L \"${_nb_dir}\" ]]\n then\n if hash \"realpath\" 2>/dev/null\n then\n _nb_dir=\"$(realpath \"${_nb_dir}\")\"\n else\n _nb_dir=\"$(readlink \"${_nb_dir}\")\"\n fi\n fi\n\n if [[ ! -d \"${_nb_dir}\" ]]\n then\n return 0\n fi\n\n local _cache_path=\"${_nb_dir:?}/.cache/nb-completion-cache-v2\"\n local _completions_cached=()\n\n if [[ ! -e \"${_cache_path}\" ]]\n then\n _nb_cache_completions \"${_cache_path}\"\n fi\n\n if [[ -e \"${_cache_path}\" ]]\n then\n local _counter=0\n\n local __line=\n while IFS= read -r __line\n do\n _counter=$((_counter+1))\n\n if [[ \"${_counter}\" -gt 2 ]]\n then\n _completions_cached+=(\"${__line}\")\n fi\n done < \"${_cache_path}\"\n\n (_nb_cache_completions \"${_cache_path}\" &)\n fi\n\n if [[ \"${?}\" -eq 0 ]]\n then\n compadd -- \"${_completions_cached[@]}\"\n return 0\n else\n return 1\n fi\n}\n\n_nb_subcommands \"$@\"\n" }, { "path": "nb", "content": "#!/usr/bin/env bash\n###############################################################################\n# __ _\n# \\ \\ _ __ | |__\n# \\ \\ | '_ \\| '_ \\\n# / / | | | | |_) |\n# /_/ |_| |_|_.__/\n#\n# [nb] Command line and local web note-taking, bookmarking, and archiving with\n# plain text data storage, encryption, filtering and search, pinning, #tagging,\n# Git-backed versioning and syncing, Pandoc-backed conversion, global and local\n# notebooks, customizable color themes, [[wiki-style linking]], plugins, and\n# more in a single portable, user-friendly script.\n#\n# ❯ https://github.com/xwmx/nb\n# ❯ https://xwmx.github.io/nb\n#\n# Based on Bash Boilerplate: https://github.com/xwmx/bash-boilerplate\n#\n# Copyright (c) 2015-present William Melody ┯ hi@williammelody.com\n# ┕ https://www.williammelody.com\n#\n# Overview\n# ========\n#\n# - Configuration and Setup\n# - Helpers: Group 1 (alphabetical order)\n# - Subcommands: Group 1 (alphabetical order)\n# - Plugins\n# - Option Parsing\n# - _main() / Dispatch\n# - Configuration: Group 2\n# - Helpers: Group 2 (alphabetical order)\n# - Subcommands: Group 2 (alphabetical order)\n# - Subcommands: Group 3 (alphabetical order)\n#\n# Target Bash Version: 5 (target, recommended)\n# Minimum Recommended Bash Version: 4 (fallback, recommended)\n# Minimum Tested Bash Version: 3.2 (fallback, deprecated)\n#\n# AGPLv3\n#\n# This program is free software: you can redistribute it and/or modify\n# it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n###############################################################################\n\n###############################################################################\n# Shell Options & Strict Mode\n#\n# More Information:\n# https://github.com/xwmx/bash-boilerplate#bash-strict-mode\n# https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html\n# https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html\n# https://tldp.org/LDP/abs/html/options.html\n###############################################################################\n\nset -o errexit\nset -o noglob\nset -o nounset\nset -o pipefail\n\nset +o noclobber\n\nshopt -s extglob\n\nIFS=$'\\n\\t'\n\n###############################################################################\n# Environment\n###############################################################################\n\n# $_VERSION\n#\n# The most recent program version.\n_VERSION=\"7.25.3\"\n\n# $_ME\n#\n# This program's basename.\n_ME=\"$(basename \"${0}\")\"\n\n# $_MY_DIR\n#\n# The directory containing $_ME.\n_MY_DIR=\"$(cd \"$(dirname \"${0}\")\"; pwd)\"\n\n# $_MY_PATH\n#\n# This program's full path.\n_MY_PATH=\"${_MY_DIR}/${_ME}\"\n\n# $_CURRENT_WORKING_DIR\n#\n# The current working directory in which the program was invoked.\n_CURRENT_WORKING_DIR=\"${PWD}\"\n\n# $_REPO\n#\n# The / identifier for this project's git repository.\n_REPO=\"xwmx/nb\"\n\n# $_REPO_MAIN_BRANCH\n#\n# The name of the main branch in this project's git repository.\n_REPO_MAIN_BRANCH=\"master\"\n\n# $_REPO_RAW_URL\n#\n# The base URL for raw files.\n_REPO_RAW_URL=\"https://raw.githubusercontent.com/${_REPO}/${_REPO_MAIN_BRANCH}\"\n\n###############################################################################\n# Utilities\n###############################################################################\n\n# _command_exists()\n#\n# Usage:\n# _command_exists \n#\n# Exit / Error / Return Status:\n# 0 (success, true) If a command is defined in the current environment.\n# 1 (error, false) If not.\n#\n# More Information:\n# http://stackoverflow.com/a/677212\n_command_exists() {\n if [[ \"${1:-}\" == \"w3m\" ]]\n then # Detect WSL 1 (https://stackoverflow.com/a/38859331), where w3m errors.\n [[ -f /proc/version ]] && grep -q Micro /proc/version && return 1\n fi\n\n hash \"${1}\" 2>/dev/null\n}\n\n# _contains()\n#\n# Usage:\n# _contains ...\n#\n# Exit / Error / Return Status:\n# 0 (success, true) If the item is included in the list.\n# 1 (error, false) If not.\n#\n# Example:\n# _contains \"${_query}\" \"${_list[@]}\"\n_contains() {\n local _query=\"${1:-}\"\n\n shift\n\n if [[ -z \"${_query}\" ]] ||\n [[ -z \"${*:-}\" ]]\n then\n return 1\n fi\n\n local __element=\n for __element in \"${@}\"\n do\n [[ \"${__element}\" == \"${_query}\" ]] && return 0\n done\n\n return 1\n}\n\n# _resolve_symlink()\n#\n# Usage:\n# _resolve_symlink \n#\n# Description:\n# Resolve the real path or target for a symbolic link.\n_resolve_symlink() {\n if hash \"realpath\" 2>/dev/null\n then\n realpath \"${@:-}\"\n else\n readlink \"${@:-}\"\n fi\n}\n\n# _sed_i()\n#\n# Usage:\n# _sed_i ...\n#\n# Description:\n# `sed -i` takes an extension on macOS, but that extension can cause errors\n# in GNU `sed`. Detect which `sed` is available and call it with the\n# appropriate arguments.\n#\n# More Information:\n# https://stackoverflow.com/q/43171648\n# https://stackoverflow.com/a/16746032\n_sed_i() {\n local _usage=\n\n if _usage=\"$(sed --help 2>&1 || false)\"\n then # GNU\n sed -i \"${@}\"\n else # BSD\n if [[ \"${_usage:-}\" =~ unknown\\ option ]]\n then # OpenBSD\n sed -i'' \"${@}\"\n else # FreeBSD, macOS\n sed -i '' \"${@}\"\n fi\n fi\n}\n\n# _tput()\n#\n# Usage:\n# _tput ...\n#\n# Description:\n# Run `tput` commands, with fallbacks to termcap names for FreeBSD and\n# `stty` and escape sequences when `tput` is not found.\n_tput() {\n if _command_exists \"tput\"\n then\n # More info: https://stackoverflow.com/a/64214019\n case \"${1:-}\" in\n cols)\n if tput cols &>/dev/null\n then\n tput cols\n elif tput co &>/dev/null\n then\n tput co\n else\n printf \"80\\\\n\"\n fi\n\n return 0\n ;;\n lines)\n if tput lines &>/dev/null\n then\n tput lines\n elif tput li &>/dev/null\n then\n tput li\n else\n printf \"20\\\\n\"\n fi\n\n return 0\n ;;\n setaf|smul)\n ((${_COLOR_ENABLED:-1})) || return 0\n ;;\n esac\n\n tput \"${@:-}\" 2>/dev/null || {\n case \"${1:-}\" in\n sgr0)\n tput me\n ;;\n smul)\n tput us\n ;;\n setaf)\n tput AF \"${@:2}\"\n ;;\n esac\n } 2>/dev/null || printf \"\"\n else\n case \"${1:-}\" in\n cols|lines)\n {\n stty size 2>/dev/null || printf \"20 80\\\\n\"\n } | if [[ \"${1:-}\" == \"cols\" ]]\n then\n cut -d \" \" -f 2\n else\n cut -d \" \" -f 1\n fi\n ;;\n setaf)\n printf '\\033[38;5;%sm' \"${2:-}\"\n ;;\n sgr0)\n printf '\\033[m'\n ;;\n smul)\n printf '\\033[4m'\n ;;\n esac\n fi\n}\n\n###############################################################################\n# Debug\n###############################################################################\n\n# _debug()\n#\n# Usage:\n# _debug ...\n#\n# Description:\n# Execute a command and print to standard error. The command is expected to\n# print a message and should typically be either `echo`, `printf`, or `cat`.\n#\n# Example:\n# _debug printf \"Debug info. Variable: %s\\\\n\" \"$0\"\n__DEBUG_COUNTER=0\n__DEBUG_START_TIME=\n_debug() {\n # Usage: __debug_get_timestamp\n __debug_get_timestamp() {\n if hash \"gdate\" 2>/dev/null\n then\n gdate +%s%3N\n elif date --version >/dev/null 2>&1\n then\n date +%s%3N\n else\n return 1\n fi\n }\n\n if ((${_USE_DEBUG:-0}))\n then\n __DEBUG_COUNTER=$((__DEBUG_COUNTER+1))\n printf \"🐛 %s\" \"${__DEBUG_COUNTER} \"\n\n \"${@}\"\n\n if [[ -n \"${__DEBUG_START_TIME:-}\" ]]\n then\n printf \"⏱ %s\\\\n\" \"$(($(__debug_get_timestamp)-__DEBUG_START_TIME))\"\n elif __DEBUG_START_TIME=\"$(__debug_get_timestamp)\"\n then\n printf \"⏱ 0\\\\n\"\n fi\n\n printf \"―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――\\\\n\"\n fi 1>&2\n}\n\n###############################################################################\n# Error Messages\n###############################################################################\n\n# _exit_1()\n#\n# Usage:\n# _exit_1 \n#\n# Description:\n# Exit with status 1 after executing the specified command with output\n# redirected to standard error. The command is expected to print a message\n# and should typically be either `echo`, `printf`, or `cat`.\n_exit_1() {\n {\n [[ \"${1:-}\" == \"_help\" ]] || printf \"%s \" \"$(_tput setaf 1)!$(_tput sgr0)\"\n\n \"${@}\"\n } 1>&2\n\n exit 1\n}\n\n# _warn()\n#\n# Usage:\n# _warn \n#\n# Description:\n# Print the specified command with output redirected to standard error.\n# The command is expected to print a message and should typically be either\n# `echo`, `printf`, or `cat`.\n_warn() {\n {\n printf \"%s \" \"$(_tput setaf 1)!$(_tput sgr0)\"\n\n \"${@}\"\n } 1>&2\n}\n\n###############################################################################\n# Option Helpers\n###############################################################################\n\n# _option_get_value()\n#\n# Usage:\n# _option_get_value