Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.crewship.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
crewship memory

Access memory FTS5 indexes on the local filesystem without a running server. Useful for development, debugging, and scripting.

​
Subcommands

FTS5 search across memory with scope control. 
crewship memory search <query> [flags]
Flags:
FlagShortDefaultDescription
--path-p(required)Base path (meaning depends on scope)
--scope-Sagentagent, crew, workspace, or all
--limit-l10Maximum results per scope
--format-FtableOutput format: table or json
Examples: 
# Search agent memory
crewship memory search "PostgreSQL" -p /path/to/agents/lead/.memory

# Search crew shared memory
crewship memory search "deployment" -p /path/to/crew-root -S crew

# Search both scopes, JSON output
crewship memory search "database" -p /path/to/agents/lead -S all -F json

# Search workspace memory
crewship memory search "budget" -p ~/.crewship/memory/ws-123 -S workspace

​
status

Show memory index statistics. 
crewship memory status [flags]
Example: 
crewship memory status -p /path/to/agents/lead/.memory
# [agent] /path/to/agents/lead/.memory
#   Files:   3
#   Chunks:  12
#   Size:    48 KB
#   Indexed: 2026-04-14T10:15:52Z
#   Ready:   true

​
health

Print the 5-metric memory health score for the caller’s workspace. Hits the running server (requires crewship login and a workspace context) — unlike search/status/reindex which read local FTS indexes, health calls GET /api/v1/memory/health, which recomputes fresh on every request from five aggregate SQL queries. The persisted memory_health_snapshots table is for trend graphs, not for this command. 
crewship memory health [--crew <slug-or-id>]
Flags:
FlagDescription
--crewScope to a single crew by slug or ID. Omit for workspace-aggregate.
The global --format flag is honoured (table, json, yaml). Example: 
crewship memory health
# Memory health (workspace-wide): 77/100
#
#   freshness        83.1
#   coverage         62.0
#   coherence        80.2
#   efficiency       77.4
#   reachability     78.0
The 77/100 is colour-coded — red below 50, yellow 50–74, green 75 and above. The colour is applied via terminal escape codes; in pipes (| cat or --format json) it disappears. See Episodic memory — health scoring for what each metric measures and the weighted-composite formula.

​
reindex

Rebuild FTS5 index from markdown files. Signal-aware (responds to SIGINT/SIGTERM). 
crewship memory reindex [flags]
Example: 
crewship memory reindex -p /path/to/crew-root -S crew
# [crew] reindexed 3 files (10 chunks) in 19ms
Returns non-zero exit code if all reindex operations fail.

​
Scope and Path Resolution

The meaning of --path depends on the selected scope:
Scope--path should point to
agentAgent .memory/ dir or agent dir (auto-appends .memory/)
crewCrew root dir (resolves to <path>/shared/.memory/)
workspaceWorkspace memory dir (e.g. ~/.crewship/memory/<workspace-id>)
allCrew root dir (searches agent + crew)