binder-cli

Binder CLI

Binder is a Markdown-native knowledge graph. The CLI is the primary interface for all operations.

Run binder --help or binder <command> --help for full usage details.

Quick Reference

binder read <ref>                                   # Read a record
binder search type=Task status=active               # Search records
binder schema --types Task                           # Inspect schema
binder create <Type> field=value [field=value...]    # Create a record
binder update <ref> field=value [field=value...]     # Update fields
binder delete <ref>                                  # Delete a record
binder tx import -d file.yaml                        # Dry-run a transaction file
binder tx import file.yaml                           # Apply a transaction file
binder tx log --limit 5                              # Recent transactions
binder undo [N]                                      # Undo last N transactions

Global options: -C <path> cwd, -q quiet, --format output format, -n namespace.

Reading

read

binder read <ref> [--format yaml|json] [-f fields]

Ref: id (numeric), uid (e.g. 6VI6iLYBQUg), or key (e.g. type/field keys Task, status, or a record key like example-task).

Use -f/--fields to include or traverse relations inline — same syntax as search.

search

binder search type=Task status=active       # Filter by field values
binder search "some text"                   # Full-text search
binder search type=Task -f partOf(title)    # Include fields from related records
binder search type=Task -o '!priority'      # Order by (! = descending)
binder search type=Task --limit 10          # Limit results

Options:

• --format — json, jsonl, yaml, csv, tsv
• -n, --namespace — record (default) or config
• -f, --fields — include specific fields or traverse relations. title,status includes those fields. partOf(title,status) follows the partOf relation and includes title and status from the related record. Use relatesTo[type=Task](title) to filter relation targets by type before traversal.
• -o, --orderBy — sort (prefix ! for descending)
• --limit — max results