Metadata-Version: 2.5
Name: agentic-preflight
Version: 0.5.3.1
Summary: Stops your coding agent from pushing unverified work. Your agent does the reviewing; a state machine records the result per-commit and gates the push.
Project-URL: Homepage, https://github.com/elanthus/agentic-preflight
Project-URL: Repository, https://github.com/elanthus/agentic-preflight
Project-URL: Issues, https://github.com/elanthus/agentic-preflight/issues
Author-email: elanthus <tokenmagic33@gmail.com>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Keywords: agent,cli,code-review,git,pre-push,quality-gate,state-machine
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Version Control :: Git
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: click>=8.1
Requires-Dist: pydantic>=2.6
Description-Content-Type: text/markdown

# agentic-preflight

[![CI](https://github.com/elanthus/agentic-preflight/actions/workflows/ci.yml/badge.svg)](https://github.com/elanthus/agentic-preflight/actions/workflows/ci.yml)
[![Coverage](https://raw.githubusercontent.com/elanthus/agentic-preflight/badges/coverage.svg)](https://github.com/elanthus/agentic-preflight/tree/badges)
[![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13-blue)](https://github.com/elanthus/agentic-preflight/blob/v0.5.3.1/pyproject.toml)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/elanthus/agentic-preflight/blob/v0.5.3.1/LICENSE)

**Stop your coding agent from pushing unverified work.**

Agentic Preflight guides the coding agent already working in your repository through
review, documentation, lint, and test gates. It records the result against the exact
commit, then uses a pre-push hook to block publication when that evidence is missing or
stale. The core CLI calls no model and needs no model API key.

Interested in the design? See the
[project evidence and engineering notes](docs/portfolio-review.md).

![A push blocked by the pre-push hook, a review that catches an unguarded division by
zero, the fix verified, and the gate stopping to ask before it pushes](docs/demo.gif)

## Quickstart

You need Git 2.30+, Python 3.11 through 3.13, and
[`uv`](https://docs.astral.sh/uv/getting-started/installation/). From any directory:

```bash
uv tool install agentic-preflight
agentic-preflight integrations install codex claude cursor opencode amp
```

Install only the coding-agent integrations you use. Then initialize each repository
you want to protect:

```bash
cd your-repo
agentic-preflight init
git add .agentic-preflight.toml
git commit -m "Configure Agentic Preflight"
```

`init` writes a commented configuration file and installs an advisory pre-push hook.
Review the generated configuration before starting a run because its setup, lint, test,
and optional command-review entries execute with your user privileges.

Make and commit your product change, then ask your coding agent to invoke
`$agentic-preflight` in Codex or `/agentic-preflight` in Claude Code. The installed skill
drives the run, presents any findings, and follows each command returned by the CLI.

The [installation guide](https://github.com/elanthus/agentic-preflight/blob/v0.5.3.1/docs/installation.md)
covers source installs, upgrades, project-scoped skills, other Agent Skills clients,
and removal.

If you try to push the changed commit before its run is green, the hook stops the push
and tells you to invoke the installed skill. After verification, the agent shows the
target remote, branch, commits, and risk before publication. An explicit request or
applicable standing user instructions can authorize the matching push, including PR
feedback fixes on the existing head branch when those instructions permit it. The agent
asks only when authorization is missing or the scope materially differs. Set `[gate]
mode = "manual"` when only a person should run the final Git command.

## What happens during a run

Agentic Preflight moves the change through one ordered workflow:

```text
review -> documentation -> lint -> test -> merge-back -> gate -> push
```

At the start of a run, the agent supplies your objective and acceptance criteria. When
`origin` exists, Agentic Preflight fetches it and rebases the validation checkout onto
the fresh base before review. Every agent-facing command returns one JSON object with
the single next legal command, so interrupted work can resume from recorded state.

The stages provide different checks:

- **Review** inventories the changed hunks and non-text files, then requires the reviewer
  to account for the complete snapshot. Findings remain recorded with their disposition.
- **Documentation** checks configured documentation for claims made stale by the change.
- **Lint and test** run the commands configured for the repository and record their exit
  codes and output hashes. Documentation- and CI-only changes skip the software test
  command through an explicit recorded transition when test authority is local. With
  opt-in trusted CI test authority, publication proceeds with tests pending and the
  current integration commit must pass protected CI before merge.
- **Merge-back and approval** verify that the reviewed content matches the source branch,
  classify risk from repository policy and findings, and show the target remote, branch,
  and commits before publication.
- **Push** atomically publishes the branch and its Git-note attestation. Automatic PR mode
  then lets the agent create or reuse a GitHub pull request and monitor its checks; manual
  PR mode returns a compare URL instead.

Equivalent-content rebases can reuse stage evidence after a compatible verifier is
installed on the protected base. Shell stages also need committed input contracts;
see the [fingerprint contract](https://github.com/elanthus/agentic-preflight/blob/v0.5.3.1/docs/fingerprint-contract.md).

Pull-request merge polling and post-merge cleanup are disabled by default. Set
`[pr] automatedCleanup = true` to opt in.

Run `agentic-preflight status` in the source worktree to inspect or resume its run. Use
`agentic-preflight status --all` to inventory runs across linked worktrees.

## Choose a worktree mode

The default `in_place` mode validates in the current checkout. It suits a clean,
dedicated one-agent/one-PR worktree and can reuse that checkout's installed dependencies.

Set `[worktree] mode` to `reusable` or `strict` when validation should leave the source
checkout untouched. Isolated worktrees do not inherit `.venv`, `node_modules`, `.env`,
or other ignored files. Configure `setup_command` for dependencies and `copy_files` for
required ignored files. The
[worktree-modes guide](https://github.com/elanthus/agentic-preflight/blob/v0.5.3.1/docs/worktree-modes.md)
explains the tradeoffs and recovery behavior.

## Configure repository policy

Commit `.agentic-preflight.toml` at the repository root. It layers over the user-wide
`~/.config/agentic-preflight/config.toml`, with repository sections taking precedence.
Use it to set:

- the protected base branch and lint/test commands;
- blocking finding severities and independent command-review policy;
- documentation paths and generated-file exclusions;
- path-based risk and the required human-approval mode;
- in-place, reusable, or strict validation worktrees; and
- automatic or manual push and pull-request behavior.

Unknown keys are errors. Commit configuration changes before starting the run they
should affect; a run snapshots its resolved configuration. See the
[configuration reference](https://github.com/elanthus/agentic-preflight/blob/v0.5.3.1/docs/configuration.md)
for every option and a complete example.

> **Warning:** A repository can configure setup, lint, test, and independent-review
> commands that execute with your privileges. Run Agentic Preflight only in repositories
> whose code and build commands you are willing to execute.

## Use attestations in CI

A successful merge-back writes a versioned JSON attestation as a Git note on the exact
commit. The note records review coverage, finding dispositions, stage results, policy,
and the inputs that determine whether evidence still applies after a history rewrite.

The local hook checks the commit being pushed. A protected-base GitHub workflow can also
verify the note and enforce the configured high-risk approval mode before merge. This
requires forge configuration; committing `.agentic-preflight.toml` alone does not change
branch protection. See
[Portable attestations and CI enforcement](https://github.com/elanthus/agentic-preflight/blob/v0.5.3.1/docs/attestations-and-ci.md)
for setup and verification commands.

## Limits

**Agentic Preflight is an advisory quality gate, not a security boundary.**

- A person can bypass the local hook with `git push --no-verify`.
- The push-confirmation token is deliberate ceremony, not a secret. It prevents an
  accidental tool-driven push but does not stop an agent with shell access from invoking
  Git directly.
- A green record proves what the configured gate reported. It does not prove that the
  reviewer understood the change, and it replaces neither hosted CI nor human review.
- Git notes are mutable. Anyone allowed to update the notes ref can replace an
  attestation.

Set `[gate] mode = "manual"` if the CLI must refuse to perform the final push itself.
Read the [limits guide](https://github.com/elanthus/agentic-preflight/blob/v0.5.3.1/docs/limits.md)
before relying on attestations or evidence reuse for policy enforcement.

## Requirements

- A supported macOS, Linux, or Windows and Python combination from the
  [compatibility policy](https://github.com/elanthus/agentic-preflight/blob/v0.5.3.1/COMPATIBILITY.md)
- Git 2.30+
- A POSIX shell when a configured command needs shell interpretation or its program
  cannot be resolved directly; on Windows, Git for Windows provides it
- `gh` when the agent will create pull requests, inspect hosted checks, or verify merges

## Help and development

Use the [support guide](https://github.com/elanthus/agentic-preflight/blob/v0.5.3.1/SUPPORT.md)
for help and security-reporting routes. Contributors should start with the
[contributor guide](https://github.com/elanthus/agentic-preflight/blob/v0.5.3.1/CONTRIBUTING.md).

Agentic Preflight is Apache 2.0 licensed. It was created by
[@elanthus](https://github.com/elanthus) with development contributions from OpenAI Codex
and Anthropic Claude.
