Skip to main content

CLI

The Novyx CLI is included with the Python SDK. It includes commands for memory context, rollback, audit, eval, and related support workflows.

Installation

pip install novyx

Setup

export NOVYX_API_KEY="nram_..."

Or pass --api-key to any command.

Commands

Memories

# Store a memory
novyx memories add "User prefers dark mode" --tags preferences,ui --importance 7

# List memories
novyx memories list --limit 20 --tags preferences

# Search semantically
novyx memories search "user preferences" --limit 5 --min-score 0.5

# Count memories
novyx memories count

# Delete a memory
novyx memories delete <memory-id> --yes

Rollback

# Preview what would change
novyx rollback preview "2 hours ago"

# Execute rollback
novyx rollback "2 hours ago" --yes

Audit

# View audit trail
novyx audit list --limit 20

# Verify hash chain integrity
novyx audit verify

# Export audit log
novyx audit export --format csv > audit.csv

Context Spaces

# Create a space
novyx spaces create "project-alpha" --description "Alpha project memories"

# List spaces
novyx spaces list

# List memories in a space
novyx spaces memories <space-id>

Stats & Health

# Memory statistics
novyx stats

# Dashboard (tier, usage, pressure)
novyx dashboard

Eval (experimental)

# Run memory-health evaluation when experimental features are enabled
novyx eval run

# Threshold check; disabled by default unless experimental features are enabled
novyx eval gate --min-score 70

Output Formats

All list/search commands support --format table (default) and --format json:

novyx memories list --format json | jq '.memories[0]'

Environment Variables

VariableDescription
NOVYX_API_KEYYour API key
NOVYX_BASE_URLOverride API base URL