Skip to main content
The yh command runs Yellowhammer’s engine and exposes setup, diagnostics, and explicit control of one Project. Scheduled jobs invoke the bundled engine even when you have not installed the terminal shortcut.

Install the terminal command

Open Settings → General → Command Line Tool and choose Install…. The command creates /usr/local/bin/yh as a symlink to the engine in your app copy. If the app moves or the target becomes stale, use Update… when offered. Check the target shown beside the installation status. Use help to inspect the command supported by your installed copy:
In examples below, acme-checkout is an illustrative Project id. Replace it with the permanent id from your Project’s Configuration pane.

Inspect configuration and readiness

doctor --check narrows the report to configuration, probes, git, linear, github, keychain, launchd, orphans, or orca. --json prints findings as JSON. --probe runs fresh Probes for declared CLIs before evaluating eligibility; unlike ordinary read-only diagnostics, it invokes agents and records results. status --nights 7 examines seven past Nights, the default. Set another positive integer to change the history window. recalibrate --json prints its report as JSON. A diagnostic exits unsuccessfully when it reports failure findings. A warning alone does not make doctor or validate fail. Read the finding’s subject and message to identify whether it concerns the Mac, a connection, or a Project.

Setup and repair

Repairing Linear creates missing items and leaves existing items alone. Re-run the matching read-only check afterwards to confirm the repair. A broad doctor --fix can also repair executable paths and the terminal symlink and handle orphaned jobs; read its findings before applying it. --repoint requires --fix and explicitly permits repointing jobs that name another app copy. Cron export does not install a crontab. Inspect and merge the generated entries with your existing crontab; replacing the whole crontab can remove unrelated jobs.

Run or interrupt work

rehearse runs all three Acts against the configured rehearsal board and Journal. Its board and Worktree operations are real, but it never dispatches an agent, pushes, or opens a pull request. Each real Act command can invoke agents and change its normal board or repository outputs. --force bypasses the Act’s ordinary trigger, so use it deliberately. It is not required for scheduled invocations. To interrupt the illustrative Project:
To abort one running Attempt, use its Journal id shown in the app:
Both commands require an explicit Project id. They wait up to 60 seconds by default; --wait 0 returns after recording the request. Stopping aborts running Attempts; it does not uninstall the recurring schedule.

Other command groups

Use yh project --help for removal and Code Hosting Connection selection; yh config --help for machine connection and Operator configuration; and yh prompts --help for deleting selected recorded prompt data. These commands change local configuration or stored records. Prefer the corresponding Settings controls when you want to inspect context before changing them.

Next steps

Troubleshoot setup and connections · Configure the schedule