Skip to content

Installation.md

Latest commit

 

History

History
58 lines (43 loc) · 1.74 KB

Installation.md

File metadata and controls

58 lines (43 loc) · 1.74 KB
Raw

Installation

Prerequisites

  • Go 1.26.4 or higher.
  • make (optional, to build from source).
  • A CGO-enabled toolchain (GCC or Clang on Linux or macOS). The embedded vector database requires C and C++ bindings.

Install Pre-built Binaries (Recommended)

  1. Download the pre-built Linux binary from the GitHub Releases page.
  2. Extract the archive.
  3. Put the notebrain binary in your $PATH.

Note: Pre-built macOS and Windows binaries are not shipped. To use macOS or Windows, build the binary from the source code.

Build from Source

  1. Clone the repository:

    git clone https://github.com/nmdra/notebrain-cli.git
cd notebrain-cli

  2. Use Make to build the binary:

    make build

    Note: This command executes CGO_ENABLED=1 go build -o notebrain .

  3. Move the binary to a directory in your $PATH:

    sudo mv notebrain /usr/local/bin/

Configuration

NoteBrain uses a TOML file for persistent configuration. The default location is ~/.notebrain/config/config.toml.

  1. Create the configuration directory:

    mkdir -p ~/.notebrain/config

  2. Copy the template from the repository:

    cp config.example.toml ~/.notebrain/config/config.toml

  3. Edit ~/.notebrain/config/config.toml. Set your vault path, the database storage location, and the default format:

    vault-path = "/path/to/your/Obsidian Vault"
vault-name = "My Vault"
chroma-path = "~/.notebrain/chroma"
format = "text"

By default, NoteBrain stores the local ChromaDB database at ~/.notebrain/chroma. You can override any setting with command-line flags (for example, --chroma-path, --vault-path, --format).