Quickstart · under 5 minutes

Get Started with CameoDB

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 the binary

curl -sSO https://dl.cameodb.com/mac/cameodb
Download macOS
SHA256 (cameodb)
e57b1f7fe5b9bb3e64bf84af2659d8fc027d67e8fbda516ccc5c875c80bba757
curl -sSO https://dl.cameodb.com/linux/cameodb
Download Linux
SHA256 (cameodb)
76a244527b2744a3ac331cef6e9f8358de38e709ab1c9ca1eec19af132fd1ae0
curl -sSO https://dl.cameodb.com/windows/cameodb.exe
Download Windows
SHA256 (cameodb.exe) - accept security warning - verify integrity
f685ec2ab34fabaf2a0ef08534972046cb8b7a95413b827370371f87a4de3dcc
2

Make it executable

chmod +x ./cameodb mac linux
one-time change: enable execute for cameodb
skip this for windows executable win
3

Run the server

./cameodb mac linux
Foreground, good for first run
Creates data directory at ./data/cameodb by default
nohup ./cameodb & mac linux
Background (screen/tmux friendly) or run in a separate terminal
.\cameodb.exe win
in powershell run command
Creates data directory at .\data\cameodb by default
4

Connect with the CLI

./cameodb client -i mac linux
You're now talking to your local CameoDB at localhost
.\cameodb.exe client --interactive win
in another shell run client
Now you are connected to your CameoDB
5

Quick health + inventory

CameoDB
cameodb@localhost ▶ health
fetch health info and pretty-print
cameodb@localhost ▶ list indexes
enumerate indexes with stats and field names
6

Load sample data

Books
data load books https://dl.cameodb.com/examples/data/booksummaries.tsv
Creates the books index automatically, few sec to get data ...
cameodb@localhost ▶ list indexes
Verify indexes after data load
7

Run your first query

Books
search books title:(Harry Potter) limit 5
Swap in any title or field filter to explore
8

Next moves

Keep building with CameoDB

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