Skip to main content

CLI Reference

All commands are available as metawarc <command>. Use metawarc <command> --help for the live flag list of the installed version.

Shared workspace commands accept --dbfile and --data-dir. Query values use bound parameters. Only local list-files and dump accept the visibly unsafe --unsafe-where escape hatch. Mutating recovery operations preview by default and require --apply where removal is involved.

Index and ingest​

CommandPage
index/commands/index-records
ingest/commands/ingest
index-content/commands/index-content

Inspect​

CommandPage
catalog/commands/catalog
stats/commands/stats
list-files/commands/list-files
doctor/commands/doctor
search/commands/search

Export​

CommandPage
dump/commands/dump
get/commands/get
dump-metadata/commands/dump-metadata
export-cdxj/commands/export-cdxj

Analysis​

CommandPage
analyze/commands/analyze

Maintenance​

CommandPage
rebind/commands/rebind
cleanup/commands/cleanup

Interfaces​

CommandExtraPage
serveapi or replay/commands/serve
replayapi or replay/commands/replay
mcpmcp/commands/mcp
jobsnone (uses the workspace's data/jobs/ directory)/commands/jobs

Global flags: --verbose / -v, --version, -h / --help.