Skip to main content
/ Docs
Quickstart API SDKs

CLI: Spaces

Organize memories into isolated spaces and manage API keys with the Trix CLI.

Updated

Overview

Spaces provide isolated environments for organizing memories. Each space has its own set of memories, clusters, and relationships. The CLI makes it easy to create, switch between, and manage spaces.

Spaces

Organize memories into spaces. Alias: sp

# List all spaces (now shows SLUG column)
trix spaces list

# Output:
# SLUG              NAME              MEMORIES  DESCRIPTION                   CREATED
# research          Research          42        ML research notes and papers  2h ago
# work-project      Work Project      128       Daily work context            1d ago

# List with IDs (verbose mode)
trix spaces list --verbose

# Create with auto-generated slug
trix spaces create "My Research Project"
# ✓ Space created: my-research-project

# Create with custom slug
trix spaces create "Work Projects" --slug work
# ✓ Space created: work

# Create with description
trix spaces create "Personal" --description "Personal memories and notes"

# Get space by slug
trix spaces get research

# Get space by name (also works)
trix spaces get "My Research Project"

# Set default space
trix spaces default research

# Show current default
trix spaces default

# Delete a space
trix spaces delete research

Deleting a space will also delete all memories within it. Use with caution.

Slugs provide human-readable identifiers for spaces. Use --slug to create short, memorable names like work, dev, or research instead of UUIDs.

Update Command

Update existing space properties using the update command:

# Update space name
trix spaces update research --name "ML Research"

# Update space slug (old slug still works via redirect)
trix spaces update research --slug ml-research

# Update description
trix spaces update ml-research --description "Machine learning experiments"

# Update multiple fields
trix spaces update work --name "Work Context" --slug work-ctx --description "Daily work"

spaces Options

CommandDescription
listList all spaces with memory counts
create <name>Create a new space
get <slug-or-id>Show space details
update <slug-or-id>Update space name, slug, or description
default [slug-or-id]Get or set the default space
delete <slug-or-id>Delete a space and all its memories

create Options

OptionDescription
--slug, -sCustom URL-safe slug (auto-generated if not provided)
--description, -dDescription for the space

Working with Spaces

Most commands accept a --space flag to target a specific space. You can use slugs, names, or IDs:

# Use space by slug (recommended - easier to remember)
trix remember "Project meeting notes" --space work
trix recall "meeting notes" --space research

# Slugs are auto-generated from names
trix spaces create "My Cool Project"
# Creates slug: my-cool-project

# Custom slugs for short references
trix spaces create "Development Environment" --slug dev
trix remember "Note" --space dev

# Use space by name (also works)
trix remember "Project meeting notes" --space "Work Projects"
trix memories list --space "Personal Notes"

# Use space by ID (traditional method)
trix remember "Note" --space space_abc123def456

# All methods work interchangeably
trix recall "query" --space dev           # By slug
trix recall "query" --space "My Project"  # By name
trix recall "query" --space space_xyz789  # By ID

# Set a default space for all commands
trix spaces default work

# Override the default with --space
trix recall "notes" --space personal

Slugs provide the best of both worlds: human-readable like names, but URL-safe and easy to type. Use short slugs like work, dev, or research for frequently used spaces.

Using Environment Variables

Set a default space using environment variables:

# Set default space for the session
export TRIX_DEFAULT_SPACE=space_abc123

# Now all commands use this space by default
trix remember "Note"
trix recall "query"

# Override with --space flag when needed
trix recall "other query" --space different_space

API Keys

Manage API keys for programmatic access. Aliases: key, ak

API key management requires email/password authentication (not API key auth).

# List all API keys
trix keys list

# Create a new key
trix keys create --name "Production Server"

# Create with options
trix keys create --name "Admin Key" --admin
trix keys create --name "Temp Key" --expires 30d
trix keys create --name "Dev" --description "Development environment"

# Update key
trix keys update key_abc123 --description "Updated description"
trix keys update key_abc123 --enable
trix keys update key_abc123 --disable
trix keys update key_abc123 --admin
trix keys update key_abc123 --no-admin

# Delete (revoke) a key
trix keys delete key_abc123
trix keys delete key_abc123 --yes  # Skip confirmation

keys Options

OptionDescription
--nameName for the API key
--descriptionDescription of the key's purpose
--adminCreate an admin key with full permissions
--expiresSet expiration (e.g., 30d, 90d)
--enable / --disableEnable or disable a key

Background Jobs

Monitor and manage background processing jobs. Aliases: job, j

# List recent jobs
trix jobs list

# List with filters
trix jobs list --queue embedding
trix jobs list --status failed
trix jobs list --limit 50

# Get job details
trix jobs get embedding job_abc123

# View queue statistics
trix jobs stats

# Retry a failed job
trix jobs retry embedding job_abc123

# jq filtering
trix jobs list --jq '[.[] | select(.status == "failed")]'

Job Statuses

StatusDescription
waitingJob is queued and waiting to be processed
activeJob is currently being processed
completedJob finished successfully
failedJob failed (can be retried)

Billing & Subscription

Manage your subscription and view usage:

# View subscription status
trix billing status

# View credit balance with progress bar
trix billing credits
trix billing credits --compact        # Single line
trix billing credits --no-breakdown   # Hide action breakdown

# View usage statistics
trix billing usage
trix billing usage --history 6        # Show 6 periods of history

# List available plans
trix billing plans

# View transaction history
trix billing transactions
trix billing transactions --limit 50
trix billing transactions --type credit
trix billing transactions --action embedding

# Upgrade subscription
trix billing upgrade --plan pro
trix billing upgrade --plan max --period yearly

# Open billing portal
trix billing portal

# Cancel subscription
trix billing cancel
trix billing cancel --reason "switching to competitor"
trix billing cancel --immediately     # Cancel now (not at period end)

Next Steps