Command directory

Use explicit glob commands for shell work and scripts. Run bare glob for the full-screen terminal interface. This directory lists the registered command surface and links to the detailed behaviour and examples.

glob --help
glob notes edit --help
glob version --json

--help or -h shows usage at each level. glob --version prints the CLI version; glob version also reports the output protocol version. Place --json and other options on the final command: glob notes list --json.

In the tables, store options means both --store <directory> and --json. JSON means --json without --store. Help is available throughout. Angle brackets mark a required value; square brackets mark an optional argument. Omit the brackets themselves when typing commands.

Status and configuration#

See configuration for precedence, paths and the limits of the saved output and workspace values.

Store health with doctor#

glob doctor
glob doctor --store "$HOME/glob-work" --json

doctor opens the selected store and creates it when absent. Its success message confirms that it could open the store; it does not test hosted sign-in or sync.

The JSON result contains store_directory, mode, schema_version, configurations, record_counts and store_files. Each file entry has name and bytes.

On Linux, schema_version and the configuration are sqlite, and the count is knowledge_records. On macOS, the command reports the platform's store schema, configurations and counts for records, links, temporal events, commitments and chat messages. These differences reflect what the diagnostic can inspect on each platform.

glob doctor --rebuild-projection --json

On Linux, --rebuild-projection reconstructs the readable record view from stored documents. It returns store_directory and rebuilt_records. Use it when documents are present but their record listings need rebuilding. It does not fetch missing data from the account service. On macOS this option returns UNAVAILABLE: projection rebuild is only available for package-backed stores.

Sign-in and Ask Glob#

See sign in and Ask Glob for accepted combinations and examples. Login has no default interactive method: choose its flags explicitly.

Notes, tasks, search and links#

All commands in this table accept store options.

The tag option accepts multiple values up to the next option and can be repeated. See notes, tasks and links for ordering, task-list windows, tag replacement and search differences.

Views, pins and projects#

All accept store options and require the Linux store.

Read views, pins and projects before choosing between glob new and glob notes new.

Temporal ledger#

glob temporal
glob temporal ledger --limit 20 --json

glob temporal defaults to ledger. It reads the selected store's temporal event ledger, newest first. Options are --limit <number> (default 50), --store <directory> and --json.

Human output shows the occurrence time, kind and title. JSON returns an array containing id, kind, domain, title and occurred_at. An empty store reports no events. This is a read command for available events, rather than a scheduler or a command for adding events.

Portable transfer#

Read export and import for the complete format, safe-copy policy and legacy compatibility.

API keys and sync identities#

These commands accept JSON. Only the commands shown with a store option accept --store.

rotate <id> rotates an API key. Without an ID it rotates the sync identity on Linux. readonly and readwrite are the only presets. See keys and recovery for required identity details, scope examples and the one-time output.

Linux sync and sharing#

All commands in this table accept store options.

Read sync and sharing for passphrase precedence, partial failures and reset behaviour. These commands are absent from the macOS CLI.

Linux proposal review#

Proposals are suggested graph changes for you to inspect and approve in the store where they would be applied.

glob patches list
glob patches show "$proposal_id"
glob patches apply "$proposal_id" --yes
glob patches reject "$proposal_id"

Only list accepts --json. Each JSON row has id, status, title and operations; the operation count is a string. Human markers are ● pending, ✓ applied and ✗ rejected.

show, apply and reject require a complete proposal UUID. Missing IDs report no proposal …; malformed IDs report id must be a UUID. A proposal already resolved cannot be applied or rejected again and reports proposal is already ….

Apply without --yes asks you to rerun after reviewing glob patches show. The review commands use text errors rather than the standard JSON error envelope. They do not require an account sign-in just to inspect the local proposals.

Linux relay#

glob relay-node accepts --server, --api-key, --key-id, --scope-json, --device-id, --label, --passphrase-stdin, --once, --poll-max and --store. It does not accept --json.

Read running a relay for setup, examples and how the relay relates to sync. The command is absent from macOS.