Skip to content

Checkpoint

checkpoint

Git checkpoint and rollback for atomic batch edits.

Creates a lightweight git stash before applying edits so the agent can rollback if the result is unsatisfactory.

create_checkpoint(root)

Create a git stash checkpoint.

Parameters:

Name Type Description Default
root Path

Project root directory.

 required

Returns:

Type Description
str | None

The stash commit SHA, or None if not a git repo or nothing
str | None

to stash.
Source code in packages/axm-edit/src/axm_edit/core/checkpoint.py
Python
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def create_checkpoint(root: Path) -> str | None:
    """Create a git stash checkpoint.

    Args:
        root: Project root directory.

    Returns:
        The stash commit SHA, or ``None`` if not a git repo or nothing
        to stash.
    """
    git_dir = root / ".git"
    if not git_dir.exists():
        return None

    try:
        result = subprocess.run(
            ["git", "stash", "create", "-m", "axm-edit checkpoint"],
            cwd=root,
            capture_output=True,
            text=True,
            check=False,
        )
        sha = result.stdout.strip()
        return sha if sha else None
    except OSError:
        return None

rollback(root, checkpoint)

Rollback to a previous checkpoint.

Restores the working tree to the state captured by :func:create_checkpoint.

Parameters:

Name Type Description Default
root Path

Project root directory.

 required
checkpoint str

The stash SHA returned by create_checkpoint.

 required

Returns:

Type Description
bool

True if rollback succeeded.
Source code in packages/axm-edit/src/axm_edit/core/checkpoint.py
Python
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def rollback(root: Path, checkpoint: str) -> bool:
    """Rollback to a previous checkpoint.

    Restores the working tree to the state captured by
    :func:`create_checkpoint`.

    Args:
        root: Project root directory.
        checkpoint: The stash SHA returned by ``create_checkpoint``.

    Returns:
        ``True`` if rollback succeeded.
    """
    try:
        # Reset tracked files
        subprocess.run(
            ["git", "checkout", "--", "."],
            cwd=root,
            capture_output=True,
            text=True,
            check=True,
        )
        # Remove untracked files created by batch_edit
        subprocess.run(
            ["git", "clean", "-fd"],
            cwd=root,
            capture_output=True,
            text=True,
            check=True,
        )
        # Re-apply the stashed state
        if checkpoint:
            subprocess.run(
                ["git", "stash", "apply", checkpoint],
                cwd=root,
                capture_output=True,
                text=True,
                check=True,
            )
        return True
    except (subprocess.CalledProcessError, OSError):
        return False