rocket-review 0.1.1__tar.gz

rocket_review-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 LedgerRocket
+
+   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.

rocket_review-0.1.1/PKG-INFO

@@ -0,0 +1,289 @@
+Metadata-Version: 2.4
+Name: rocket-review
+Version: 0.1.1
+Summary: Second-opinion code and plan reviews from Codex, Claude Code, opencode, or the OpenAI API — one CLI
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/ledger-rocket/rocket-review
+Project-URL: Issues, https://github.com/ledger-rocket/rocket-review/issues
+Keywords: code-review,llm,ai,cli,developer-tools
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: api
+Requires-Dist: openai>=1.68; extra == "api"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: mypy>=1.18; extra == "dev"
+Requires-Dist: yamllint>=1.37; extra == "dev"
+Requires-Dist: rocket-review[api]; extra == "dev"
+Dynamic: license-file
+
+# rocket-review
+
+[![CI](https://github.com/ledger-rocket/rocket-review/actions/workflows/ci.yml/badge.svg)](https://github.com/ledger-rocket/rocket-review/actions/workflows/ci.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python 3.13+](https://img.shields.io/badge/python-3.13%2B-blue.svg)](https://www.python.org/downloads/)
+[![PyPI](https://img.shields.io/pypi/v/rocket-review)](https://pypi.org/project/rocket-review/)
+
+**`rr` — a second opinion on your code, from a model that didn't write it.**
+
+> **v0.1 — experimental.** Interfaces and flags may change. Read
+> [Security & data flow](#security--data-flow) before pointing it at anything sensitive.
+
+One small CLI that sends your plan, diff, commit, or PR to an agentic reviewer
+(Codex CLI, Claude Code, or opencode) that explores your project before judging —
+then gives you prose or structured JSON you can gate CI on.
+
+Single-model local review is built into the vendor CLIs now (`codex review`,
+Claude Code's `/code-review`) — `rr` exists for what a single vendor can't give
+you: a second opinion from a *different* vendor's model, in one command, from any
+shell, editor, agent, or CI.
+
+`rr` is deliberately **not a PR bot**. It reviews before you push — the point is
+that the issues get fixed before a PR exists. It posts nothing anywhere; if you
+want PR comments, pipe the `--json` envelope into whatever posts them.
+
+## What a review looks like
+
+Reviewing an uncommitted diff that quietly breaks a billing invariant
+(`rr --diff`, abridged):
+
+```
+[HIGH] billing.py — `split_evenly` no longer preserves the input total
+> The documented contract says the returned list "always sums to exactly
+> `total_cents`," but the new implementation rounds one share and repeats it.
+> For inputs like `split_evenly(100, 3)` it returns `[33, 33, 33]`, summing to 99.
+> Suggested fix:
+    base = total_cents // n
+    parts = [base] * n
+    for i in range(total_cents - base * n):
+        parts[i] += 1
+    return parts
+
+- Change Assessment: Do not merge
+- Top Issues: The changed implementation loses cents and breaks the documented
+  remainder allocation contract.
+```
+
+The reviewer read the function's docstring and reasoned about its contract before
+flagging the regression — not a pattern match on the diff.
+
+## Why
+
+- **Cross-vendor review** — the model that wrote the code shouldn't be the only one
+  grading it: a model reviewing its own output inherits its own blind spots, and a
+  vendor's built-in reviewer is always the same family that wrote the code. Implement
+  with Claude, review with GPT; implement with Codex, review with Claude; or
+  `--backend codex,claude` fans out to both and shows you where they disagree.
+- **Plans are reviewable too** — `rr plan.md` stress-tests a design doc *before*
+  you build it. Most review tools only understand diffs.
+- **Standards-aware** — `--docs` auto-discovers `llms.txt`, `AGENTS.md`, or
+  `CLAUDE.md` (or takes explicit paths) and the reviewer flags deviations from
+  *your* documented rules, not generic style opinions.
+- **CI-gateable** — `--json --fail-on high` exits 2 when a high-severity finding
+  lands. Pipe the envelope to `jq` or your bot of choice.
+
+## Install
+
+```bash
+pipx install rocket-review
+```
+
+Or the latest from source:
+
+```bash
+pipx install git+https://github.com/ledger-rocket/rocket-review.git
+```
+
+Requires Python 3.13+ and at least one backend:
+
+- [Codex CLI](https://github.com/openai/codex) (default backend)
+- [Claude Code](https://claude.com/claude-code) (`--backend claude`)
+- [opencode](https://opencode.ai) (`--backend opencode` — any provider, including local models; **experimental**, see below)
+- or none of the above: `--backend api` (or the `--api` shorthand) calls the OpenAI API directly — set `OPENAI_API_KEY` and install the SDK extra: `pipx install 'rocket-review[api]'` (or `pipx inject rocket-review openai` into an existing install)
+
+`--pr` also needs the [gh CLI](https://cli.github.com).
+
+## Usage
+
+```bash
+rr plan.md                        # stress-test a plan before building
+rr --diff                         # review uncommitted changes
+rr --staged                       # review staged changes only
+rr --commit abc1234               # review a commit
+rr --pr 123                       # review a GitHub PR (number, URL, or branch)
+rr --pr 123 --repo acme/api-server  # ...from outside that repo's checkout
+git diff HEAD~3 | rr              # pipe anything
+rr src/auth.py --docs             # review files against your documented standards
+```
+
+### Pick your reviewer
+
+```bash
+rr --diff --backend claude                     # Claude reviews (read-only sandbox)
+rr --diff --backend opencode:ollama/qwen3      # fully local (opencode → Ollama)
+rr --diff --backend codex,claude               # both, side by side
+rr --diff --backend codex:gpt-5.6-sol,claude:claude-opus-4-8
+rr --diff --effort high                        # more reasoning effort (per-backend flag)
+```
+
+Model names: the codex backend passes no `-m`, so it honors your codex default
+(set `model` in `~/.codex/config.toml`). On ChatGPT plans use `gpt-5.6-sol`, the
+ChatGPT-account-accessible 5.6 variant — codex signed into a ChatGPT account rejects
+the bare `gpt-5.6` alias and `gpt-5.6-codex`. The `--backend api` path (API-key auth)
+defaults to `gpt-5.6-terra` — balanced cost/quality. Use `--model gpt-5.6-sol` for
+max quality (flagship pricing) or `gpt-5.6-luna` for the cheapest tier. rr always
+uses explicit, suffixed model names and never relies on the bare `gpt-5.6` alias,
+which points at the flagship today but can be remapped by OpenAI.
+Use `--effort` to set reasoning effort; values differ per backend (codex/api accept
+e.g. `minimal|low|medium|high`, claude `low|medium|high|xhigh|max`) and an unsupported
+value fails loudly at the backend. opencode has no effort flag, so `--effort` errors
+if opencode is among the selected backends. Heavy `--effort high` reviews — especially
+on reasoning models — can outrun the default 900s (15 min) subprocess timeout; raise it
+with `--timeout 1800`.
+
+The Codex and Claude backends run agentically in read-only mode: they navigate your
+project — imports, tests, related files — before judging. That context is what makes the
+review worth reading. The `api` backend is the exception — it calls the OpenAI API
+directly on the supplied content plus any files it references, without navigating your
+project.
+
+> **opencode is experimental.** The integration works, but end-to-end review
+> reliability depends on the provider you have configured, and non-interactive
+> `opencode run` can restrict the read-only `plan` agent's tools. `rr` materializes the
+> diff and feeds the prompt to opencode on stdin so it always reviews the real change,
+> but for a gated CI check prefer `codex` or `claude`. The local-model value prop stands
+> — point opencode at Ollama to keep everything on your machine — just verify its output
+> before trusting it as a gate.
+
+### Structured output
+
+```bash
+rr --diff --json | jq '.findings[] | {severity, title, backend}'
+rr --staged --json --fail-on high && git commit   # block the commit on high+ findings
+```
+
+Every finding carries `severity, title, file, line, why, fix, backend, model`.
+The envelope leads with a `summary` block — `findings_total`, per-severity counts
+(explicit zeros for absent severities), `worst_severity`, per-backend verdicts, and
+the `gate` result when `--fail-on` is set — so an agent gets the counts and the
+gate answer without parsing the findings array. Backend output over 4000 chars is
+truncated inline — `raw` keeps the head plus a marker naming the full length — so the
+envelope stays bounded and no review text (which may quote proprietary code) is written
+to disk; pass `--full` to inline the untruncated output instead. Parse failures and
+backend errors fail the gate closed.
+
+## Review modes
+
+- `plan` — auto-detected for `.md`/`.txt`/`.plan` files: completeness, ordering, risks, over-engineering.
+- `code` — source files: correctness, security, performance, maintainability.
+- `diff` — for `--diff`/`--staged`/`--commit`/`--pr`/stdin: bugs introduced, missing changes, contract breaks.
+
+Override with `--mode`, add focus with `--prompt "check the locking"`.
+
+## Project standards (`--docs`)
+
+Point the reviewer at your project's standards docs — it flags deviations from
+*your* documented rules:
+
+```bash
+rr src/auth.py --docs                     # auto-discovers llms.txt / AGENTS.md / CLAUDE.md
+rr src/auth.py --docs docs/standards.md docs/smells.md
+```
+
+Relative markdown links inside the docs are followed one level, so an index file
+(like `llms.txt`) pulls in everything it references. Bare `--docs` errors if none of
+`llms.txt` / `AGENTS.md` / `CLAUDE.md` exist in the current directory — pass explicit
+paths when your standards live elsewhere. `--llms [PATH]` is kept as a compatibility
+alias for `--docs [PATH]`, defaulting to `llms.txt`.
+
+## How it works
+
+`rr` assembles a review prompt — a mode-specific rubric, your standards docs, and
+the plan or diff under review — and hands it to an agentic CLI (Codex, Claude Code,
+or opencode) running read-only inside your project. Because the reviewer runs
+*in* your checkout, it can open imports, tests, and related files to understand
+context before it judges, rather than reasoning from the diff alone. It then
+returns either prose or a parsed findings envelope (`--json`). There is no
+rocket-review server in the loop: the only thing that leaves your machine is the
+review request — the diff or plan, your standards docs, and any files the reviewer
+opens — sent to whichever backend and provider you chose. Point `rr` at a local
+opencode/Ollama model to keep everything on your machine.
+
+## Security & data flow
+
+`rr` runs the reviewer in a **read-only sandbox** (no writes to your files), but
+read-only is not the same as safe:
+
+- Your code leaves your machine. Each review sends the diff/plan, your standards
+  docs, and any files the reviewer opens to **that backend's provider** — codex/api →
+  OpenAI, claude → Anthropic, opencode → whichever provider you configured (point it
+  at a local Ollama model to keep everything on your machine).
+- Read-only stops *writes*, not *reads*. An agent can still read any secret your shell
+  can (`.env`, `~/.aws`, tokens) and send it upstream.
+- Untrusted input can prompt-inject the reviewer — a hostile PR body, diff, comment,
+  or `AGENTS.md` can try to steer an agentic backend. Be especially careful with `--pr`
+  on a dev machine.
+
+**Don't run agentic backends against untrusted repos or PRs on a machine where readable
+secrets exist.** See [SECURITY.md](SECURITY.md) for the full threat model and how to
+report a vulnerability.
+
+## Requirements
+
+- **Python** ≥ 3.13
+- **OS** — macOS or Linux
+- **A backend CLI**, installed and authenticated — you only need the one(s) you use:
+  - `codex` — [Codex CLI](https://github.com/openai/codex), signed in with your ChatGPT/OpenAI account
+  - `claude` — [Claude Code](https://claude.com/claude-code), on a Claude subscription or API key. Needs a version supporting `--permission-mode manual` (Claude Code 2.1.x+); older CLIs fail the review closed with a usage error. Check with `claude --help | grep -A3 permission-mode`.
+  - `opencode` — [opencode](https://opencode.ai), configured for any provider (including a local Ollama model)
+  - `api` — no CLI, but needs the OpenAI SDK (`pipx install 'rocket-review[api]'`, or `pipx inject rocket-review openai`); set `OPENAI_API_KEY` and `rr` calls the OpenAI API directly
+- `gh` CLI, authenticated, for `--pr`
+
+## Agent integration
+
+Drop into your `CLAUDE.md` / `AGENTS.md`:
+
+```markdown
+Before pushing non-trivial changes, run `rr --diff --docs` and address the findings.
+For plans, run `rr plan.md --docs` before implementing. Use a 900000ms timeout.
+```
+
+## Notes
+
+- Every backend runs in a read-only sandbox on your project — **no writes**: Codex
+  runs with `-s read-only`, Claude Code with a read-only tool allowlist under
+  `--permission-mode manual`, and opencode with its built-in read-only `plan` agent
+  (edit/write denied at the tool level). Read-only stops writes; it does not stop the
+  agent *reading* readable secrets and sending them to the backend's provider — see
+  [Security & data flow](#security--data-flow).
+- `--fail-on` requires `--json`.
+- Exit codes: 0 no gate tripped · 1 operational error (or every backend failed) · 2 findings at/above `--fail-on`. A partial backend failure warns on stderr but still exits 0 — gate CI with `--json --fail-on` to fail closed.
+
+## Contributing
+
+Issues and PRs are welcome. To set up a dev environment:
+
+```bash
+python3 -m venv .venv
+.venv/bin/pip install -e ".[dev]"
+.venv/bin/pytest -q                  # run the tests
+.venv/bin/ruff check .               # lint
+.venv/bin/mypy rocket_review/        # type-check
+.venv/bin/yamllint .                 # yaml lint
+```
+
+CI gates all four plus a package build — run them before opening a PR.
+
+## License
+
+Apache-2.0 licensed. See [LICENSE](LICENSE).