Skip to content

Ironclaw quickstart

Ironclaw has a native Trace Commons client. It captures eligible work locally, creates a redacted contribution envelope, and queues it under the active user’s contribution scope.

You need:

  • A current Ironclaw build with the traces command family.
  • An operator-issued enrollment invite.
  • An explicit decision about whether message text, reasoning, or tool payloads may be included.

The invite registers the instance’s local device key; it does not upload a trace. See Invites and enrollment for the complete lifecycle and safe handling rules.

An administrator with shell access can enroll the entire instance:

Terminal window
ironclaw traces enroll-instance \
--invite '<operator-issued-invite>'

By default, message text and tool payloads are not opted in. Add their flags only after making a deliberate instance-wide decision:

Terminal window
ironclaw traces enroll-instance \
--invite '<operator-issued-invite>' \
--include-message-text

Instance enrollment applies to users who do not have a more specific enrollment or opt-out. Exclude one user with a scoped opt-out:

Terminal window
ironclaw traces opt-out --user-scope '<tenant-id>/<user-id>'
Terminal window
ironclaw traces status --json

Confirm the endpoint, enrollment state, consent scope, inclusion switches, and user scope before producing real trace traffic.

Terminal window
ironclaw traces preview \
--recorded-trace ./recorded-trace.json \
--enqueue
ironclaw traces queue-status
ironclaw traces flush-queue --limit 1
ironclaw traces list-submissions

Use a non-sensitive fixture for the first end-to-end submission. Do not use a production trace merely to test connectivity.

Source contract: crates/app/ironclaw_cli/src/commands/traces and crates/domains/ironclaw_trace_commons.