Skip to content

CLI Commands

All commands support the --pretty flag for human-readable colored output. Without it, output is JSON.

Store your API key for future requests.

Terminal window
notebind auth --token nb_sk_YOUR_KEY

Without --token, prompts interactively.

Saves the key to ~/.config/notebind/config.toml.


Initialize a .notebind/ directory in the current folder.

Terminal window
notebind init

Creates .notebind/manifest.toml which tracks the mapping between local files and remote document IDs.

Link a local file to an existing remote document.

Terminal window
notebind link article.md DOC_ID

Adds the mapping to .notebind/manifest.toml:

[documents]
"article.md" = "DOC_ID"

Show sync state of all linked documents.

Terminal window
notebind status

Push a local markdown file to the platform.

Terminal window
notebind push article.md
  • If the file is already linked to a document, updates the existing document
  • If not linked, creates a new document and adds the mapping to the manifest

Pull a document with all its feedback (comments + suggestions) as JSON.

Terminal window
notebind pull DOC_ID

If only one document is linked, the ID is optional:

Terminal window
notebind pull

List all documents on your account.

Terminal window
notebind list

Create a share link for a document.

Terminal window
notebind share DOC_ID --permission comment
FlagDefaultValuesDescription
--permissioncommentview, comment, editPermission level

List unresolved comments on a document.

Terminal window
notebind comments DOC_ID

List pending suggestions on a document.

Terminal window
notebind suggestions DOC_ID

Resolve a comment.

Terminal window
notebind resolve DOC_ID COMMENT_ID

Accept a suggestion (applies the text replacement to the document).

Terminal window
notebind accept DOC_ID SUGGESTION_ID

Reject a suggestion (marks as rejected without modifying the document).

Terminal window
notebind reject DOC_ID SUGGESTION_ID

FlagDescription
--prettyHuman-readable colored output instead of JSON
--versionShow version number
--helpShow help for any command