Skip to content

Use the CLI

The dimple command covers local work, scripts, and quick checks. Run dimple --help to see the commands and global options in your installed version.

Run dimple init in the directory where you want the database files:

Terminal window
dimple init

The command writes dimple.jsonc. Other commands read that file by default. To use another file, pass --config:

Terminal window
dimple query "deployment process" --config ./config/dimple.jsonc

To write a memory, pass its text and a key. If you omit --key, Dimple generates one.

Terminal window
dimple write "Deployments run after each push" --key deploy-trigger

To search, ask a natural-language question:

Terminal window
dimple query "What starts a deployment?" --limit 5

By default, the query combines vector search and keyword search. To use one search mode, pass --profile semantic or --profile keyword. To narrow the result set, pass --namespace or --content-type.

To read or delete a memory, pass its ID or logical key to get or forget:

Terminal window
dimple get deploy-trigger
dimple forget deploy-trigger

forget permanently deletes the memory, its graph edges, and its topic membership.

To print machine-readable results, add the global --json option:

Terminal window
dimple query "What starts a deployment?" --limit 5 --json