@mixedbread/cli

@mixedbread/cli

CLI tool for managing Mixedbread stores and files.

Installation

npm install -g @mixedbread/cli

Quick Start

# Add and set your API key
mxbai config keys add mxb_xxxxx work

# Or use environment variable
export MXBAI_API_KEY=mxb_xxxxx

# Install shell completion for better experience (optional but recommended)
mxbai completion install

## Check available commands and their options
mxbai --help

# List stores
mxbai store list

# Create a new store
mxbai store create "My Documents"

# Create a public store with contextualization enabled
mxbai store create "Public Docs" --public --contextualization

# Create a store with contextualization for specific metadata fields
mxbai store create "My Docs" --contextualization="title,author"

# Update a store to make it private
mxbai store update "My Docs" --public=false

# Upload files
mxbai store upload "My Documents" "*.md" "docs/**/*.pdf"

# Upload with high-quality processing
mxbai store upload "My Documents" "**/*.md" --strategy high_quality

# Search content
mxbai store search "My Documents" "how to get started"

# Sync files with change detection
mxbai store sync "My Documents" "docs/**" --from-git HEAD~1

# Sync with processing options
mxbai store sync "My Documents" "**/*.md" --parallel 8

# Upload with manifest file (JSON or YAML)
mxbai store upload "My Documents" --manifest upload-manifest.json
mxbai store upload "My Documents" --manifest upload-manifest.yaml

Commands

Store Management

• mxbai store list - List all stores
  • Options: --filter <name>, --limit <n>
• mxbai store create <name> - Create a new store
  • Options: --description <desc>, --public[=value], --contextualization[=fields], --expires-after <days>, --metadata <json>
• mxbai store get <name-or-id> - Get store details
• mxbai store update <name-or-id> - Update store
  • Options: --name <name>, --description <desc>, --public[=value], --expires-after <days>, --metadata <json>
• mxbai store delete <name-or-id> - Delete store (alias: rm)
  • Options: --yes/-y (skip confirmation)

Store Options

--public[=value] - Make store publicly accessible. The requestor pays for the usage, not the store owner.

--contextualization[=fields] - Enable contextualization for improved search relevance. Can be used in two ways:

• --contextualization - Enable with all available metadata fields
• --contextualization="title,author" - Enable with specific metadata fields (comma-separated)

File Management

• mxbai store upload <name-or-id> <patterns...> - Upload files to store
  • Options: --strategy fast|high_quality, --metadata <json>, --dry-run, --parallel <n> (1-200), --unique, --manifest <file>
• mxbai store files list <name-or-id> - List files in store (alias: ls)
  • Options: --status <status> (pending|in_progress|cancelled|completed|failed), --limit <n>
• mxbai store files get <name-or-id> <file-id> - Get file details
• mxbai store files delete <name-or-id> <file-id> - Delete file (alias: rm)
  • Options: --yes/-y (skip confirmation)

Search & Query

• mxbai store search <name-or-id> <query> - Search store
  • Options: --top-k <n>, --threshold <score>, --return-metadata, --rerank, --file-search
• mxbai store qa <name-or-id> <question> - Ask questions about content
  • Options: --top-k <n>, --threshold <score>, --return-metadata

Advanced Features

• mxbai store sync <name-or-id> <patterns...> - Sync files with intelligent change detection
  • Options: --strategy <strategy>, --from-git <ref>, --dry-run, --yes/-y, --force/-f, --metadata <json>, --parallel <n> (1-200)

Configuration

• mxbai config set <key> <value> - Set configuration values
• mxbai config get [key] - Get configuration values
• mxbai config keys add <key> [name] - Add a new API key
• mxbai config keys list - List all API keys
• mxbai config keys remove <name> - Remove an API key
  • Options: --yes/-y (skip confirmation)
• mxbai config keys set-default <name> - Set the default API key
• mxbai completion install - Install shell completion
  • Options: --shell <shell> (manually specify shell: bash, zsh, fish, pwsh)
