CLI

Command-line interface reference.

Spectron ships two binaries:

BinaryRole
spectrondServer (runs in your container or cluster): api, worker, scheduler, management, bootstrap
spectronClient: remember, recall, chat, documents, provisioning helpers

The spectron CLI is what integrators install locally. spectrond is operated via Docker, Kubernetes, or your platform team; start with Docker.

Most spectron subcommands accept:

FlagEnvironment variableDescription
--url / -uSPECTRON_URLServer base URL (for example http://localhost:9090)
--api-key / -aSPECTRON_API_KEYContext API key
--context-id / -cSPECTRON_CONTEXT_IDContext id in /api/v1/{context_id}/...
spectron login --url http://localhost:9090 \
--api-key "$SPECTRON_API_KEY" \
--context-id dev

Stores a named profile for later commands.

Run inside the Spectron container or host image.

One-time control-plane initialisation. Prints management and context API keys.

docker compose exec spectron spectrond bootstrap \
--connection-string "ws://surrealdb:8000;root;root"
spectrond api start …          # REST + MCP
spectrond worker start … # job queue consumer
spectrond scheduler start … # periodic background work
spectrond management start … # management REST only

Common flags:

FlagEnvDefault
--connection-stringSURREALDB_CONNECTION
--embeddings-api-keySPECTRON_EMBEDDINGS_API_KEY
--bind-addressSPECTRON_BIND_ADDRESS0.0.0.0:9090
--object-store-urlSPECTRON_OBJECT_STORE_URL
CommandREST equivalent
spectron remember "…"POST /api/v1/{ctx}/facts
spectron recall "…"POST /api/v1/{ctx}/query
spectron context "…"POST /api/v1/{ctx}/context
spectron chat [message]POST /api/v1/{ctx}/chat
spectron reflect "…"POST /api/v1/{ctx}/reflect

remember flags: --infer full|triples|preview|none, --from-file, --transcript, --scope org=acme.

recall flags: --limit, --mode hybrid|vector|bm25|graph, --include facts,passages.

spectron documents upload ./manual.pdf
spectron documents list
spectron documents query "return policy"
spectron sessions list
spectron entities show Person/alice
spectron traces show <trace_id>
spectron mcp

Prints JSON for Claude Desktop / Cursor and a Claude Code one-liner.

spectron contexts create …
spectron keys generate-key …

Run spectron --help for the full command tree.

Was this page helpful?