CLI Usage

The pgm CLI is the primary human-facing interface and supports the same actions as REST with concise output modes for automation.

What this page covers

Install and usage patterns for everyday local use and agent-friendly workflows.

Core workflow

1. Install:

npm install -g @ivotoby/postgram-cli

2. Configure once:

export PGM_API_URL=http://127.0.0.1:3100
export PGM_API_KEY=your-api-key

3. Store and retrieve entities:

pgm store "decided to use pgvector" --type=memory --tags decisions
pgm search "decided to use pgvector"
pgm recall <entity-id>
pgm update <id> --content "revised content" --version 1
pgm delete <id>

4. Task and sync operations:

pgm task add "fix retrieval false positives" --context @focus --status next
pgm sync ~/Documents/personal-notes --repo personal-notes
pgm link <source-id> <target-id> --relation involves
pgm expand <entity-id> --depth 2

For local development without build:

npx tsx cli/src/pgm.ts <command>

Notes

• Agent modes:
  • --json (compact structured JSON)
  • --json --full-response (REST-shaped payloads)
  • --toon (compact agent-readable text for list-like operations).
• task complete and search are commonly used in automation scripts; capture the returned version for update flows.