Skip to content

Push

push

GitPushTool — push current branch with dirty-check and upstream detection.

GitPushTool

Bases: AXMTool

Push the current branch after verifying a clean working tree.

Registered as git_push via axm.tools entry point.

Source code in packages/axm-git/src/axm_git/tools/push.py
Python
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
class GitPushTool(AXMTool):
    """Push the current branch after verifying a clean working tree.

    Registered as ``git_push`` via axm.tools entry point.
    """

    @property
    def name(self) -> str:
        """Tool name used for MCP registration."""
        return "git_push"

    def execute(
        self,
        *,
        path: str = ".",
        remote: str = "origin",
        set_upstream: bool = True,
        force: bool = False,
        force_unconditional: bool = False,
        **kwargs: object,
    ) -> ToolResult:
        """Push the current branch to a remote.

        Args:
            path: Project root directory.
            remote: Remote name (default ``origin``).
            set_upstream: Auto-set upstream for new branches.
            force: If True, force-push using ``--force-with-lease`` (safe:
                the remote is only overwritten if it has not advanced
                beyond our remote-tracking ref).
            force_unconditional: If True (and ``force`` is set), use a bare
                ``--force`` instead, overwriting the remote unconditionally.
                DATA-LOSS RISK: this discards remote commits we never saw.
                Leave False unless a deliberate hard overwrite is intended.

        Returns:
            ToolResult with branch, remote, and push status.
        """
        resolved = Path(path).resolve()

        try:
            # 1. Verify this is a git repo.
            check = run_git(["rev-parse", "--git-dir"], resolved)
            if check.returncode != 0:
                repo_err = not_a_repo_error(check.stderr, resolved)
                return ToolResult(
                    success=repo_err.success,
                    error=repo_err.error,
                    data=repo_err.data,
                    text=render_failure_text(
                        error=repo_err.error or "", data=repo_err.data
                    ),
                )

            # 2. Dirty check.
            dirty_err = _check_dirty(resolved)
            if dirty_err is not None:
                return dirty_err

            # 3. Get current branch.
            branch_result = run_git(["branch", "--show-current"], resolved)
            branch = branch_result.stdout.strip()
            if not branch:
                error = "No branch checked out (detached HEAD)."
                return ToolResult(
                    success=False,
                    error=error,
                    text=render_failure_text(error=error, data=None),
                )

            # 4. Detect upstream.
            upstream = run_git(
                ["rev-parse", "--abbrev-ref", "@{u}"],
                resolved,
            )
            has_upstream = upstream.returncode == 0

            # 5. Push.
            force_flag = _resolve_force_flag(
                force=force, force_unconditional=force_unconditional
            )
            cmd = _build_push_cmd(
                force_flag=force_flag,
                has_upstream=has_upstream,
                set_upstream=set_upstream,
                remote=remote,
                branch=branch,
            )
            push_result = run_git(cmd, resolved)
            if push_result.returncode != 0:
                error = push_result.stderr.strip() or push_result.stdout.strip()
                return ToolResult(
                    success=False,
                    error=error,
                    text=render_failure_text(error=error, data=None),
                )
        except subprocess.TimeoutExpired as exc:
            return timeout_error_result(exc)

        force_mode = force_flag.removeprefix("--") if force_flag else None
        data: dict[str, object] = {
            "branch": branch,
            "remote": remote,
            "pushed": True,
            "set_upstream": not has_upstream and set_upstream,
            "force_mode": force_mode,
        }
        return ToolResult(success=True, data=data, text=render_text(data))
name property

Tool name used for MCP registration.

execute(*, path='.', remote='origin', set_upstream=True, force=False, force_unconditional=False, **kwargs)

Push the current branch to a remote.

Parameters:

Name Type Description Default
path str

Project root directory.

 '.'
remote str

Remote name (default origin).

 'origin'
set_upstream bool

Auto-set upstream for new branches.

 True
force bool

If True, force-push using --force-with-lease (safe: the remote is only overwritten if it has not advanced beyond our remote-tracking ref).

 False
force_unconditional bool

If True (and force is set), use a bare --force instead, overwriting the remote unconditionally. DATA-LOSS RISK: this discards remote commits we never saw. Leave False unless a deliberate hard overwrite is intended.

 False

Returns:

Type Description
ToolResult

ToolResult with branch, remote, and push status.
Source code in packages/axm-git/src/axm_git/tools/push.py
Python
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
def execute(
    self,
    *,
    path: str = ".",
    remote: str = "origin",
    set_upstream: bool = True,
    force: bool = False,
    force_unconditional: bool = False,
    **kwargs: object,
) -> ToolResult:
    """Push the current branch to a remote.

    Args:
        path: Project root directory.
        remote: Remote name (default ``origin``).
        set_upstream: Auto-set upstream for new branches.
        force: If True, force-push using ``--force-with-lease`` (safe:
            the remote is only overwritten if it has not advanced
            beyond our remote-tracking ref).
        force_unconditional: If True (and ``force`` is set), use a bare
            ``--force`` instead, overwriting the remote unconditionally.
            DATA-LOSS RISK: this discards remote commits we never saw.
            Leave False unless a deliberate hard overwrite is intended.

    Returns:
        ToolResult with branch, remote, and push status.
    """
    resolved = Path(path).resolve()

    try:
        # 1. Verify this is a git repo.
        check = run_git(["rev-parse", "--git-dir"], resolved)
        if check.returncode != 0:
            repo_err = not_a_repo_error(check.stderr, resolved)
            return ToolResult(
                success=repo_err.success,
                error=repo_err.error,
                data=repo_err.data,
                text=render_failure_text(
                    error=repo_err.error or "", data=repo_err.data
                ),
            )

        # 2. Dirty check.
        dirty_err = _check_dirty(resolved)
        if dirty_err is not None:
            return dirty_err

        # 3. Get current branch.
        branch_result = run_git(["branch", "--show-current"], resolved)
        branch = branch_result.stdout.strip()
        if not branch:
            error = "No branch checked out (detached HEAD)."
            return ToolResult(
                success=False,
                error=error,
                text=render_failure_text(error=error, data=None),
            )

        # 4. Detect upstream.
        upstream = run_git(
            ["rev-parse", "--abbrev-ref", "@{u}"],
            resolved,
        )
        has_upstream = upstream.returncode == 0

        # 5. Push.
        force_flag = _resolve_force_flag(
            force=force, force_unconditional=force_unconditional
        )
        cmd = _build_push_cmd(
            force_flag=force_flag,
            has_upstream=has_upstream,
            set_upstream=set_upstream,
            remote=remote,
            branch=branch,
        )
        push_result = run_git(cmd, resolved)
        if push_result.returncode != 0:
            error = push_result.stderr.strip() or push_result.stdout.strip()
            return ToolResult(
                success=False,
                error=error,
                text=render_failure_text(error=error, data=None),
            )
    except subprocess.TimeoutExpired as exc:
        return timeout_error_result(exc)

    force_mode = force_flag.removeprefix("--") if force_flag else None
    data: dict[str, object] = {
        "branch": branch,
        "remote": remote,
        "pushed": True,
        "set_upstream": not has_upstream and set_upstream,
        "force_mode": force_mode,
    }
    return ToolResult(success=True, data=data, text=render_text(data))