CAMEODB
Quickstart Guide

Get Started in 5 Minutes

Follow a focused, copy-paste friendly path to spin up CameoDB locally, connect with the CLI, load data, and run your first search.

1
download

Download the binary

macOS (Apple Silicon) download Binary
curl -sSO https://dl.cameodb.com/mac/cameodb
Linux (x86_64) download Binary
curl -sSO https://dl.cameodb.com/linux/cameodb
Windows (x64) download EXE
curl -sSO https://dl.cameodb.com/windows/cameodb.exe
2
settings

Make it executable

chmod +x ./cameodb mac linux

One-time change: enable execute permissions for the downloaded binary.

info Skip this step for the Windows .exe file. win
3
dns

Run the server

./cameodb mac linux

Runs in the foreground. Good for your first run. Creates a data directory at ./data/cameodb.

nohup ./cameodb & mac linux

Alternative: Run in the background (daemonized).

.\cameodb.exe win

Run in PowerShell. Creates a data directory at .\data\cameodb.

4
terminal

Connect with the CLI

Open a new terminal window and start the interactive client:

./cameodb client -i mac linux
You are now talking directly to your local cluster at localhost:9480.
.\cameodb.exe client --interactive win
Run in another shell. You are now connected to your CameoDB instance.
5
monitor_heart

Quick health + inventory

cameodb@localhost ▶ health

fetches cluster health info and pretty-prints the JSON

cameodb@localhost ▶ list indexes

enumerates indexes with document counts and mapped field names

6
database

Load sample data

Dataset: Books
cameodb@localhost ▶ data load books https://dl.cameodb.com/examples/data/booksummaries.tsv

Downloads and parses TSV, creates schema automatically, and batch-ingests documents. (Takes ~5 seconds).

7
search

Run your first query

Hybrid Search
cameodb@localhost ▶ search books title:(Harry Potter) limit 5

Swap in any title, keyword, or field filter to explore the dataset!

flag
auto_awesome

Next moves

  • arrow_right Check the Documentation for configuration & routing rules.
  • arrow_right Read the Product Info to see how the engine works.
  • arrow_right Grab SDKs from the Downloads page.

Keep building with CameoDB

Explore the docs, benchmark the engine locally, and ship your first production index.

library_books Full Documentation home Return Home