nb

command line and local web note‑taking, bookmarking, archiving, and knowledge base application

Help

(B __          _(B 
(B \ \   _ __ | |__(B 
(B  \ \ | '_ \| '_ \(B 
(B  / / | | | | |_) |(B 
(B /_/  |_| |_|_.__/(B 

 ------------------(B 

(B[nb](B Command line and local web note-taking, bookmarking, and archiving with 
plain text data storage, encryption, filtering and search, pinning, (B#(Btagging, 
Git-backed versioning and syncing, Pandoc-backed conversion, global and local 
notebooks, customizable color themes, (B[(B(B[(Bwiki-style linking(B](B(B](B, plugins, and more 
in a single portable, user-friendly script. 

(BHelp(B:
  nb help               Display this help information. 
  nb help   View help information for 
  nb help --colors      View information about color settings. 
  nb help --readme      View the (B`(Bnb(B`(B README file. 

(BUsage(B:
  nb 
  nb (B[(B...(B](B (B[(B (B|(B  (B|(B  (B|(B  (B|(B <notebook>(B](B <br>  nb (B[(B<url>(B](B (B[(B<bookmark options>...(B](B <br>  nb add (B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<filename>(B](B (B[(B<content>(B](B <br>         (B[(B-b (B|(B <b>--browse(B](B</b> (B[(B-c <content> (B|(B <b>--content</b> <content>(B](B (B[(B--edit(B](B <br>         (B[(B-e (B|(B <b>--encrypt(B](B</b> (B[(B-f <filename> (B|(B <b>--filename</b> <filename>(B](B <br>         (B[(B--folder <folder-path>(B](B (B[(B--tags <tag1>,<tag2>...(B](B <br>         (B[(B-t <title> (B|(B <b>--title</b> <title>(B](B (B[(B--type <type>(B](B <br>  nb add bookmark (B[(B<bookmark-options>...(B](B <br>  nb add folder (B[(B<name>(B](B <br>  nb add todo (B[(B<todo-options>...(B](B <br>  nb archive (B[(B<notebook>(B](B <br>  nb bookmark (B[(B<ls-options>...(B](B <br>  nb bookmark (B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B <url> <br>              (B[(B-c <comment> (B|(B <b>--comment</b> <comment>(B](B (B[(B--edit(B](B (B[(B-e (B|(B <b>--encrypt(B](B</b> <br>              (B[(B-f <filename> (B|(B <b>--filename</b> <filename>(B](B (B[(B--no-request(B](B <br>              (B[(B-q <quote> (B|(B <b>--quote</b> <quote>(B](B (B[(B--save-source(B](B <br>              (B[(B-r (B((B<url> (B|(B <selector>(B)(B (B|(B <b>--related</b> (B((B<url> (B|(B <selector>(B)(B(B](B... <br>              (B[(B-t <tag1>,<tag2>... (B|(B <b>--tags</b> <tag1>,<tag2>...(B](B (B[(B--title <title>(B](B <br>  nb bookmark (B[(Blist (B[(B<list-options>...(B](B(B](B <br>  nb bookmark (B((Bedit (B|(B delete (B|(B open (B|(B peek (B|(B url(B)(B <br>              (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B <br>  nb bookmark search <query> <br>  nb browse (B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B <br>            (B[(B-g (B|(B <b>--gui(B](B</b> (B[(B-n (B|(B <b>--notebooks(B](B</b> (B[(B-p (B|(B <b>--print(B](B</b> (B[(B-q (B|(B <b>--query</b> <query>(B](B <br>            (B[(B-s (B|(B <b>--serve(B](B</b> (B[(B-t <tag> (B|(B <b>--tag</b> <tag> (B|(B <b>--tags</b> <tag1>,<tag2>...(B](B <br>  nb browse add (B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<filename>(B](B <br>            (B[(B-c <content> (B|(B <b>--content</b> <content>(B](B (B[(B--tags <tag1>,<tag2>...(B](B <br>            (B[(B-t <title> (B|(B <b>--title</b> <title>(B](B <br>  nb browse delete (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B <br>  nb browse edit (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B <br>  nb completions (B((Bcheck (B|(B install (B[(B-d (B|(B <b>--download(B](B</b> (B|(B uninstall(B)(B <br>  nb count (B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B <br>  nb delete (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B... <br>            (B[(B-f (B|(B <b>--force(B](B</b> <br>  nb do (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B <br>        (B[(B<task-number>(B](B <br>  nb edit (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B <br>          (B[(B-c <content> (B|(B <b>--content</b> <content>(B](B (B[(B--edit(B](B <br>          (B[(B-e <editor> (B|(B <b>--editor</b> <editor>(B](B (B[(B--overwrite(B](B (B[(B--prepend(B](B <br>  nb export (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B <br>            <path> (B[(B-f (B|(B <b>--force(B](B</b> (B[(B<pandoc options>...(B](B <br>  nb export notebook <name> (B[(B<path>(B](B <br>  nb export pandoc (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B <br>            (B[(B<pandoc options>...(B](B <br>  nb git (B[(Bcheckpoint (B[(B<message>(B](B (B|(B dirty(B](B <br>  nb git <git-options>... <br>  nb help (B[(B<subcommand>(B](B (B[(B-p (B|(B <b>--print(B](B</b> <br>  nb help (B[(B-c (B|(B <b>--colors(B](B</b> (B|(B (B[(B-r (B|(B <b>--readme(B](B</b> (B|(B (B[(B-s (B|(B <b>--short(B](B</b> (B[(B-p (B|(B <b>--print(B](B</b> <br>  nb history (B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B <br>  nb import (B[(Bcopy (B|(B download (B|(B move(B](B (B((B<path>... (B|(B <url>(B)(B (B[(B--convert(B](B <br>            (B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<filename>(B](B <br>  nb import notebook <path> (B[(B<name>(B](B <br>  nb init (B[(B<remote-url> (B[(B<branch>(B](B(B](B (B[(B--author(B](B (B[(B--email <email>(B](B <br>          (B[(B--name <name>(B](B <br>  nb list (B[(B-e (B[(B<length>(B](B (B|(B <b>--excerpt</b> (B[(B<length>(B](B(B](B (B[(B--filenames(B](B <br>          (B[(B-n <limit> (B|(B <b>--limit</b> <limit> (B|(B <b>--<limit>(B](B</b> (B[(B--no-id(B](B <br>          (B[(B--no-indicator(B](B (B[(B-p <number> (B|(B <b>--page</b> <number>(B](B (B[(B--pager(B](B <br>          (B[(B--paths(B](B (B[(B-s (B|(B <b>--sort(B](B</b> (B[(B-r (B|(B <b>--reverse(B](B</b> (B[(B--tags(B](B <br>          (B[(B-t <type> (B|(B <b>--type</b> <type> (B|(B <b>--<type>(B](B</b> <br>          (B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <path> (B|(B <query>(B](B <br>  nb ls (B[(B-a (B|(B <b>--all(B](B</b> (B[(B-b (B|(B <b>--browse(B](B</b> (B[(B-e (B[(B<length>(B](B (B|(B <b>--excerpt</b> (B[(B<length>(B](B(B](B <br>        (B[(B--filenames(B](B (B[(B-g (B|(B <b>--gui(B](B</b> (B[(B-n <limit> (B|(B <b>--limit</b> <limit> (B|(B <b>--<limit>(B](B</b> <br>        (B[(B--no-footer(B](B (B[(B--no-header(B](B (B[(B--no-id(B](B (B[(B--no-indicator(B](B <br>        (B[(B-p <number> (B|(B <b>--page</b> <number>(B](B (B[(B--pager(B](B (B[(B--paths(B](B (B[(B-s (B|(B <b>--sort(B](B</b> <br>        (B[(B-r (B|(B <b>--reverse(B](B</b> (B[(B--tags(B](B (B[(B-t <type> (B|(B <b>--type</b> <type> (B|(B <b>--<type>(B](B</b> <br>        (B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <path> (B|(B <query>(B](B <br>  nb move (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B <br>          (B((B(B[(B<notebook>:(B](B(B[(B<path>(B](B (B|(B <b>--reset</b> (B|(B <b>--to-bookmark</b> (B|(B <b>--to-note</b> (B|(B <br>          <b>--to-title</b> (B|(B <b>--to-todo(B)(B</b> (B[(B-f (B|(B <b>--force(B](B</b> <br>  nb notebooks (B[(B<name> (B|(B <query>(B](B (B[(B--ar (B|(B <b>--archived(B](B</b> (B[(B--global(B](B (B[(B--local(B](B <br>               (B[(B--names(B](B (B[(B--paths(B](B (B[(B--unar (B|(B <b>--unarchived(B](B</b> <br>  nb notebooks add <name> (B[(B<remote-url> (B[(B<branch>(B](B(B](B (B[(B--author(B](B <br>                   (B[(B--email <email>(B](B (B[(B--name <name>(B](B <br>  nb notebooks (B((Barchive (B|(B open (B|(B peek (B|(B status (B|(B unarchive(B)(B (B[(B<name>(B](B <br>  nb notebooks author (B[(B<name> (B|(B <path>(B](B (B[(B--email <email>(B](B (B[(B--name <name>(B](B <br>  nb notebooks current (B[(B--path (B|(B <b>--selected</b> (B|(B <b>--filename</b> (B[(B<filename>(B](B(B](B <br>                       (B[(B--global (B|(B <b>--local(B](B</b> <br>  nb notebooks delete <name> (B[(B-f (B|(B <b>--force(B](B</b> <br>  nb notebooks (B((Bexport <name> (B[(B<path>(B](B (B|(B import <path>(B)(B <br>  nb notebooks init (B[(B<path> (B[(B<remote-url> (B[(B<branch>(B](B(B](B(B](B (B[(B--author(B](B <br>                    (B[(B--email <email>(B](B (B[(B--name <name>(B](B <br>  nb notebooks rename <old-name> <new-name> <br>  nb notebooks select <selector> <br>  nb notebooks show (B((B<name> (B|(B <path> (B|(B <selector>(B)(B (B[(B--ar (B|(B <b>--archived(B](B</b> <br>                    (B[(B--escaped (B|(B <b>--name</b> (B|(B <b>--path</b> (B|(B <b>--filename</b> (B[(B<filename>(B](B(B](B <br>  nb notebooks use <name> <br>  nb open (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B <br>  nb peek (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B <br>  nb pin  (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B <br>  nb plugins (B[(B<name>(B](B (B[(B--paths(B](B <br>  nb plugins install (B[(B<path> (B|(B <url>(B](B (B[(B--force(B](B <br>  nb plugins uninstall <name> (B[(B--force(B](B <br>  nb remote (B[(Bbranches (B[(B<url>(B](B (B|(B remove (B|(B rename (B[(B<branch-name>(B](B <name>(B](B <br>  nb remote (B[(Bdelete <branch-name> (B|(B reset <branch-name>(B](B <br>  nb remote set <url> (B[(B<branch-name>(B](B <br>  nb run <command> (B[(B<arguments>...(B](B <br>  nb search (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B <br>            <query>... (B[(B-a (B|(B <b>--all(B](B</b> (B[(B--and <query>(B](B (B[(B--or <query>(B](B <br>            (B[(B-l (B|(B <b>--list(B](B</b> (B[(B--path(B](B (B[(B-t <tag1>,<tag2>... (B|(B <b>--tag</b> <tag1>,<tag2>...(B](B <br>            (B[(B-t (B|(B <b>--tags(B](B</b> (B[(B--type <type> (B|(B <b>--<type>(B](B</b> (B[(B--utility <name>(B](B <br>  nb set (B[(B<name> (B[(B<value>(B](B (B|(B <number> (B[(B<value>(B](B(B](B <br>  nb settings (B[(Bcolors (B[(B<number> (B|(B themes(B](B (B|(B edit (B|(B list (B[(B--long(B](B(B](B <br>  nb settings (B((Bget (B|(B show (B|(B unset(B)(B (B((B<name> (B|(B <number>(B)(B <br>  nb settings set (B((B<name> (B|(B <number>(B)(B <value> <br>  nb shell (B[(B<subcommand> (B[(B<options>...(B](B (B|(B <b>--clear-history(B](B</b> <br>  nb show (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B <br>          (B[(B(B[(B-a (B|(B <b>--added(B](B</b> (B|(B (B[(B--authors(B](B (B|(B (B[(B-b (B|(B <b>--browse(B](B</b> (B|(B <b>--filename</b> (B|(B <b>--id</b> (B|(B <br>          <b>--info-line</b> (B|(B <b>--path</b> (B|(B (B[(B-p (B|(B <b>--print(B](B</b> (B|(B <b>--relative-path</b> (B|(B (B[(B-r (B|(B <br>          <b>--render(B](B</b> (B|(B <b>--title</b> (B|(B <b>--type</b> (B[(B<type>(B](B (B|(B (B[(B-u (B|(B <b>--updated(B](B(B](B</b> (B[(B--no-color(B](B <br>  nb show <notebook> <br>  nb status (B[(B<notebook>(B](B <br>  nb subcommands (B[(Badd <name>...(B](B (B[(Balias <name> <alias>(B](B <br>                 (B[(Bdescribe <name> <usage>(B](B <br>  nb sync (B[(B-a (B|(B <b>--all(B](B</b> <br>  nb tasks (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <description>(B](B(B)(B <br>           (B[(Bopen (B|(B closed(B](B <br>  nb todo add (B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<filename>(B](B <title> <br>              (B[(B--description <description>(B](B (B[(B--due <date>(B](B <br>              (B[(B-r (B((B<url> (B|(B <selector>(B)(B (B|(B <b>--related</b> (B((B<url> (B|(B <selector>(B)(B(B](B <br>              (B[(B--tags <tag1>,<tag2>...(B](B (B[(B--task <title>(B](B... <br>  nb todo do   (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <description>(B](B(B)(B <br>               (B[(B<task-number>(B](B <br>  nb todo undo (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <description>(B](B(B)(B <br>               (B[(B<task-number>(B](B <br>  nb todos (B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B (B[(Bopen (B|(B closed(B](B <br>  nb todos tasks (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <description>(B](B(B)(B <br>                 (B[(Bopen (B|(B closed(B](B <br>  nb unarchive (B[(B<notebook>(B](B <br>  nb undo (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B <br>          (B[(B<task-number>(B](B <br>  nb unpin (B((B(B[(B<notebook>:(B](B(B[(B<folder-path>/(B](B(B[(B<id> (B|(B <filename> (B|(B <title>(B](B(B)(B <br>  nb unset (B((B<name> (B|(B <number>(B)(B <br>  nb update <br>  nb use <notebook> <br>  nb <b>-h</b> (B|(B <b>--help</b> (B|(B help (B[(B<subcommand> (B|(B <b>--readme(B](B</b> <br>  nb <b>-i</b> (B|(B <b>--interactive</b> (B[(B<subcommand> (B[(B<options>...(B](B(B](B <br>  nb <b>--no-color</b> <br>  nb <b>--version</b> (B|(B version <br><br><b>(BSubcommands(B:</b><br>  (B((Bdefault(B)(B    List notes and notebooks. This is an alias for (B`(Bnb ls(B`(B. <br>               When a <url> is provided, create a new bookmark. <br>  add          Add a note, folder, or file. <br>  archive      Archive the current or specified notebook. <br>  bookmark     Add, open, list, and search bookmarks. <br>  browse       Browse and manage linked items in terminal and GUI browsers. <br>  completions  Install and uninstall completion scripts. <br>  count        Print the number of items in a notebook or folder. <br>  delete       Delete a note. <br>  do           Mark a todo or task as done. <br>  edit         Edit a note. <br>  export       Export a note to a variety of different formats. <br>  git          Run (B`(Bgit(B`(B commands within the current notebook. <br>  help         View help information for the program or a subcommand. <br>  history      View git history for the current notebook or a note. <br>  import       Import a file into the current notebook. <br>  init         Initialize the first notebook. <br>  list         List notes in the current notebook. <br>  ls           List notebooks and notes in the current notebook. <br>  move         Move or rename a note. <br>  notebooks    Manage notebooks. <br>  open         Open a bookmarked web page or notebook folder, or edit a note. <br>  peek         View a note, bookmarked web page, or notebook in the terminal. <br>  pin          Pin an item so it appears first in lists. <br>  plugins      Install and uninstall plugins and themes. <br>  remote       Configure the remote URL and branch for the notebook. <br>  run          Run shell commands within the current notebook. <br>  search       Search notes. <br>  settings     Edit configuration settings. <br>  shell        Start the (B`(Bnb(B`(B interactive shell. <br>  show         Show a note or notebook. <br>  status       Print notebook status information. <br>  subcommands  List, add, alias, and describe subcommands. <br>  sync         Sync local notebook with the remote repository. <br>  tasks        List tasks in todos, notebooks, folders, and other items. <br>  todo         Manage todos and tasks. <br>  unarchive    Unarchive the current or specified notebook. <br>  undo         Mark a todo or task as not done. <br>  unset        Return a setting to its default value. <br>  unpin        Unpin a pinned item. <br>  update       Update (B`(Bnb(B`(B to the latest version. <br>  use          Switch to a notebook. <br>  version      Display version information. <br><br><b>(BNotebook Usage(B:</b><br>  nb <notebook>:(B[(B<subcommand>(B](B (B[(B<identifier>(B](B (B[(B<options>...(B](B <br>  nb <subcommand> <notebook>:<identifier> (B[(B<options>...(B](B <br><br><b>(BProgram Options(B:</b><br>  <b>-h,</b> <b>--help</b>          Display this help information. <br>  <b>-i,</b> <b>--interactive</b>   Start the (B`(Bnb(B`(B interactive shell. <br>  <b>--no-color</b>          Print without color highlighting. <br>  <b>--version</b>           Display version information. <br><br><b>(BMore Information(B:</b><br>  https://github.com/xwmx/nb <br><br><b>(BSponsor & Donate(B:</b><br>  https://github.com/sponsors/xwmx <br>  https://paypal.me/WilliamMelody <br><br><b>(BCreated By(B:</b><br>  William Melody <br>  https://github.com/xwmx <br>  https://www.williammelody.com <br><br><b>(BContributors(B:</b><br>  https://github.com/xwmx/nb/graphs/contributors <br></p> </div> <button onclick="toggleAll(this)" class="toggle-all-button">COLLAPSE ALL</button></div> <div class="tooltip"><b>Copied to clipboard</b></div> <div style="text-align: center;"><a href="https://coindodo.io/digitalocean" target="_blank"><img style="max-width: calc(100% - 4px);" src="/images/af/digitalocean.webp" loading="lazy" width="480"></a></div> <div id="filler"></div> <footer>All man pages are copyrighted by their respective authors. Thanks to <a target="_blank" rel="noopener" href="https://github.com/tldr-pages/tldr">TLDR</a> and <a target="_blank" rel="noopener" href="https://www.commandlinefu.com">commandlinefu.com</a><br><br> <div style="display: flex;flex-wrap: wrap;align-items: center;justify-content: center;">Simon Schubert - info@linuxcommandlibrary.com <a href="https://github.com/SimonSchubert/LinuxCommandLibrary" target="_blank" rel="noopener"><img src="/images/logo-github.svg" width="25" height="25"></a></div> <br><a href="https://play.google.com/store/apps/details?id=com.inspiredandroid.linuxcommandbibliotheca" style="margin-right: 4px;" target="_blank" rel="noopener"><img src="/images/google-play-download.svg" alt="Google Play Store" class="download-icon" width="169" height="50"></a><a href="https://f-droid.org/en/packages/com.inspiredandroid.linuxcommandbibliotheca" style="margin-left: 4px;" target="_blank" rel="noopener"><img src="/images/f-droid-download.png" alt="F-Droid Store" class="download-icon" width="168" height="50"></a> <div style="width: 100%; justify-content: center; padding-top: 6px; display: flex; align-items: center; gap: 6px;">My other projects: <div class="project"><a href="https://coindodo.io" target="_blank" rel="noopener"><img src="/images/project-coindodo.webp" alt="coindodo.io" width="30" height="30"></a></div> <div class="project"><a href="https://whatch.online" target="_blank" rel="noopener"><img src="/images/project-whatch.webp" alt="whatch.online" width="30" height="30"></a></div> </div> </footer> <script src="/scripts/man.js?v=10" defer="defer"></script> </body> </html>