Git Hunk

Git Hunk

Use git-hunk to inspect, stage, unstage, and commit precise text changes without interactive prompts.

Prefer change_key over raw line ranges when you need selectors that survive unrelated rescans. Keep snapshot_id for safety, treat change_id as snapshot-local, and treat raw line ranges as a last resort.

Quick Start

1. Scan the repo and capture a snapshot:

git-hunk scan --mode stage --json

2. Inspect a selectable unit:

git-hunk show --mode stage <hunk-id>
git-hunk show --mode stage <change-id> --json
git-hunk show --mode stage <change-key> --json

3. Apply a selection:

git-hunk stage --snapshot <snapshot-id> --hunk <hunk-id>
git-hunk stage --snapshot <snapshot-id> --change <change-id>
git-hunk stage --snapshot <snapshot-id> --change-key <change-key>
git-hunk stage --snapshot <snapshot-id> --hunk <hunk-id>:new:41-44
git-hunk stage --snapshot <snapshot-id> --change-key <change-key> --dry-run --json

4. Commit the exact selection directly:

git-hunk commit -m "feat: message" --snapshot <snapshot-id> --change <change-id>
git-hunk commit -m "feat: message" --snapshot <snapshot-id> --change-key <change-key>
git-hunk commit -m "fix: message" --snapshot <snapshot-id> --hunk <hunk-id>:old:18-22
git-hunk commit -m "feat: message" --snapshot <snapshot-id> --change-key <change-key> --dry-run --json

5. Resolve a file+line hint into durable selectors:

git-hunk resolve --mode stage --snapshot <snapshot-id> --path src/lib.rs --start 42 --json

6. Recover stale selections without mutating anything:

git-hunk validate --mode stage --snapshot <snapshot-id> --change-key <change-key> --compact --json

Workflow

Stage mode

• Use scan --mode stage for worktree changes relative to the index.
• Select by whole hunk, change_id, change_key, or line range.
• Prefer --json for agents; ids and snapshot_id come from scan output.
• Use scan --compact --json when you want short previews and metadata without the full line arrays.
• Use selector bundles from JSON output instead of reconstructing selectors by hand.

Unstage mode

• Use scan --mode unstage for staged changes relative to HEAD.
• Use the same selectors with unstage to remove only part of the index.

git-hunk unstage --snapshot <snapshot-id> --change <change-id>
git-hunk unstage --snapshot <snapshot-id> --change-key <change-key>
git-hunk unstage --snapshot <snapshot-id> --hunk <hunk-id>:old:10-12

Change keys

• change_id is snapshot-bound and should be treated as ephemeral.
• change_key_scheme is currently v1.
• change_key is derived from the change content plus nearby context so it survives unrelated rescans, duplicate disambiguation, and hunk splitting caused by unrelated edits.
• change_key is not guaranteed to survive nearby context edits, renames, or future scheme changes.
• Prefer --change-key for multi-step agent workflows where a fresh scan may happen before mutation.
• Use show, stage, unstage, and commit with a change_key exactly like a change_id.

Resolve helper

• Use resolve when you know a file and approximate line range but do not want to reason about diff internals.
• resolve returns recommended change_ids, change_keys, hunk selectors, selector bundles, and candidate metadata.
• --side auto is the default; it prefers new lines in stage mode and old lines in unstage mode.

git-hunk resolve --mode stage --snapshot <snapshot-id> --path src/lib.rs --start 42 --end 47 --json
git-hunk resolve --mode unstage --snapshot <snapshot-id> --path src/lib.rs --start 42 --side old --json

Validation and dry-run previews

• Use validate to compare an old snapshot_id against the current repo state and recover change_key selections before retrying a mutation.
• Use stage --dry-run to preview what the index would look like after staging a selection.
• Use unstage --dry-run to preview what would remain staged after removing a selection.
• Use commit --dry-run to preview the exact files, diffstat, and patch that would be committed.
• All dry-run commands use the real selection path against a temporary index, so they reflect actual behavior without mutating the repo.

Line-range selectors

• Syntax: <hunk-id>:<old|new>:<start-end>.
• Use new when selecting added/replacement lines from stage mode.
• Use old when selecting the preimage side, especially in unstage mode.
• Use show without --json when you want numbered lines in terminal output.
• Agents should almost always prefer change_key, then change_id, then resolve, and only use raw line ranges when reproducing a user-specified range exactly.

Snapshot Discipline

• Treat snapshot_id as mandatory for any mutating command.
• Rescan after every successful stage, unstage, or commit.
• If the command returns stale_snapshot, do not retry blindly; inspect error.details or run validate to recover with the fresh snapshot.
• change_key can survive rescans, but the mutation still needs a fresh snapshot_id before it applies.

Plan Files

Use a plan file when passing many selectors or when another tool is driving the workflow.

{
  "snapshot_id": "s_123",
  "selectors": [
    { "type": "hunk", "id": "h_abc" },
    { "type": "change", "id": "c_def" },
    { "type": "change_key", "key": "ck_xyz" },
    {
      "type": "line_range",
      "hunk_id": "h_xyz",
      "side": "new",
      "start": 41,
      "end": 44
    }
  ]
}

Run it with:

git-hunk stage --plan plan.json --json
git-hunk stage --plan - --json < plan.json
git-hunk commit -m "refactor: split change" --plan plan.json --json

Failure Handling

• If you get ambiguous_line_range, widen the range to cover the full atomic change or fall back to the change_id shown by scan.
• Use error.category, error.retryable, and error.details from JSON errors to decide whether to rescan, retry, or fall back.
• If a path appears under unsupported, do not try to force it through git-hunk; use normal git commands or a different workflow for conflicts, renames, copies, binary files, or non-UTF8 diffs.
• If there is nothing staged, commit fails unless --allow-empty is set.

Practical Defaults

• Prefer change_key over line ranges whenever both are available.
• Prefer resolve when you only have a file+line hint.
• Prefer validate when an old snapshot goes stale but you still have change_keys.
• Prefer stage --dry-run, unstage --dry-run, or commit --dry-run before a risky atomic mutation from a dirty tree.
• Prefer commit with selectors when the user asked for a commit and you already know the exact changes.
• Prefer stage first when you need to inspect the staged result before committing.
• Keep commits atomic by scanning, selecting a minimal set, committing, then rescanning for the next commit.

Source: nexxeln/git-hunk — distributed by TomeVault.