Getting Started

Installation

Install Promemo with npm, npx, Homebrew, Cargo, a direct binary installer, or a local checkout.

Installation

Install Promemo with npm, the package runner, Homebrew, a direct binary installer, Cargo, or a local checkout.

Install Globally With npm

npm install -g promemo@latest
promemo --version

Run With npx

Run the latest published package without a global install:

npx -y promemo@latest --version
npx -y promemo@latest init

Install With Homebrew

brew tap seguelabs/tap
brew install promemo
promemo --version

Direct Binary Install

Install the latest GitHub Release binary directly:

curl -fsSL https://raw.githubusercontent.com/seguelabs/promemo/main/scripts/install.sh | sh

The installer detects your platform, downloads the matching release archive, verifies checksums, and installs Promemo to ~/.local/bin by default.

Install a specific version:

curl -fsSL https://raw.githubusercontent.com/seguelabs/promemo/main/scripts/install.sh | PROMEMO_VERSION=v0.4.0 sh

Install to a custom directory:

curl -fsSL https://raw.githubusercontent.com/seguelabs/promemo/main/scripts/install.sh | PROMEMO_INSTALL_DIR=/usr/local/bin sh

Install From A Release Tag

cargo install --git https://github.com/seguelabs/promemo.git --tag v0.4.0 --force

Install From A Local Checkout

git clone https://github.com/seguelabs/promemo.git
cd promemo
cargo install --path .

Distribution Status

Promemo v0.4.0 is available through npm, Homebrew, GitHub Releases, the direct binary install script, and Cargo from a Git tag.

GitHub Release binaries are available for macOS arm64, Linux x64, and Windows x64.

During development, you can also run commands with:

cargo run -- <command>

For example:

cargo run -- init

Generated CLI Docs

Promemo can generate its own CLI reference from the installed binary:

promemo docs

Save it:

promemo docs > docs/cli.md

Shell Completions

Generate shell completions:

promemo completions zsh
promemo completions bash
promemo completions fish
promemo completions powershell

Example for zsh:

promemo completions zsh > _promemo

A local-first memory layer for AI-assisted projects.

© 2026 Promemo
Local-first project memory for AI-assisted development.