[docs] - document the real-repo-run-plan two-stage cloud-plan recipe - #806
Draft
cgfixit wants to merge 1 commit into
Draft
[docs] - document the real-repo-run-plan two-stage cloud-plan recipe#806cgfixit wants to merge 1 commit into
cgfixit wants to merge 1 commit into
Conversation
…ecipe The "cloud model plans once, local Qwen implements iteratively" design is real and functional (real_repo_loop.py's generate_plan() feeds --plan-file text into every run_real_repo_loop iteration's prompt, pinned by tests/test_agentic_plan_handoff.py) but was undocumented anywhere operator- facing -- AGENTIC_README.md's Commands section and full write-up never mentioned real-repo-run-plan or --plan-file, and CLAUDE.md's module-table row named only the bare fact of a cloud planner without naming the subcommand or disambiguating that --provider means something different on real-repo-run (drives every loop iteration) vs. real-repo-run-plan (one-shot only). Add a real-repo-run-plan example to AGENTIC_README.md's command block, a "Two-stage: plan with cloud, implement locally" explainer in §9 (paraphrasing generate_plan()'s own docstring, previously the only place this rationale existed), and an explicit warning against combining --plan-file with --provider on the run step, since doing so silently defeats the two-stage economics with no warning from the CLI. Update CLAUDE.md's module-table row to name real-repo-run-plan and point to the new explainer. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FW9QmnLBGyPu8QvJQ897hf
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed changes
The "cloud model plans once, local Qwen implements iteratively" design in
agentic/real_repo_loop.pyis real and functional —generate_plan()'s output, saved and passed via--plan-file, is read intorun_real_repo_loop'splanparameter and folded into every iteration's prompt ahead of any GitHub context (pinned bytests/test_agentic_plan_handoff.py). But it was undocumented anywhere operator-facing:docs/agentic/AGENTIC_README.md's Commands section and its full "Governed GitHub coding harness" write-up (§9) never mentioned thereal-repo-run-plansubcommand or--plan-fileat all, andCLAUDE.md's module-table row named only the bare fact of "an optional cloud planner behind--provider/--confirm-online" with no disambiguation.That disambiguation matters:
--providermeans something different depending on which subcommand carries it —real-repo-run-plan, it drives only the one-shot plan call;real-repo-runitself, it drives every iteration of the whole loop — the cloud model proposes every patch attempt, not just the plan.The two flags are read independently with zero cross-check. Passing
--providerto both calls is allowed and does something real (the plan text still reaches the prompt) but silently defeats the two-stage economicsgenerate_plan()'s own docstring states as the whole point ("frontier reasoning is worth paying for once per task, not once per failed iteration") — with no warning from the CLI either way.Adds:
real-repo-run-planexample toAGENTIC_README.md's Commands block, alongside the existing plainreal-repo-runexample.generate_plan()'s own docstring (previously the only place this design rationale existed anywhere), plus the explicit--provider-on-both-calls warning above.CLAUDE.mdmodule-table row namingreal-repo-run-planand pointing to the new explainer instead of just naming the shared--provider/--confirm-onlinevocabulary.Invariant / Governance Impact: None. Pure documentation; no code, config, or graph topology touched. Does not claim any wiring exists that doesn't — the recipe is confirmed CLI-only as of this writing (the harness console's
/api/agent/runhas no--provider/--plan-fileequivalent), and the doc says so rather than implying otherwise.Types of changes
Scope note: Docs only.
Benefits / why
Makes a real, already-working capability actually discoverable and usable correctly. Before this, an operator would have to read
generate_plan()'s Python docstring directly to learn this design exists at all, and had no warning against the one combination (--provideron both calls) that silently defeats its entire economic rationale.Risks to monitor
None expected — additive documentation only, no behavior change. If a future change alters
--provider's per-subcommand semantics or removes the orthogonality between--plan-file/--provider, this doc (andCLAUDE.md's pointer to it) will need a matching update.Checklist
doc_sync.py(0 drift) +invariant-guard(33/0) both clean; not a Python change so no pytest run required.Generated by Claude Code