/ 01Install
Three options:
# From the Rust workspace cargo install --path fieldbook-cli-rs # From Homebrew brew install parelion/tap/fieldbook # Direct binary curl -L https://download.parelion.com/fieldbook/1.1.2/fieldbook-$(uname -s)-$(uname -m) \ -o /usr/local/bin/fieldbook && chmod +x /usr/local/bin/fieldbook # Verify fieldbook --version
/ 02CRUD commands
CLIfieldbook create PATH [--name] [--encrypt] [--password]Create a new fieldbook.
CLIfieldbook query PATH TABLE [--filter WHERE] [--format json|csv|table]Query rows. WHERE supports the same operators as the RLS predicate language.
CLIfieldbook insert PATH TABLE --data '{json}'Insert a row.
CLIfieldbook update PATH TABLE RECORD_ID --set '{json}'Update one or more cells.
CLIfieldbook delete PATH TABLE RECORD_IDDelete a row.
CLIfieldbook merge BASE INCOMING [--output PATH]Three-way merge of two fieldbooks via oplog delta.
CLIfieldbook repl PATHInteractive REPL with FQL + SQL.
CLIfieldbook rekey PATH --password OLD --new-password NEWChange encryption password.
/ 03Import / export
CLIfieldbook export PATH [--format json|csv|xlsx] [--table TABLE]Export to CSV, JSON, or XLSX.
CLIfieldbook import PATH TABLE --from FILE [--format csv|json]Import into an existing table. Schema is inferred when omitted.
/ 04Inspection
CLIfieldbook validate PATH [--strict] [--fix] [--json]Verify integrity hashes and audit chain.
CLIfieldbook info PATH [--json]Print manifest metadata.
CLIfieldbook schema PATHPrint table and field definitions.
CLIfieldbook oplog PATH [--last 20]Show recent oplog entries.
CLIfieldbook audit PATH [--last 20]Show recent audit entries.
CLIfieldbook documents list PATHList embedded documents.
CLIfieldbook documents verify PATHVerify every document's SHA-256.
/ 05Snapshots
CLIfieldbook snapshot create PATH [--name]Take a snapshot with optional human-readable name.
CLIfieldbook snapshot list PATHList snapshots with reason, age, legal-hold flag.
CLIfieldbook snapshot restore PATH NAMERevert to a named snapshot.
/ 06Compliance
CLIfieldbook migrate PATH [--schema PATH]Apply schema migrations.
CLIfieldbook gdpr-erase PATH --record-id ID [--table] [--fields]GDPR right-to-erasure with chain rehashing.
CLIfieldbook legal-hold set PATH --matter ID --initiated-by USERPlace a legal hold.
CLIfieldbook legal-hold release PATHRelease the legal hold.
CLIfieldbook legal-hold status PATHCheck hold status.
CLIfieldbook retention PATHReview retention policies and expiring records.
/ 07Output formats
Every command that produces structured output supports --format:
table— human-readable; default when stdout is a TTYjson— line-delimited JSON; default when stdout is a pipecsv— comma-separated; useful for piping to spreadsheets
The --quiet flag suppresses progress and human-friendly output.
/ 08Exit codes
| Code | Meaning |
|---|---|
0 | Success |
1 | Generic error |
2 | Validation failure |
3 | Not found (file, table, record) |
4 | Authentication / authorisation failure |
5 | File locked by another process |