Neotoma

Command-line interface (CLI)

Use the CLI when MCP is not available. Run neotoma with no arguments for an interactive REPL (neotoma> prompt).

Data commands (store, entities, relationships, etc.) are offline-first and run via in-process local transport by default. Use --api-only to require the API, or --offline to force local explicitly.

Typical deterministic workflow

# Initialize
neotoma init

# Store one task
neotoma store --json='[{"entity_type":"task","title":"Review API rollout","status":"open"}]'

# Retrieve tasks
neotoma entities list --type task --limit 10

# Inspect provenance for one entity
neotoma observations list --entity-id <entity_id>

Transport flags

  • --offline: force in-process local transport
  • --api-only: fail if API server is unavailable
  • --base-url: target a specific API instance
  • --env dev|prod: required for server lifecycle commands
CommandDescriptionFlags
auth loginGet or authenticate the current user.
auth statusGet or authenticate the current user.
auth whoamiGet or authenticate the current user.
request (OAuth ops)Get or authenticate the current user.
entities listQuery entities with filters.--type, --limit, --offset, --search
entities getGet an entity by ID.<entity_id>
request --operation getEntitySnapshotGet an entity snapshot with provenance.--entity-id, --at?
request (getEntityObservationsList observations for an entity or get field provenance.--entity-id (or body)
listObservationsForEntityList observations for an entity or get field provenance.
getFieldProvenance)List observations for an entity or get field provenance.
relationships listList relationships for an entity.--entity-id
entities searchSearch for an entity by identifier or semantic.--query, --type
entities relatedRetrieve related entities or the graph neighborhood.--entity-id
entities neighborhoodRetrieve related entities or the graph neighborhood.--entity-id
request --operation mergeEntitiesMerge two entities.--source-id, --target-id
entities deleteDelete or restore an entity.<entity_id>
entities restoreDelete or restore an entity.<entity_id>
sources listList sources or get a source by ID.
request --operation getSourceByIdList sources or get a source by ID.
request (listObservations)List, query, or create observations.
observations listList, query, or create observations.
relationships listList relationships, get one by ID, or get a snapshot.
request (getRelationshipById)List relationships, get one by ID, or get a snapshot.
relationships get-snapshotList relationships, get one by ID, or get a snapshot.
request (createRelationship)Create, delete, or restore a relationship.--source-id, --target-id, --type
relationships deleteCreate, delete, or restore a relationship.--relationship-key
relationships restoreCreate, delete, or restore a relationship.--relationship-key
timeline listList timeline events or get one by ID.
timeline getList timeline events or get one by ID.<id>
schemas listList schema types or get a schema by entity type.
schemas getList schema types or get a schema by entity type.<entity_type>
schemas analyze-candidatesAnalyze schema candidates, get recommendations, update incrementally, or register a schema.--entity-type
schemas recommendationsAnalyze schema candidates, get recommendations, update incrementally, or register a schema.--entity-type
schemas update-incrementalAnalyze schema candidates, get recommendations, update incrementally, or register a schema.--entity-type
schemas registerAnalyze schema candidates, get recommendations, update incrementally, or register a schema.
storeStore structured entities.--json
upload <path>Store an unstructured file.<path>, --no-interpret?, --mime-type?
corrections createSubmit a correction or reinterpret a source.
interpretations reinterpretSubmit a correction or reinterpret a source.<source_id>
request --operation listInterpretationsList interpretations.
statsGet server stats, server info, or run health check snapshots.
snapshots checkGet server stats, server info, or run health check snapshots.
request --operation getFileUrlGet a signed file URL (internal).

See MCP reference for agent-native transport and troubleshooting for common failure modes.