• mxbai completion uninstall - Uninstall shell completion
• mxbai completion refresh - Refresh completion cache for store names

Features

Manifest-Based Upload

You can upload files using a manifest file (JSON or YAML) that defines file patterns, processing strategies, and metadata:

JSON Example:

{
  "version": "1.0",
  "defaults": {
    "strategy": "fast",
    "metadata": {
      "project": "my-project"
    }
  },
  "files": [
    {
      "path": "docs/**/*.md",
      "metadata": {
        "category": "documentation"
      }
    },
    {
      "path": "README.md",
      "strategy": "high_quality",
      "metadata": {
        "importance": "high"
      }
    }
  ]
}

YAML Example:

version: "1.0"

defaults:
  strategy: fast
  metadata:
    project: my-project

files:
  - path: "docs/**/*.md"
    metadata:
      category: documentation
  - path: README.md
    strategy: high_quality
    metadata:
      importance: high

Configuration Precedence

When using the CLI, configuration values are resolved in the following order (highest to lowest priority):

• Command-line flags - Direct CLI options (e.g., --strategy high_quality)
• Environment variables - System environment settings (e.g., MXBAI_API_KEY, MXBAI_BASE_URL, MXBAI_CONFIG_PATH, MXBAI_DEBUG)
• Manifest entry - File-specific settings in manifest files
• Manifest defaults - Default settings in manifest files
• Config file - User configuration file settings
• Built-in defaults - CLI default values

This allows flexible configuration while maintaining predictable behavior.

Upload Summary Information

The upload and sync commands display strategy information in their summaries:

Normal uploads show configuration in the summary:

✓ 5 files uploaded successfully
Strategy: fast
Total size: 25.3 KB

Manifest uploads show configuration beside each file:

✓ docs/api.md (15.2 KB) [fast]
✓ README.md (8.5 KB) [high_quality]
✓ guide.md (1.6 KB) [fast]

Intelligent Sync

The sync command provides intelligent change detection and robust error handling with full support for processing strategies:

Change Detection Methods:

• Git-based (fastest): Uses git diff to detect changes since a specific commit
• Hash-based (accurate): Compares file hashes with stored metadata

Processing Options:

• Strategy: Choose between fast (default) or high_quality processing
• Parallel processing: Control concurrency for optimal performance

Example Usage:

# Sync with git-based detection (fastest)
mxbai store sync "My Docs" "docs/**" --from-git HEAD~1

# Sync with hash-based detection and custom parallel processing
mxbai store sync "My Docs" "**/*.md" --parallel 10

# Sync with high-quality processing
mxbai store sync "My Docs" "**/*.md" --strategy high_quality

# Dry run to preview changes
mxbai store sync "My Docs" "src/**" --dry-run

# Force re-upload all files without confirmation 
mxbai store sync "My Docs" "**/*.pdf" --yes --force

# Same as above using short flags
mxbai store sync "My Docs" "**/*.pdf" -y -f

Configuration Management

Set defaults for common options:

# Upload defaults (apply to both upload and sync commands)
mxbai config set defaults.upload.strategy high_quality  # or 'fast' (default: fast)
mxbai config set defaults.upload.parallel 10             # Concurrent operations (1-200, default: 100)

# Search defaults
mxbai config set defaults.search.top_k 20                # Number of results (default: 10)
mxbai config set defaults.search.rerank true             # Enable reranking (default: false)

# API key management (alternative to environment variable)
# Add API keys with names for easy switching
mxbai config keys add mxb_xxxxx work
mxbai config keys add mxb_xxxxx personal

# List all API keys
mxbai config keys list
# Output:
#   work
# * personal (default)

# Set default API key
mxbai config keys set-default work

# Remove an API key
mxbai config keys remove personal

# Remove an API key without confirmation
mxbai config keys remove personal --yes

# Create aliases for frequently used stores
mxbai config set aliases.docs "My Documentation"
mxbai config set aliases.kb "Knowledge Base"

