MemtraceDOCS

memtrace install / setup / uninstall

Upgrade Memtrace, pick stable or Nightly, complete deferred agent setup, or clean up Memtrace integrations before removing the npm package.

Channels#

Memtrace is one npm package with two tags. Stable is the default, and it still gets new work. Nightly is for new features as they land. Same command. It is not always stable. The full channel story is on Nightly vs stable.

terminal
$ npm install -g memtrace
# default: still gets new features

$ npm install -g memtrace@nightly
# new features as they land, not always stable

$ npm install -g memtrace@latest
# switch back to stable
UPGRADES STAY ON YOUR CHANNEL

memtrace install upgrades to the newest build on the channel you already have. A Nightly install only offers newer Nightlies. A stable install only offers newer stable releases.

Upgrade#

memtrace install|update|upgrade [--yes] [--project-only] [--no-hooks] [<command>...]

memtrace install upgrades the global npm package on the channel you already have. update and upgrade are aliases. If you add another command after it, Memtrace upgrades first and then runs that command.

terminal
$ memtrace install
# upgrade on your current channel

$ memtrace install start
# upgrade, then start Memtrace

$ memtrace install index .
# upgrade, then index the current repo
USE THIS FOR UPDATE BANNERS

When Memtrace prints an update-available banner, the recovery command is simplymemtrace install. You do not need to uninstall first.

Setup#

memtrace setup [--yes] [--project-only] [--no-hooks]

memtrace setup applies or repairs the agent integrations: skills, MCP server registration, and optional hooks. Use it after a global npm install if the installer deferred those changes until you explicitly approved them.

A plain npm install -g memtrace is conservative: it installs the binary, but it will not silently edit your agent configuration without a consent signal. To finish setup afterward, run:

terminal
$ memtrace setup --yes

Uninstall#

memtrace uninstall

Run memtrace uninstall before removing the npm package. It removes Memtrace-managed agent integrations and then reminds you to remove the package itself.

terminal
$ memtrace uninstall
$ npm uninstall -g memtrace
RUN CLEANUP FIRST

npm uninstall -g memtrace removes the package, but npm does not reliably run global cleanup hooks. memtrace uninstall is the reliable cleanup step for agent config, skills, and managed integration files.

Flags#

FlagDescription
--yes, -yApprove the planned integration changes without an interactive prompt.
--project-onlyApply setup to the current project instead of the user-level agent configuration where supported.
--no-hooksSkip agent hook registration while still installing skills and MCP config.

Environment#

VariableDefaultDescription
MEMTRACE_INSTALL_YESSame effect as --yes for non-interactive installs.
MEMTRACE_ASSUME_YESAlias for MEMTRACE_INSTALL_YES=1.
MEMTRACE_INSTALL_PROJECT_ONLYSame effect as --project-only.
MEMTRACE_INSTALL_NO_HOOKSSame effect as --no-hooks.
MEMTRACE_PURGE_DATASet to 1 during uninstall cleanup to also remove local Memtrace user data.
MEMTRACE_UNINSTALL_PURGE_DATAAlias for MEMTRACE_PURGE_DATA=1.

Examples#

terminal
$ npm install -g memtrace
# installs stable

$ npm install -g memtrace@nightly
# installs Nightly instead

$ memtrace setup --yes
# applies agent integrations after a deferred install

$ memtrace install start
# upgrades on your current channel, then starts the runtime

$ memtrace uninstall
$ npm uninstall -g memtrace
# cleans integrations, then removes the package