CLI Reference

The synapse command-line tool allows you to manage your local infrastructure, perform diagnostics, and manually interact with the memory and knowledge graph pillars.

Core Commands

synapse setup

Initializes a new Synapse workspace. It creates the necessary database folders, downloads native extensions, and prepares the environment for AI integration.

synapse doctor

Runs a comprehensive health check on your environment. It verifies Node.js version, native SQLite extensions, file system permissions, and network connectivity for model downloads.

synapse upgrade

Checks for and installs the latest version of Synapse. It also migrates your configuration and database schema if necessary.

synapse onboard

A guided, interactive walkthrough for new users to help them configure their first workspace and connect their AI client.

synapse dashboard

Starts a local web-based dashboard (if enabled) to visually explore your persistent memory and knowledge graph.

Pillar Commands

synapse memory <verb>

Manually interact with the memory pillar.

• add <content>: Store a new fact.
• search <query>: Search for memories.
• list: List all stored memories.
• delete <id>: Remove a memory.

synapse kg <verb>

Manually interact with the knowledge graph.

• add <subj> <pred> <obj>: Record a triple.
• query <entity>: Show relationships for an entity.
• timeline <entity>: Show historical changes for an entity.
• stats: Show graph density and coverage.

Utility Commands

synapse selftest

Runs an end-to-end validation suite, testing indexing, retrieval, and memory storage to ensure the system is working perfectly.

synapse version

Prints the current version of the Synapse server.

Global Flags

These flags can be appended to almost any command:

Next: Learn about the Configuration Options.