CClawMetryDocs

CLI reference

clawmetry connect / disconnect#

Activate or stop cloud sync for this node.

bash
clawmetry connect --key cm_xxx
clawmetry disconnect

Connecting does not change what ClawMetry observes or how. It adds one thing: the daemon builds an encrypted snapshot and pushes it upward. Session content is AES-256-GCM encrypted before it leaves the machine — End-to-end encryption has the field-level detail.

connect flags#

FlagEffect
--key cm_xxxAPI key, skipping the prompt
--enc-key KEYEncryption key, skipping the prompt. For automated and sandbox use.
--node-id NAMECustom node name (default: the hostname)
--start-sync-nowSkip the ownership OTP and start syncing immediately
--defer-syncConnect but leave sync paused; start it later with clawmetry sync
--no-daemonConnect but do not start the daemon — you supervise it externally
--key-onlySave key and configuration only, do not start the daemon
--forceOverride the persistent local-only marker and connect anyway
--foregroundRun the daemon in the foreground

The ownership OTP#

Connecting a node to an account is a claim of ownership, so by default it is verified with a one-time code. The command you copy out of the dashboard already carries --start-sync-now, because in that flow the browser session has already proved who you are.

Sync-on-connect is the default; --start-sync-now only skips the verification step.

Deferring sync#

bash
clawmetry connect --key cm_xxx --defer-sync
# later, when you are ready for data to move:
clawmetry sync

Useful when provisioning a machine before it has anything worth syncing, or when you want the configuration in place but the data flow gated on a separate approval.

Key-only and no-daemon#

Two different things:

  • --key-only writes the key and configuration and stops. Nothing is started.
  • --no-daemon completes the connect but leaves the daemon for your own

supervisor to run.

Use --no-daemon under supervisord or a systemd unit you maintain; use --key-only when a host process handles the lifecycle entirely.

Self-hosted endpoints#

bash
CLAWMETRY_ENDPOINT=https://clawmetry.internal.example.com \
  clawmetry connect --key cm_xxx

→ Self-hosted ingest

disconnect#

bash
clawmetry disconnect

Stops cloud sync and removes the key. Your local store is untouched — every session, every event, all of your history stays exactly where it was. The dashboard keeps working; it simply stops pushing.

account#

bash
clawmetry account

Shows the account this node is attached to, or links an email address to it.

Checking state#

bash
clawmetry status --json | jq '{cloud, node_id, endpoint, last_push}'
clawmetry status --show-key           # reveal the secret key

--show-key prints a credential to your terminal. Be deliberate about where.

Edit this page View as Markdown Report an issue
Cookie preferences