Scripts Directory

June 6, 2026 · View on GitHub

Helper scripts for development, CI, release, and workspace management. Scripts here are invoked by just recipes, CI workflows, or directly.

Development Helpers

Run these locally during normal contribution work.

ScriptPurpose
install-githooks.shInstall the pre-push hook (run once after cloning)
check-rust-toolchain.shLegacy wrapper to cargo xtask check-toolchain (MSRV compatibility check)
devex-doctor.shEnvironment diagnostics (tool availability, paths)
devex-targeted-checks.shTargeted subset of diagnostics for a specific area
preflight.shQuick pre-flight checks before a PR
pre-merge-check.shVerify the working tree is ready to merge
forbid-fatal-constructs.shGrep for banned patterns (unwrap, panic!, etc.)
dead-code-check.shReport dead code across the workspace

Worktree & Workspace Management

ScriptPurpose
cleanup-worktrees.shRemove stale git worktrees
cleanup-completed-worktrees.shRemove worktrees whose branches are merged
worktree-manager.pyPython interface to create and track named worktrees
validate-workspace-exclusions.shEnsure excluded paths aren't accidentally included
gen-xlarge-workspace.shGenerate a large synthetic workspace for scale testing

CI Gates

Scripts invoked by just CI tiers or GitHub Actions workflows.

ScriptPurpose
gate-local.shRun the local merge gate (same as just ci-gate)
execute-gate.shCompatibility shim for cargo xtask gates --gate <name>
run-gates.shCompatibility shim for cargo xtask gates --tier merge-gate --receipt
e2e-gate.shEnd-to-end gate (full pipeline validation)
e2e-validation.shExtended E2E validation with real Perl files
production-gates-validation.shValidate all production gates pass
test-capped.shRun tests with parallelism cap (low-memory environments)
test-e2e-capped.shE2E tests with parallelism cap
performance-hardening.shPerformance regression checks
security-hardening.shSecurity-related checks
lsp-smoke.shSmoke test the LSP server binary
smoke-test.shGeneral smoke tests
smoke-test-release.shSmoke test a release binary
check-coverage-baseline.shCompare coverage against baseline
update-coverage-baseline.shRatchet the coverage baseline up
ignored-test-count.shReport number of #[ignore]-tagged tests

Release Workflow

Run in order for a release. See CONTRIBUTING.md for the full sequence.

ScriptOrderPurpose
prepare-release.sh1Bump versions, generate changelog entry
release-turnkey-pr.sh2Open release PR with all artifacts
publish-topo.py3Publish crates in topological order
publish-release.sh—Full publish pipeline (wraps publish-topo.py)
publish-new-crates-manually.sh—Publish a single new crate by name
publish-receipts.sh—Generate publish receipts for audit trail
check-version-sync.sh—Verify all version sites agree
prep-crates-io-launch.sh—Pre-launch checklist for crates.io
post-publish-smoke.sh—Verify published crates install correctly
update-homebrew.sh—Update the Homebrew formula after release
verify-publication-facts.sh—Cross-check publication receipts

Corpus & Parser Testing

ScriptPurpose
run_parser_comparison.shCompare v2 vs v3 parser output on test corpus
test_edge_cases.shRun edge case tests for the parser
test_iterative_parser.shTest the iterative parser path
update-parser-matrix.pyRegenerate the parser feature matrix

Documentation & Metrics

ScriptPurpose
update-current-status.pyRegenerate docs/project/CURRENT_STATUS.md metrics
check-doc-claims.pyVerify claims in docs against actual behavior
check_features_invariants.pyValidate features.toml is internally consistent
check_release_history.shCheck release history for consistency
generate-badges.shRegenerate README status badges
render-docs.shBuild the documentation site
verify-docs-rs.shVerify docs.rs links are valid
populate-book.shPopulate the mdBook documentation

Diagnostics & Forensics

ScriptPurpose
build-timing-receipt.shRecord build timing for comparison
compare-build-timing.shCompare two timing receipts
ci-audit-workflows.pyAudit CI workflow definitions
ci-cost-monitor.shReport CI resource usage
debt-report.pyTechnical debt report
debt-pr-summary.pySummarize debt across open PRs
check-v2-bundle-sync.shCheck tree-sitter bundle is in sync
check-windows-distribution.ps1Verify Windows distribution artifacts
forensics/One-off forensic scripts (not for regular use)

Swarm & Agent Operations

ScriptPurpose
agents/Agent definition fragments used by the swarm
agent-preflight.shAgent safety preflight checks
agent-preflight.ps1Windows agent preflight for fixed worktree and Cargo target roots
agent-cleanup.ps1Windows agent cleanup gate for worktree, target, branch, and storage checks
test-agent-preflight.shTest the preflight script itself
control-plane-lock.shAdvisory single-writer lock for swarm operations
test-control-plane-lock.shTest the lock implementation
swarm-summary.shSummarize current swarm state
cargo xtask validate-swarm-agent-rosterValidate agent roster completeness
validate_swarm_findings.pyValidate swarm-discovered findings
bulk-label-issues.shBulk-label GitHub issues by query
close-duplicate-prs.shClose duplicate PRs by title

Security & Miscellaneous

ScriptPurpose
gh/GitHub CLI helper wrappers
marketing/GIF rendering and demo scripts (see docs/assets/gifs/README.md)
tests/Shell-level integration tests for scripts
requirements.txtPython dependencies for scripts that need them
safe-pull.shPull with automatic conflict detection
inject-sha-assets.shInject SHA checksums into release assets
generate-receipt.shGenerate a single artifact receipt
generate-receipts.shGenerate all artifact receipts
quick-receipts.shFast receipt generation for CI
llvm.shLLVM toolchain helpers (coverage, profiling)
install.shInstall perllsp from a local build
list-gates.pyCompatibility shim for cargo xtask gates --list
verify_stacker.shVerify stacker (stack-size extension) is working
test-lsp-cancellation.shTest LSP request cancellation behavior
render-linux-packages.pyBuild Linux distribution packages
DEPRECATED_RELEASE_SCRIPTS.mdIndex of scripts removed from the release workflow