Run Loams locally
Start the engine on your own machine with loams dev, see which listeners it opens, and check that it is ready.
loams dev runs the whole engine in one process, with its bucket and metastore in a local directory (.loams/ by default). It is the fastest way to develop against Loams. To run the full stack (engine, TiKV, Loams SQL, Loams Postgres, the House) instead, follow Self-hosting over Tailscale.
Start it
loams devLeave it running and check readiness from another terminal:
curl -i http://127.0.0.1:8080/ready/ready returns 200 once the metastore has a leader; /health is process health. Both stay public whatever the auth mode.
What it listens on
Every listener binds to loopback. Move or turn off any of them with the flags below (loams dev --help lists them all).
| Surface | Default address | Flag |
|---|---|---|
| Native API (REST, Connect, gRPC, gRPC-Web) | 127.0.0.1:8080 | --listen |
| Arrow Flight SQL | 127.0.0.1:8082 | --flight-sql-listen, --no-flight-sql |
| Qdrant REST and gRPC | 127.0.0.1:6333, 127.0.0.1:6334 | --qdrant-listen, --qdrant-grpc-listen, --no-qdrant |
| Elasticsearch REST | 127.0.0.1:9200 | --es-listen, --no-es |
| Loams Live sync API | 127.0.0.1:7710 | Live is in the default build and keeps its data under .loams/live/ |
Resonate (with --features durable) | 127.0.0.1:8001 | --durable-listen, --no-durable |
Postgres wire (with --features pgwire) | off unless given | --pg-listen 127.0.0.1:5432 |
MySQL wire (with --features mysql-wire) | off unless given | --mysql-listen 127.0.0.1:3306 |
Authentication is off by default, which the engine allows only on loopback: with LOAMS_AUTH_MODE unset it refuses to start on a non-loopback address. See Authentication and API keys.
Other ways to run the engine
| Command | Use it for |
|---|---|
loams dev | One process, data in a local directory, everything on loopback |
loams standalone --bucket s3://bucket/prefix | One process backed by your object store |
loams cluster | Several nodes with roles, placement, read forwarding and write backpressure |
docker compose up -d in deploy/release | The whole 0.1.0 stack, reached over your Tailscale tailnet (guide) |
Reset
Stop with Ctrl+C. To start from an empty engine, delete the data directory (.loams/ by default) while it is stopped.
Install the CLI and Loams Desktop
Download the loams CLI or Loams Desktop for your platform, and verify it against the release checksums and the project's GPG key.
First collection and hybrid search
Create a collection over the native REST API, write documents with vectors, and run one query that fuses vector kNN, BM25 and a filter.