Skip to content

CLI Installation

The Notebind CLI (notebind) syncs markdown files between your local machine and the Notebind platform. It’s built in Rust for fast, reliable operation.

Terminal window
cargo install notebind

Requires Rust 2024 edition or later.

Terminal window
git clone https://github.com/notebind/cli.git
cd cli
cargo install --path .
Terminal window
notebind --version
  1. Authenticate

    Terminal window
    notebind auth --token nb_sk_YOUR_API_KEY

    Or run without --token for an interactive prompt. The key is saved to ~/.config/notebind/config.toml.

  2. Initialize a project

    In your repository root:

    Terminal window
    notebind init

    This creates a .notebind/ directory with a manifest.toml file that tracks file-to-document mappings.

  3. Push your first file

    Terminal window
    notebind push README.md

By default, all commands output JSON for easy parsing by agents and scripts:

Terminal window
notebind list
[
{"id": "doc-uuid", "title": "README.md", "updated_at": "2026-03-13T12:00:00Z"}
]

For human-readable colored output:

Terminal window
notebind list --pretty
Documents:
README.md (doc-uuid) Updated: Mar 13, 2026