Skip to content
RememRemem Docs

remem-admin

remem-admin is the operator CLI shipped with Remem Community. It works on a data directory directly, so it can export portable backups, check consistency, and rebuild indexes without adding an HTTP endpoint to the server.

Before you run a command

Section titled “Before you run a command”

Pebble locks the data directory exclusively. Stop the Remem server before running remem-admin against its live directory. For read-only inspection while the server is running, use a backup checkpoint under .backups/pre-<unix>/. Commands that change data should run against a stopped server and its data directory.

Pass the directory used by your installation with --data-dir:

Terminal window
remem-admin version
remem-admin graph verify --data-dir ./data

Add --tenant <id> when operating on a specific tenant in a tenant-aware directory. A single-tenant Community build only serves its configured tenant.

Portable backups and migration

Section titled “Portable backups and migration”

Remem’s supported backup format is the portable snapshot. Do not copy Pebble’s database files as a backup.

Terminal window
remem-admin export --data-dir ./data --out ./remem.snapshot
remem-admin verify --data-dir ./restored-data --in ./remem.snapshot
remem-admin import --data-dir ./restored-data --in ./remem.snapshot

export can be scoped to a tenant with --tenant; --shared-only exports shared records. import supports conflict handling (fail, skip, or overwrite), vector handling (auto, re-embed, or verbatim), and --resume for continuing an interrupted import. When snapshot vectors were created by a different embedding model, the default auto mode recomputes them with the importing binary’s model. Run verify after import to compare the restored store with the snapshot; it exits with status 2 when they disagree.

Check and repair data

Section titled “Check and repair data”

The CLI can verify the relationship graph and rebuild derived indexes:

Terminal window
remem-admin graph verify --data-dir ./data
remem-admin vector rebuild --data-dir ./data
remem-admin text rebuild --data-dir ./data
remem-admin rebuild --data-dir ./data --index all

Use rebuild --index to choose an index: vector, text, attr, graph-in, passages, segments, projection, projection-attr, dependency, lineage, or all. The older vector and text rebuild commands remain available. discovery backfill queues relationship-discovery work for the server to process when it next starts:

Terminal window
remem-admin discovery backfill --data-dir ./data --per-job 100

Inspect and manage a directory

Section titled “Inspect and manage a directory”

inspect check reports malformed or inconsistent records, missing derived rows, and graph problems. It exits with status 2 when it finds issues. inspect spaces shows where stored key spaces use data, and inspect key decodes an individual hexadecimal key. These inspection commands do not print memory content.

Other available commands provide operator access to:

  • Tenants: inventory the tenants present before moving to a single-tenant build.
  • Users and tokens: create, list, rename, enable, or disable users; issue, list, and revoke their API tokens. Issued tokens are shown only once.
  • Vocabulary: list and inspect terms and claims, and verify vocabulary consistency.
  • Background work and budgets: list and verify queued work and per-tenant budgets.
  • Observations and beliefs: verify stored observations and belief data, inspect belief reliability and status, and explain a memory’s recorded belief.

Run remem-admin --help for the full command syntax supported by your installed release.