headwater-engine

Builds the headwater Rust workspace and runs its CLI verbs against a corpus.

Updated Aug 8, 2026
One-click install
npx skills add https://github.com/headwater-ai/headwater --skill headwater-engine-headwater-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: headwater-engine
Source: https://github.com/headwater-ai/headwater/tree/main/.claude/skills/headwater-engine
Command: npx skills add https://github.com/headwater-ai/headwater --skill headwater-engine-headwater-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Contributors to this repository waste sessions on avoidable build and test mistakes: running cargo from the wrong directory, building release binaries when a debug check would do, misreading advisory check output as a passing gate, and hitting toolchain-floor failures on clean checkouts. This Skill carries the correct invocation, the Rust 1.91 toolchain floor, and the five most costly mistakes so an agent gets the engine built and its verbs run correctly the first time. ## Core Features & Use Cases - Canonical build invocation: Build the headwater-cli binary from the repository root with --manifest-path engine/Cargo.toml --locked, or from engine/ with neither flag, and choose between --release and the cheaper dev-release profile depending on whether a hook or commit gate needs the binary. - Verb execution with --root: Run every headwater verb with an explicit --root so the binary reads the intended corpus rather than defaulting to the current directory. - Test suite guidance: Name the right cargo test scope (workspace, single crate, or single test file), re-record fixtures via the documented environment variable, and rebase onto main before blessing recorded artifacts. - Use Case: An agent starting a session that must modify the engine uses this Skill to build with the dev-release profile, run the workspace test suite from engine/, and avoid a stale-main bless that would turn main red on landing. ## Quick Start Ask the agent to build the headwater CLI from the repository root and run headwater check with --root pointed at your corpus.

Frequently Asked Questions about headwater-engine

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build the headwater CLI from source?

Run cargo build --release -p headwater-cli --manifest-path engine/Cargo.toml --locked from the repository root, or the same command without the manifest flag from inside engine/. The binary lands at engine/target/release/headwater and requires Rust 1.91 or later.

Why does cargo test fail from the repository root?

There is no Cargo.toml at the repository root; the cargo workspace lives under engine/. Run cargo test from the engine/ directory, and the error naming a missing Cargo.toml is the tell that you are in the wrong directory.

When should I use --release versus dev-release builds?

Use dev-release for hooks and commit gates since it links faster while remaining optimized enough; reserve --release for handing the binary to someone, running it once against a real corpus, or measuring performance. A debug cargo check and cargo test are sufficient to verify a code change.

Why does headwater check exit 0 but still report problems?

headwater check is advisory by default: it exits 0 while printing findings to standard output. The --strict flag is the actual gate, and it is what the pre-commit hook runs, so read the findings rather than trusting the exit code.

What Rust version does the headwater engine require?

The workspace declares Rust 1.91 or later via rust-version in engine/Cargo.toml. If a clean checkout refuses to build, check the toolchain first; DEVELOPING.md explains which refusal message names the crate that raised the floor.

When should I not use this engine skill?

Do not use it for taxonomy changes to .headwater/packages/, docs/taxonomies/, or overlay files, which belong to the headwater-taxonomy skill, or for orienting on a single document, which headwater explain and the headwater-orient skill handle.