Getting Started

Quick Start

Initialize Promemo, save memory, inspect the tree, and load assistant context.

Quick Start

Run these commands from the root of a Git repository.

1. Initialize Promemo

promemo init

Promemo creates:

.promemo/
  project.md
  config.toml
  index.json
  features/
  shared/
    architecture.md
    coding-guidelines.md
    notes.md
  decisions/
  cache/

2. Save Your First Memory

Pipe a short handoff into Promemo:

cat <<'EOF' | promemo save authentication --stdin
# Authentication
- Refresh tokens rotate on every use.
EOF

Promemo writes generated Markdown under:

.promemo/features/authentication/

3. Inspect The Memory Tree

promemo tree

For JSON output:

promemo tree --json

4. Load Context For An Assistant

promemo load authentication

This prints prompt-ready context assembled from project memory, shared memory, feature memory, and feature notes.

5. Search Memory

promemo search "refresh token"

If no memory matches, Promemo prints a clear no-results message:

No memory found for "refresh token".

6. Open A Feature Folder

promemo open authentication

This opens the feature memory folder in your default file browser when available.

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

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