# Then use aliases instead of full names
mxbai store upload docs "*.md"              # Instead of: mxbai store upload "My Documentation" "*.md"
mxbai store search kb "how to get started"  # Instead of: mxbai store search "Knowledge Base" "how to get started"

# View all configuration
mxbai config get

# View specific configuration
mxbai config get defaults.upload

Authentication

The CLI looks for your API key in this order:

• --api-key or --saved-key command line flags
• MXBAI_API_KEY environment variable
• Default API key from config file (platform-specific location):
  • Linux/Unix: ~/.config/mixedbread/config.json (or $XDG_CONFIG_HOME/mixedbread/config.json)
  • macOS: ~/Library/Application Support/mixedbread/config.json
  • Windows: %APPDATA%\mixedbread\config.json
  • Custom: Set MXBAI_CONFIG_PATH environment variable to override

Multi-Organization Support

The CLI supports multiple API keys for different organizations or environments:

# Add API keys with descriptive names
mxbai config keys add mxb_xxxxx work
mxbai config keys add mxb_xxxxx personal

# Use a specific saved API key for a command
mxbai store upload "My Docs" "*.md" --saved-key work
mxbai store search "Knowledge Base" "query" --saved-key personal

# Or use an actual API key directly
mxbai store upload "My Docs" "*.md" --api-key mxb_xxxxx

# The last added key becomes default automatically
# Or explicitly set a default
mxbai config keys set-default personal

Shell Completion

The CLI supports intelligent tab completion for commands, subcommands, and store names.

Installation

# Install completion (auto-detects your shell)
mxbai completion install

# Install completion for a specific shell
mxbai completion install --shell bash
mxbai completion install --shell zsh
mxbai completion install --shell fish
mxbai completion install --shell pwsh

# Remove completion
mxbai completion uninstall

Supported shells: bash, zsh, fish, pwsh (PowerShell)

After installation, restart your shell or reload your shell configuration:

• bash: source ~/.bashrc or restart terminal
• zsh: source ~/.zshrc or restart terminal
• fish: Completion is ready to use (fish auto-loads completions)
• pwsh: . $PROFILE or restart terminal

Dynamic Store Name Completion

The CLI provides intelligent tab completion for store names in commands:

# Tab completion shows your store names
mxbai store get [TAB]           # Shows: store1 store2 my-docs ...
mxbai store delete [TAB]        # Shows: store1 store2 my-docs ...
mxbai store sync [TAB]          # Shows: store1 store2 my-docs ...
mxbai store upload [TAB]        # Shows: store1 store2 my-docs ...

# Also works with files subcommands
mxbai store files list [TAB]    # Shows: store1 store2 my-docs ...

How it works:

• Store names are cached locally for instant completion (no API latency)
• Cache updates automatically when you create, update, delete, or list stores
• Supports multiple API keys - completions show stores for your current default key
• Manual refresh available: mxbai completion refresh

Cache management:

• Caches up to 50 most recent store names per API key
• Cache location follows your config directory:
  • Linux/Unix: ~/.config/mixedbread/completion-cache.json
  • macOS: ~/Library/Application Support/mixedbread/completion-cache.json
  • Windows: %APPDATA%\mixedbread\completion-cache.json

Global Options

All commands support these global options:

• --api-key <key> - Actual API key for authentication
• --saved-key <name> - Name of saved API key from config
• --format <format> - Output format: table, json, or csv (default: table)
• --debug - Enable debug output (can also set MXBAI_DEBUG=true)

Development

This CLI is built on top of the @mixedbread/sdk and provides a convenient command-line interface for common operations.

Development Quick Start

Prerequisites

• Node.js 20+
• A package manager
• Git

Setup

• Clone the repository:

  git clone https://github.com/mixedbread-ai/openbread.git
  cd openbread/packages/cli
  

• Install dependencies:

  pnpm install
  

