Skip to content

Latest commit

 

History

History
100 lines (98 loc) · 11.7 KB

File metadata and controls

100 lines (98 loc) · 11.7 KB

The bin/ toolbelt

The first mate drives these; interactive entrypoints work by hand too, while *-lib.sh files are sourced helpers. Each row is one purpose clause only: the script's own header comment is the authoritative description of its behavior, flags, and contracts, so read the header before first use. If you have changed away from the firstmate home in an interactive shell, invoke these scripts by absolute path through the repo's bin/ directory; the scripts self-locate internally after they start. The shared no-mistakes gate refusal for fleet lifecycle entrypoints is summarized in architecture.md, while docs/sessionstart-nudge.md covers the silent hook-nudge use; fm-gate-refuse-lib.sh's header owns its exact contract.

Script Purpose
fm-session-start.sh Compose lock, bootstrap, and wake drain into the single ordered session-start digest
fm-sessionstart-nudge.sh Print the native session-start hook nudge when the primary has not already run the digest
fm-bootstrap.sh Detect toolchain and fleet problems, run the locked session-start sweeps, and install approved tools
fm-axi-suite.sh Check and gate patch/minor self-updates of the npm-distributed AXI CLI suite
fm-firstmate-update-check.sh Read-only check for relevant upstream kunchenguid/firstmate instruction-surface commits
fm-fork-sync-check.sh Detect a pending curated-fork merge and prefilter its fork-only patch review
fm-lint.sh Single owner of firstmate's shell-lint definition: file set, config, and pinned ShellCheck version
fm-install-shellcheck.sh Install CI's pinned, checksum-verified ShellCheck build fm-lint.sh requires
fm-fleet-sync.sh Refresh project clones with safe fast-forwards, self-heals, STUCK: reports, branch pruning, and bounded recovery from an orphaned .git/packed-refs.lock
fm-fleet-snapshot.sh Print the read-only structured fleet snapshot JSON (schema fm-fleet-snapshot.v1)
fm-fleet-view.sh Render the fleet snapshot as a human Markdown view
fm-bearings-snapshot.sh Project the fleet snapshot to the compact TOON bearings view; local-only unless --include-prs
fm-update.sh Fast-forward-only self-update of firstmate and secondmate homes from origin
fm-backlog-handoff.sh Validate and delegate queued backlog-item moves into a secondmate home
fm-decision-hold.sh Create, verify, complete, and resolve durable captain-held decisions
fm-brief.sh Scaffold ship, scout, secondmate-charter, and Herdr-lab briefs
fm-herdr-lab.sh Provision and guardedly operate an isolated, never-default Herdr lab session
fm-ensure-agents-md.sh Ensure a project's real AGENTS.md, its CLAUDE.md symlink, and the canonical self-governance section
fm-guard.sh Warn on primary-checkout tangles, pending queued wakes, and stale watcher liveness
fm-primary-scope-lib.sh Shared marker-or-plain-checkout primary-home predicate for tracked hooks
fm-turnend-guard.sh Shared primary turn-end guard predicate so no turn ends blind (docs/turnend-guard.md)
fm-turnend-guard-grok.sh Grok Stop-hook adapter for the primary turn-end guard
fm-arm-pretool-check.sh Stable PreToolUse transport for the supervision-arm command policy (docs/arm-pretool-check.md)
fm-arm-command-policy.mjs Semantic owner of the supervision-arm PreToolUse policy (docs/arm-pretool-check.md)
fm-cd-pretool-check.sh Stable PreToolUse transport for the cd-guard command policy (docs/cd-guard.md)
fm-cd-command-policy.mjs Semantic owner of the cd-guard PreToolUse policy (docs/cd-guard.md)
fm-supervision-instructions.sh Render the session-start primary-harness supervision block or the one-line repair instruction
fm-home-seed.sh Transactionally provision a secondmate home and maintain data/secondmates.md
fm-spawn.sh Spawn crewmates, scouts, id=repo batches, and secondmates on the resolved harness and runtime backend
fm-secondmate-state.sh Atomically set a persistent secondmate's parent-home active/resting lifecycle state
fm-dispatch-select.sh Resolve a matched crew-dispatch rule to one concrete profile, owning quota-balanced selection
fm-backend.sh Runtime-backend selection, meta helpers, selector resolution, and operation dispatch
fm-backend-hometag-lib.sh Shared per-installation home-tag derivation for zellij tab and cmux workspace titles
fm-composer-lib.sh Single fleet-wide owner of composer-content classification for all backends
backends/tmux.sh Verified tmux session-provider adapter
backends/herdr.sh Experimental herdr session-provider adapter
backends/herdr-eventwait.py Raw AF_UNIX subscriber transport for herdr's native pane.agent_status_changed push stream (docs/herdr-backend.md)
backends/zellij.sh Experimental zellij session-provider adapter
backends/orca.sh Experimental Orca backend adapter owning both worktree and terminal
backends/cmux.sh Experimental cmux session-provider adapter
fm-config-push.sh Push declared inherited local material to live secondmate homes mid-session
fm-project-mode.sh Resolve a project's delivery mode and +yolo flag from data/projects.md
fm-merge-local.sh Fast-forward a local-only project's local default branch after approval
fm-bridge-relay.sh Guardedly relay envelope-only send/inbox/status/broadcast calls to the coditan-bridge checkout's own scripts
fm-review-diff.sh Review a crewmate branch or recorded PR head against the authoritative base
fm-marker-lib.sh Shared from-firstmate request marker, detector, and idempotent transformation
fm-mark-parked.sh Validate and declare an ordinary terminal task parked through a seatbelt-safe wrapper
fm-gate-refuse-lib.sh Shared no-mistakes gate-context refusal for fleet lifecycle entrypoints
fm-watcher-service.sh Select, converge, install, or restart the home-scoped systemd or tmux watcher keeper
fm-watch-keeper.sh Respawn the daemon watcher inside the detached tmux fallback session
fm-watch-arm.sh Verify the external watcher service and await one session delivery stub
fm-wake-wait.sh Wait for a durable queued wake without draining it
fm-watch-checkpoint.sh Run one bounded foreground delivery-stub checkpoint for Codex supervision
fm-watch.sh Singleton-safe daemon watcher that absorbs benign wakes and durably queues actionable ones
fm-tg-recv-arm.sh Verified home-scoped direct Telegram receiver arm wrapper with attach-or-start behavior
fm-afk-start.sh Run the common sourceable away-mode daemon entry in the foreground
fm-afk-launch.sh Own away-mode entry, exit, rollback, and any backend terminal lifecycle
fm-afk-return.sh Own deterministic return shutdown, catch-up evidence, and the firstmate-actionable blocker gate
fm-supervisor-target-lib.sh Resolve the shared supervisor target and backend for the daemon and launcher
fm-supervise-daemon.sh Presence-gated away-mode sub-supervisor: self-handle routine wakes, escalate batched digests, alert on failed delivery
fm-crew-state.sh Print one deterministic current-state line for a crew
fm-tangle-lib.sh Shared default-branch resolution and primary-checkout tangle classification
fm-supervision-lib.sh Shared in-flight-work and watcher-beacon status
fm-ff-lib.sh Shared guarded fast-forward helper for origin pulls and local secondmate syncs
fm-lock-lib.sh Shared "is this git lock provably abandoned?" proof used by teardown and fleet-sync
fm-transition-lib.sh Shared backend-neutral agent-state transition record and supervision policy
fm-config-inherit-lib.sh Shared primary-to-secondmate inherited local-material propagation
fm-tasks-axi-lib.sh Shared backlog-backend selector and tasks-axi compatibility probe
fm-wake-drain.sh Atomically drain queued watcher wakes, then assert watcher liveness
fm-wake-lib.sh Shared durable wake queue, portable locks, and watcher identity/health helpers
fm-classify-lib.sh Shared captain-relevant and declared-external-wait wake classification vocabulary
fm-send.sh Send one verified literal line or supported key through the target's recorded backend
fm-tmux-lib.sh Shared tmux pane primitives for busy detection, composer capture, and verified submit
fm-peek.sh Print a bounded tail of a crewmate endpoint
fm-check-register.sh Bind an intentional custom watcher check to its current bytes
fm-check-lib.sh Validate custom-check registrations and prepare private execution snapshots
fm-pr-lib.sh Own canonical task and PR validation plus private atomic PR-poll and provenance publication
fm-pr-poll.sh Provide the byte-static watcher program for validated PR-poll sidecars
fm-pr-check-migrate.sh Quarantine older task polls without execution and rebuild only canonical polls
fm-pr-check.sh Record validated pr= and pr_head= values, then atomically arm a static merge poll
fm-pr-merge.sh Record PR metadata, then merge a task's canonical full GitHub URL
fm-promote.sh Promote a scout task in place to a protected ship task
fm-teardown.sh Fail-closed teardown: return landed ship worktrees, require completed scout deliverables, retire secondmate homes
fm-harness.sh Detect the running harness and resolve crew or secondmate harness, model, and effort
fm-lock.sh Per-home firstmate session lock
fm-x-lib.sh Shared X-mode config, relay, and reply-threading helpers
fm-x-poll.sh One bounded X relay poll: stash pending mentions, print x-mention <request_id>
fm-x-reply.sh Post or dry-run preview a composed X-mode reply or follow-up
fm-x-dismiss.sh Dismiss a skipped X-mode mention at the relay without replying
fm-x-link.sh Link a spawned task to its originating X-mode mention in task meta
fm-x-followup.sh Detect, post, and cap completion follow-ups for an X-mode-linked task