CLI overview
The supported Memtrace command surface for installing, running, configuring, and troubleshooting the local workspace runtime.
memtrace is the command users install from npm. Running it with no arguments starts the local workspace runtime, the same as memtrace start. The commands below are the public workflows the docs support.
Commands#
| Command | What it does | Reference |
|---|---|---|
memtrace start | Start the workspace runtime: index repos, watch files, serve the local API, and open the dashboard. | cli/start |
memtrace stop | Stop the running workspace runtime. | cli/stop |
memtrace status | Show runtime, index, embedding, auth, and daemon health. Supports --json. | cli/status |
memtrace mcp | Run the MCP server your coding agent connects to. | cli/mcp |
memtrace index [PATH] | Index one repository or workspace. PATH defaults to the current directory. | cli/index |
memtrace reset [repoId] | Clear local Memtrace data. With repoId, clear only that repository from the local graph. | cli/reset |
memtrace workspace | Inspect folder groups and manage named workspaces. | cli/workspace |
memtrace embed | Choose and test embedding providers and models. | cli/embed |
memtrace warmup | Download and initialize the active embedding model before a cold start. | cli/warmup |
memtrace gpu | Manage the optional CUDA provider on Windows NVIDIA hosts. | cli/gpu |
memtrace auth | Sign in or out of the local Memtrace license session. | cli/auth |
memtrace connect | Connect a workstation to a team self-hosted MemDB deployment. | cli/connect |
memtrace access | Administer self-hosted MemDB users: list, add, rotate, and revoke credentials live. | cli/access |
memtrace code-review | Review a GitHub pull request with local Memtrace context. | cli/code-review |
memtrace pr | Check and sync PR watches created by code review. | cli/pr |
memtrace govern | Register or review governance documents that should guide future code changes. | cli/govern |
memtrace insight-card [repoId] | Print a compact codebase summary for one repo or every indexed repo. | cli/insight-card |
memtrace install-hooks | Install Memtrace-managed git hook blocks. Pre-push is the default; pre-commit is opt-in. | cli/hooks |
memtrace uninstall-hooks | Remove Memtrace-managed git hook blocks while preserving your own hook content. | cli/hooks |
memtrace doctor | Diagnose stale runtime state, occupied ports, and install issues. | cli/doctor |
memtrace install | Upgrade Memtrace and optionally run another command afterward. Also covers setup and uninstall cleanup. | cli/install |
Global flags#
| Flag | Description |
|---|---|
--clear / --fresh | Clear the local index before start or index. |
--headless | Keep the local API running but skip browser auto-open on start. |
--force / --replace | Replace an existing runtime owner instead of attaching to it. |
--debug | Enable verbose troubleshooting logs for this run. |
--ui | On memtrace mcp, also start the browser-facing dashboard/API listener. |
--workspace <PATH|NAME> | Target a folder group or named workspace instead of the current directory. |
--no-workspace | Opt out of automatic folder-group workspace detection for this invocation. |
--bless-workspace | Pre-approve folder-group sharing when starting from a parent directory of repos. |
Help & version#
memtrace help, memtrace --help, and memtrace -h print the main help screen.memtrace version, memtrace --version, and memtrace -v print the installed version.
terminal
$ memtrace start --help $ memtrace embed --help $ memtrace --version