• Set up your API key:

  export MXBAI_API_KEY=mxb_xxxxx
  # Or add to config file
  cd packages/cli && pnpm build && pnpm mxbai config keys add mxb_xxxxx dev
  

Development Workflow

• Start development mode (auto-rebuild on changes):

  cd packages/cli && pnpm dev
  

• Test your changes (in another terminal):

  Option A: Quick testing (no tab completion)

  pnpm mxbai store --help
  pnpm mxbai store list
  

  Option B: Full CLI experience with tab completion

  # First, uninstall any global version to avoid conflicts
  npm uninstall -g @mixedbread/cli
  
  # Link your local build
  cd packages/cli && npm link
  
  # Now test with full CLI features
  mxbai store --help
  mxbai [TAB]  # Tab completion works!
  
  # To unlink when done
  npm unlink -g @mixedbread/cli
  

• Run tests:

  # Run all tests
  pnpm test
  
  # Run specific test file
  pnpm test tests/commands/store/upload.test.ts
  
  # Run tests in watch mode
  pnpm test --watch
  

• Lint and format:

  pnpm lint          # Check for issues
  pnpm lint --fix    # Auto-fix issues
  pnpm format        # Format code
  

Project Structure

src/
├── bin/mxbai.ts              # CLI entry point
├── commands/                 # All CLI commands
│   ├── config/              # Configuration commands
│   │   ├── get.ts          # Get config values
│   │   ├── set.ts          # Set config values
│   │   └── index.ts
│   └── store/        # Store commands
│       ├── files/           # File management subcommands
│       │   ├── delete.ts
│       │   ├── get.ts
│       │   ├── list.ts
│       │   └── index.ts
│       ├── create.ts        # Create store
│       ├── delete.ts        # Delete store
│       ├── get.ts           # Get store details
│       ├── list.ts          # List stores
│       ├── qa.ts            # Q&A functionality
│       ├── search.ts        # Search functionality
│       ├── sync.ts          # Sync files
│       ├── update.ts        # Update store
│       ├── upload.ts        # Upload files
│       └── index.ts
├── utils/                   # Shared utilities
│   ├── client.ts           # API client setup
│   ├── completion-cache.ts # Shell completion cache management
│   ├── config.ts           # Configuration management
│   ├── git.ts              # Git integration utilities
│   ├── global-options.ts   # Common CLI options
│   ├── hash.ts             # File hashing utilities
│   ├── manifest.ts         # Manifest file handling
│   ├── metadata.ts         # Metadata validation
│   ├── output.ts           # Output formatting
│   ├── sync-state.ts       # Sync state management
│   ├── sync.ts             # Sync logic
│   ├── upload.ts           # Upload utilities
│   └── store.ts     # Store helpers
└── index.ts                # Package exports

tests/
├── commands/               # Command tests
├── utils/                 # Utility tests
└── __mocks__/             # Jest mocks

Adding New Commands

• Create command file in src/commands/store/:

  // src/commands/store/my-command.ts
  import { Command } from 'commander';
  import { addGlobalOptions } from '../../utils/global-options';
  
  export function createMyCommand(): Command {
    return addGlobalOptions(
      new Command('my-command')
        .description('My new command')
        .argument('<arg>', 'Required argument')
        .option('--flag', 'Optional flag'),
    ).action(async (arg, options) => {
      // Implementation
    });
  }
  

• Register command in src/commands/store/index.ts:

  import { createMyCommand } from './my-command';
  
  // Add to storeCommand
  storeCommand.addCommand(createMyCommand());
  

• Add tests in tests/commands/store/my-command.test.ts:

  import { createMyCommand } from '../../../src/commands/store/my-command';
  
  describe('My Command', () => {
    it('should work correctly', async () => {
      // Test implementation
    });
  });
  

Debugging

• Use --debug flag for verbose output: pnpm mxbai --debug store list
• Set MXBAI_DEBUG=true environment variable for debug output
• Debug output includes command hierarchy options and merged options
• Tests include detailed error messages and mock setups