Installation

Installation

Prerequisites

• No dependencies required for basic functionality
• Optional: OpenAI API key for semantic search

Installation Methods

Cargo (Recommended for Rust users)

cargo install bkmr

pip/pipx (Python package managers)

# Via pip
pip install bkmr

# Via pipx (isolated environment)
pipx install bkmr

# Via uv (fast Python package installer)
uv tool install bkmr

Homebrew (macOS/Linux)

brew install bkmr

From Source

# Clone the repository
git clone https://github.com/sysid/bkmr.git
cd bkmr

# Build release version
cargo build --release

# Binary will be at: target/release/bkmr

Initial Configuration

After installation:

# 1. Generate default configuration
bkmr --generate-config > ~/.config/bkmr/config.toml

# 2. Create database
bkmr create-db ~/.config/bkmr/bkmr.db

# 3. Set environment variable (optional, can also configure in config.toml)
export BKMR_DB_URL=~/.config/bkmr/bkmr.db

Add the environment variable to your shell profile (.bashrc, .zshrc, etc.) for persistence.

Verification

Verify installation:

# Check version
bkmr --version

# View help
bkmr --help

# Create test database
bkmr create-db /tmp/test.db

Upgrading

Automatic Migrations

When upgrading to a new version, bkmr will automatically:

1. Check if database migrations are needed
2. Create a timestamped backup of your current database
3. Apply necessary migrations

Backups are saved with date suffix (e.g., bkmr_backup_20250406.db).

Manual Upgrade

# Via cargo
cargo install bkmr --force

# Via pip
pip install --upgrade bkmr

# Via homebrew
brew upgrade bkmr

Troubleshooting Installation

For more issues, see Troubleshooting.

Next Steps

• Quick Start - Get productive in 5 minutes
• Configuration - Customize bkmr settings
• Basic Usage - Learn common commands