docs(AGENTS): build/test/run notes (salvaged from #3)#7
Merged
Conversation
Folds the generally-useful run notes from the Cursor Cloud setup PR (#3) into the existing AGENTS.md: the offline plan-pr / --plan-only flow, --scored for local input, live-command credentials, and the ~/.cursor canvas-mirror flag. Corrects #3's now-stale gotcha — plan-pr is plan-only by design on main (cli.ts dispatches planOnly: true) — and notes prebuild auto-cleans dist. Drops #3's package-lock change, since main standardized on the npmjs registry in #6.
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
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
1 participant
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.
What
Salvages the generally-useful run notes from #3 (the Cursor Cloud dev-env PR) into the existing
AGENTS.md, and supersedes it.Changes
AGENTS.md.Why not just merge #3
AGENTS.md(now exists) andpackage-lock.json.plan-pr/--plan-onlygotcha is stale: onmain,plan-prdispatchesplanOnly: true(cli.ts:61-62) — it's plan-only by design. Documented the correct behavior here.package-lock.jsonchange keptregistry.npmmirror.com; dropped, since docs: document npm overrides + standardize npm registry #6 standardized on npmjs.Supersedes #3.
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only change to AGENTS.md with no runtime or dependency impact.
Overview
Extends
AGENTS.mdwith contributor/agent runbook content salvaged from the superseded #3 PR, without touching code or lockfiles.A new Build, test & run section documents the TypeScript CLI workflow (
npm run build/test/typecheck,prebuildcleaningdist/, invoking vianode dist/src/cli.js). It clarifiesplan-pris plan-only by design (DAG/state/report/Canvas without Cursor Cloud), optional--scoredfor fully offline runs,--plan-onlyon lower-level commands, which commands needCURSOR_API_KEYandgh, gracefulERROR/SKIPPEDwhen credentials are missing, and.quorum/artifacts.A short Cursor Cloud section notes startup
npm installand--no-canvas-mirrorfor offline/CI so runs avoid writing under~/.cursor.Reviewed by Cursor Bugbot for commit c9d2324. Bugbot is set up for automated code reviews on this repo. Configure here.