projscan 4.1.0 → 4.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +173 -25
- package/dist/cli/commands/start.js +1022 -2
- package/dist/cli/commands/start.js.map +1 -1
- package/dist/core/start.js +1045 -8
- package/dist/core/start.js.map +1 -1
- package/dist/projscan-sbom.cdx.json +6 -6
- package/dist/tool-manifest.json +2 -2
- package/dist/types.d.ts +192 -0
- package/docs/GUIDE.md +3 -1
- package/docs/demos/projscan-4-1-demo.html +94 -65
- package/docs/projscan-mission-control.png +0 -0
- package/docs/projscan-proof-router.png +0 -0
- package/package.json +1 -1
- package/scripts/capture-readme-assets.mjs +1 -1
package/README.md
CHANGED
|
@@ -33,17 +33,17 @@ The local plugin platform lets teams add project-specific findings and render `d
|
|
|
33
33
|
npx projscan
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.
|
|
36
|
+
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.2.0/docs/projscan-reporter-plugin.gif" alt="projscan doctor rendered through a local reporter plugin in a macOS-style terminal window" width="700">
|
|
37
37
|
|
|
38
|
-
## What's New in 4.
|
|
38
|
+
## What's New in 4.2.0
|
|
39
39
|
|
|
40
|
-
4.
|
|
40
|
+
4.2.0 turns Mission Control into a runnable handoff system: tell projscan the work, then get the next command, MCP call, proof queue, review gate, and saved bundle an agent can resume.
|
|
41
41
|
|
|
42
|
-
- **
|
|
43
|
-
- **
|
|
44
|
-
- **
|
|
45
|
-
- **
|
|
46
|
-
- **
|
|
42
|
+
- **Execution plans with a cursor.** `projscan start --intent "<goal>"` now returns ordered phases, blocked inputs, follow-ups, done criteria, and a current cursor so agents know what to run next.
|
|
43
|
+
- **Copyable shortcuts for humans and MCP clients.** Use `--next-command`, `--next-tool-call`, `--proof-commands`, `--checklist`, `--resume-json`, `--handoff-json`, `--task-card`, and `--runbook` when you need one surface instead of the full report.
|
|
44
|
+
- **Saved mission bundles.** `--save-mission <dir>` writes a runnable bundle with `mission.sh`, `status.sh`, `review.sh`, quick commands, manifest metadata, prompts, JSON handoff files, proof logs, run reports, and `summary.json`.
|
|
45
|
+
- **Stop-and-review gates.** Mission Control now carries review policy, worktree evidence, proof queues, done criteria, reviewer decisions, and copyable reply text so agents stop before another slice, release, publish, deploy, push, merge, or version bump.
|
|
46
|
+
- **Safer shell handoffs.** Generated commands and saved mission scripts now escape `$` and backticks in freeform intent text, so copied commands treat developer goals as literal arguments.
|
|
47
47
|
|
|
48
48
|
<img src="docs/projscan-proof-router.png" alt="projscan intent router and proof workflow showing impact routing, setup discovery, dependency intelligence, and stable-surface guardrails" width="760">
|
|
49
49
|
|
|
@@ -53,13 +53,143 @@ Regenerate the README screenshots with Playwright:
|
|
|
53
53
|
npm run docs:screenshots
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
+
## Mission Execution Plan + Copyable Handoffs
|
|
57
|
+
|
|
58
|
+
`projscan start --intent "<goal>"` gives agents an execution plan with ordered phases, ready commands, blocked inputs, follow-ups, proof, and done criteria. The cursor points to the next useful step and includes MCP `tool` / `args` when projscan can call it directly.
|
|
59
|
+
|
|
60
|
+
Projscan also returns a Markdown runbook, a task card, a review gate, and a resume object. A resumed agent gets the current command, the MCP tool call, placeholder bindings, follow-up templates, the ordered checklist, and the remaining proof queue without walking the full plan. MCP and JSON clients can read `missionControl.taskCard.markdown`, the same Markdown printed by `--task-card` and written to `task-card.md`. They can also read `missionControl.reviewGate.markdown` to know when to stop, report proof, and wait for approval before starting another slice, release, publish, or deploy. `missionControl.reviewGate.worktree` adds the current worktree evidence summary and visible changed files, so review handoffs keep the state projscan computed for the start report. `missionControl.reviewGate.proof` carries the remaining proof queue with commands, MCP calls, and structured proof items for review-only handoffs. `missionControl.reviewGate.doneWhen` mirrors the mission success criteria, so review-only handoffs show the approval target beside proof and worktree evidence. `missionControl.reviewGate.policy` lists the actions blocked until explicit reviewer approval: another slice, release, publish, deploy, push, merge, and version bump. `--review-gate-json` and saved `review-gate.json` expose the full review packet without requiring callers to parse the full handoff. `--review-policy` and saved `review-policy.json` expose only the approval boundary. `missionControl.reviewGate.decisions` gives the reviewer the allowed next choices and copyable reply text: approve another slice, request changes, or review a version candidate without publishing; the same menu appears in default console output, saved bundle README files, task cards, handoff prompts, and runbook Markdown. `--review-replies` and saved `review-replies.txt` print only those reply lines when a reviewer wants the smallest approval surface. The complete handoff object carries the same gate at `missionControl.handoff.reviewGate`, so `--handoff-json` and saved `handoff.json` include the stop boundary.
|
|
61
|
+
|
|
62
|
+
Use the index when you want the menu, or call one shortcut directly:
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
projscan start --shortcuts --intent "<goal>" # Show the shortcut menu
|
|
66
|
+
projscan start --shortcuts-json --intent "<goal>" # Shortcut menu as JSON
|
|
67
|
+
projscan start --next-command --intent "<goal>" # Current shell command
|
|
68
|
+
projscan start --next-tool-call --intent "<goal>" # Current MCP call as compact JSON
|
|
69
|
+
projscan start --ready-tool-calls --intent "<goal>" # Current + proof MCP calls
|
|
70
|
+
projscan start --proof-commands --intent "<goal>" # Remaining proof commands
|
|
71
|
+
projscan start --checklist --intent "<goal>" # Ordered resume task card
|
|
72
|
+
projscan start --resume-json --intent "<goal>" # Structured resume object
|
|
73
|
+
projscan start --handoff-json --intent "<goal>" # Complete handoff object
|
|
74
|
+
projscan start --mission-script --intent "<goal>" # Shell script: current step + proof
|
|
75
|
+
projscan start --save-mission .projscan/mission --intent "<goal>" # Write bundle + quickstart
|
|
76
|
+
projscan start --task-card --intent "<goal>" # Paste-ready Markdown task card
|
|
77
|
+
projscan start --review-gate --intent "<goal>" # Stop-and-review gate
|
|
78
|
+
projscan start --review-gate-json --intent "<goal>" # Review gate JSON
|
|
79
|
+
projscan start --review-policy --intent "<goal>" # Review policy JSON
|
|
80
|
+
projscan start --review-replies --intent "<goal>" # Copy-only reviewer replies
|
|
81
|
+
projscan start --runbook --intent "<goal>" # Markdown mission runbook
|
|
82
|
+
projscan start --handoff-prompt --intent "<goal>" # One-line handoff prompt
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Saved mission bundles include `README.md`, `next-command.txt`, `next-tool-call.json`, `handoff-prompt.txt`, `resume-prompt.txt`, `task-card.md`, `review-gate.md`, `review-gate.json`, `review-policy.json`, `review-replies.txt`, the Markdown runbook, structured handoff/resume JSON, `ready-tool-calls.json`, `shortcuts.json`, `mission.sh`, `status.sh`, `review.sh`, `proof-logs/README.md`, `proof-logs/status.jsonl`, `proof-logs/run-report.md`, `proof-logs/summary.json`, proof commands, and a manifest. The saved bundle README starts with quick commands for `./mission.sh`, `./status.sh`, and `./review.sh`; `manifest.json` exposes the same quick commands under `quickCommands` for agents and JSON clients. Running saved `mission.sh` writes current and proof command output under `proof-logs/`, appends exit codes to `status.jsonl`, refreshes `run-report.md` for review, and writes the latest run state plus next action to `summary.json` for agents. Run `./status.sh` from the bundle to print the latest mission state and next action; it exits `0` for passed, `1` for failed, and `2` for not-run or running states. Run `./review.sh` from the bundle to print the status, review gate, run report, evidence command checklist, and reviewer replies in one terminal view.
|
|
86
|
+
|
|
87
|
+
Default console output shows the same sections inline: `Run Cursor`, `Resume Checklist`, `Handoff Prompt`, `Ready Proof`, and `Proof Queue`. The proof views use the resume-aware remaining queue, so projscan does not repeat the current cursor command as proof.
|
|
88
|
+
|
|
89
|
+
Console output shows the same model for humans:
|
|
90
|
+
|
|
91
|
+
```text
|
|
92
|
+
Execution Plan
|
|
93
|
+
Run 1 ready step, resolve 2 input(s), then gather 4 proof command(s).
|
|
94
|
+
- [ready] Next Action
|
|
95
|
+
- Find exact target for impact analysis: projscan search "auth token loader" --format json
|
|
96
|
+
- [blocked] Resolve Inputs
|
|
97
|
+
- symbol: Replace <symbol-from-search> with an exported symbol returned by the search step.
|
|
98
|
+
- [pending] Follow Up
|
|
99
|
+
- If search returns an exported symbol: projscan impact --symbol <symbol-from-search> --format json
|
|
100
|
+
blocked by: input-1
|
|
101
|
+
Run Cursor
|
|
102
|
+
next: ready-1 in Ready Commands
|
|
103
|
+
command: projscan search "auth token loader" --format json
|
|
104
|
+
MCP call: projscan_search {"query":"auth token loader"}
|
|
105
|
+
unlocks: input-1, input-2
|
|
106
|
+
Resume Checklist
|
|
107
|
+
- [ready] run_current ready-1: projscan search "auth token loader" --format json (MCP: projscan_search {"query":"auth token loader"})
|
|
108
|
+
- [blocked] resolve_input input-1: <symbol-from-search> -> Replace <symbol-from-search> with an exported symbol returned by the search step.
|
|
109
|
+
- [blocked] run_follow_up follow-up-1: projscan impact --symbol <symbol-from-search> --format json (MCP: projscan_impact {"symbol":"<symbol-from-search>"})
|
|
110
|
+
- [ready] run_proof proof-2: projscan preflight --mode before_edit --format json (MCP: projscan_preflight {"mode":"before_edit"})
|
|
111
|
+
Handoff Prompt
|
|
112
|
+
Resume: Resume at ready-1 in ready_now: run `projscan search "auth token loader" --format json`. This can unlock input-1 (symbol), input-2 (file). Done when: An exact symbol or file path is selected from search results before impact analysis continues.
|
|
113
|
+
Ready Proof
|
|
114
|
+
Ready-to-run proof commands; placeholder follow-ups are excluded until Needs Input is resolved.
|
|
115
|
+
- projscan preflight --mode before_edit --format json
|
|
116
|
+
- projscan understand --view verify --format json
|
|
117
|
+
Proof Queue
|
|
118
|
+
- proof-2: projscan preflight --mode before_edit --format json (MCP: projscan_preflight {"mode":"before_edit"})
|
|
119
|
+
- proof-3: projscan understand --view verify --format json (MCP: projscan_understand {"view":"verify"})
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
Runbook handoff example:
|
|
123
|
+
|
|
124
|
+
```text
|
|
125
|
+
Agent Runbook
|
|
126
|
+
# Mission Runbook
|
|
127
|
+
Intent: what breaks if I rename the auth token loader
|
|
128
|
+
Status: needs_attention
|
|
129
|
+
Current phase: ready_now
|
|
130
|
+
|
|
131
|
+
## Current Cursor
|
|
132
|
+
- Step: ready-1 in ready_now
|
|
133
|
+
- Command: `projscan search "auth token loader" --format json`
|
|
134
|
+
- MCP call: projscan_search {"query":"auth token loader"}
|
|
135
|
+
- Unlocks: input-1, input-2
|
|
136
|
+
|
|
137
|
+
## Resume
|
|
138
|
+
Run now:
|
|
139
|
+
```sh
|
|
140
|
+
projscan search "auth token loader" --format json
|
|
141
|
+
```
|
|
142
|
+
MCP call: projscan_search {"query":"auth token loader"}
|
|
143
|
+
After running, resolve:
|
|
144
|
+
- input-1 (symbol): Replace <symbol-from-search> with an exported symbol returned by the search step.
|
|
145
|
+
- input-2 (file): Replace <file-from-search> with a file path returned by the search step.
|
|
146
|
+
Template inputs:
|
|
147
|
+
- <symbol-from-search> -> input-1 (symbol): Replace <symbol-from-search> with an exported symbol returned by the search step.
|
|
148
|
+
- <file-from-search> -> input-2 (file): Replace <file-from-search> with a file path returned by the search step.
|
|
149
|
+
Resume checklist:
|
|
150
|
+
- [ready] run_current ready-1: projscan search "auth token loader" --format json (MCP: projscan_search {"query":"auth token loader"})
|
|
151
|
+
- [blocked] resolve_input input-1: <symbol-from-search> -> Replace <symbol-from-search> with an exported symbol returned by the search step.
|
|
152
|
+
- [ready] run_proof proof-2: projscan preflight --mode before_edit --format json (MCP: projscan_preflight {"mode":"before_edit"})
|
|
153
|
+
- [pending] confirm_done criterion-1: An exact symbol or file path is selected from search results before impact analysis continues.
|
|
154
|
+
Proof queue:
|
|
155
|
+
- proof-2: `projscan preflight --mode before_edit --format json` (MCP: projscan_preflight {"mode":"before_edit"})
|
|
156
|
+
- proof-3: `projscan understand --view verify --format json` (MCP: projscan_understand {"view":"verify"})
|
|
157
|
+
Remaining proof:
|
|
158
|
+
- `projscan preflight --mode before_edit --format json`
|
|
159
|
+
- `projscan understand --view verify --format json`
|
|
160
|
+
MCP proof calls:
|
|
161
|
+
- proof-2: projscan_preflight {"mode":"before_edit"}
|
|
162
|
+
- proof-3: projscan_understand {"view":"verify"}
|
|
163
|
+
Then use:
|
|
164
|
+
- follow-up-1 (If search returns an exported symbol): projscan impact --symbol <symbol-from-search> --format json
|
|
165
|
+
- follow-up-2 (If search returns a file path): projscan impact <file-from-search> --format json
|
|
166
|
+
Prompt: Resume at ready-1 in ready_now: run `projscan search "auth token loader" --format json`. This can unlock input-1 (symbol), input-2 (file).
|
|
167
|
+
|
|
168
|
+
## Handoff Prompt
|
|
169
|
+
Resume: Resume at ready-1 in ready_now: run `projscan search "auth token loader" --format json`. This can unlock input-1 (symbol), input-2 (file). Done when: An exact symbol or file path is selected from search results before impact analysis continues. Needs input: symbol=<symbol-from-search>, file=<file-from-search>. Ready proof: Ready-to-run proof commands; placeholder follow-ups are excluded until Needs Input is resolved. projscan preflight --mode before_edit --format json && projscan understand --view verify --format json.
|
|
170
|
+
|
|
171
|
+
## Review Gate
|
|
172
|
+
- [ ] Complete this task card and remaining proof.
|
|
173
|
+
- [ ] Capture `git status --short`.
|
|
174
|
+
- [ ] Capture `git diff --stat`.
|
|
175
|
+
- [ ] Stop and ask for approval before starting another slice, release, publish, or deploy.
|
|
176
|
+
|
|
177
|
+
Review the completed mission, proof output, and working-tree summary before approving another slice, release, publish, or deploy.
|
|
178
|
+
|
|
179
|
+
## Ready Commands
|
|
180
|
+
- `projscan search "auth token loader" --format json`
|
|
181
|
+
|
|
182
|
+
## Blocked Inputs
|
|
183
|
+
- symbol: Replace <symbol-from-search> with an exported symbol returned by the search step.
|
|
184
|
+
```
|
|
185
|
+
|
|
56
186
|
Run `projscan doctor` for a focused health check:
|
|
57
187
|
|
|
58
188
|
```bash
|
|
59
189
|
npx projscan doctor
|
|
60
190
|
```
|
|
61
191
|
|
|
62
|
-
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.
|
|
192
|
+
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.2.0/docs/npx%20projscan%20doctor.gif" alt="npx projscan doctor" width="700">
|
|
63
193
|
|
|
64
194
|
## Install
|
|
65
195
|
|
|
@@ -392,9 +522,9 @@ npm run test:trust-smoke
|
|
|
392
522
|
|
|
393
523
|
The full command catalog is below. Most users should start with the five-command path above instead of scanning the catalog.
|
|
394
524
|
|
|
395
|
-
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.
|
|
525
|
+
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.2.0/docs/npx%20projscan%20--help.gif" alt="npx projscan --help" width="700">
|
|
396
526
|
|
|
397
|
-
For a comprehensive walkthrough, see the **[Full Guide](https://github.com/abhiyoheswaran1/projscan/blob/v4.
|
|
527
|
+
For a comprehensive walkthrough, see the **[Full Guide](https://github.com/abhiyoheswaran1/projscan/blob/v4.2.0/docs/GUIDE.md)**.
|
|
398
528
|
|
|
399
529
|
## Repo Understanding
|
|
400
530
|
|
|
@@ -416,7 +546,7 @@ The report includes file/symbol-backed `claims`, `readFirst` files, entrypoints,
|
|
|
416
546
|
|---------|-------------|
|
|
417
547
|
| `projscan analyze` | Full analysis - languages, frameworks, dependencies, issues |
|
|
418
548
|
| `projscan route` | Map a plain-language goal to the best projscan tool with weighted confidence and matched keywords |
|
|
419
|
-
| `projscan start` | First-60-seconds workflow orientation with setup diagnostics, Mission Control, top risks, and next commands. Add `--intent "<goal>"` to route a plain-language goal to route confidence, ready actions, done criteria, and proof commands |
|
|
549
|
+
| `projscan start` | First-60-seconds workflow orientation with setup diagnostics, Mission Control, top risks, and next commands. Add `--intent "<goal>"` to route a plain-language goal to route confidence, phased execution plan, ready actions, done criteria, and proof commands |
|
|
420
550
|
| `projscan first-run` | First-run setup diagnostics plus the shared `firstTenMinutes` command path |
|
|
421
551
|
| `projscan init mcp` | Ready-to-paste MCP client configs for popular agent clients |
|
|
422
552
|
| `projscan mcp doctor` | Verify MCP setup and print paste-ready client config with checks |
|
|
@@ -475,25 +605,25 @@ projscan --help
|
|
|
475
605
|
<details>
|
|
476
606
|
<summary><strong>projscan structure</strong> - Directory tree with file counts</summary>
|
|
477
607
|
|
|
478
|
-
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.
|
|
608
|
+
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.2.0/docs/npx%20projscan%20structure.gif" alt="npx projscan structure" width="700">
|
|
479
609
|
</details>
|
|
480
610
|
|
|
481
611
|
<details>
|
|
482
612
|
<summary><strong>projscan diagram</strong> - Architecture visualization</summary>
|
|
483
613
|
|
|
484
|
-
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.
|
|
614
|
+
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.2.0/docs/npx%20projscan%20diagram.gif" alt="npx projscan diagram" width="700">
|
|
485
615
|
</details>
|
|
486
616
|
|
|
487
617
|
<details>
|
|
488
618
|
<summary><strong>projscan dependencies</strong> - Dependency analysis</summary>
|
|
489
619
|
|
|
490
|
-
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.
|
|
620
|
+
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.2.0/docs/npx%20projscan%20dependencies.gif" alt="npx projscan dependencies" width="700">
|
|
491
621
|
</details>
|
|
492
622
|
|
|
493
623
|
<details>
|
|
494
624
|
<summary><strong>projscan badge</strong> - Health badge generation</summary>
|
|
495
625
|
|
|
496
|
-
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.
|
|
626
|
+
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.2.0/docs/npx%20projscan%20badge.gif" alt="npx projscan badge" width="700">
|
|
497
627
|
</details>
|
|
498
628
|
|
|
499
629
|
### Output Formats
|
|
@@ -515,7 +645,7 @@ Run `projscan help` for the generated command-by-command support matrix.
|
|
|
515
645
|
|
|
516
646
|
projscan can load local plugins from `.projscan-plugins/` when `PROJSCAN_PLUGINS_PREVIEW=1` is set. The environment flag is kept for explicit local-code opt-in. Analyzer plugins emit normal projscan issues; reporter plugins render supported CLI commands with team-specific output.
|
|
517
647
|
|
|
518
|
-
**2.0 upgrade notes:** migrating from 1.x or authoring plugins? Start with the [2.0 Migration Guide](https://github.com/abhiyoheswaran1/projscan/blob/v4.
|
|
648
|
+
**2.0 upgrade notes:** migrating from 1.x or authoring plugins? Start with the [2.0 Migration Guide](https://github.com/abhiyoheswaran1/projscan/blob/v4.2.0/docs/2.0-MIGRATION.md), then use [Plugin Authoring](https://github.com/abhiyoheswaran1/projscan/blob/v4.2.0/docs/PLUGIN-AUTHORING.md), the [Plugin Gallery](https://github.com/abhiyoheswaran1/projscan/blob/v4.2.0/docs/PLUGIN-GALLERY.md), and the [manifest schema](https://github.com/abhiyoheswaran1/projscan/blob/v4.2.0/docs/plugin.schema.json) as the stable contract.
|
|
519
649
|
|
|
520
650
|
```bash
|
|
521
651
|
projscan plugin list
|
|
@@ -526,9 +656,9 @@ PROJSCAN_PLUGINS_PREVIEW=1 projscan doctor --reporter team-radar
|
|
|
526
656
|
PROJSCAN_PLUGINS_PREVIEW=1 projscan ci --reporter team-radar --min-score 80
|
|
527
657
|
```
|
|
528
658
|
|
|
529
|
-
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.
|
|
659
|
+
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.2.0/docs/projscan-reporter-plugin.gif" alt="projscan local reporter plugin rendering a team health report" width="700">
|
|
530
660
|
|
|
531
|
-
Reporter plugins are intentionally CLI-only. MCP tools keep returning structured JSON-compatible payloads so agents can reason over stable data, while humans can get a polished local report for their team. Custom presentation, team-branded summaries, and white-label reports belong in reporter plugins rather than new core HTML theming flags. See [Plugin Authoring](https://github.com/abhiyoheswaran1/projscan/blob/v4.
|
|
661
|
+
Reporter plugins are intentionally CLI-only. MCP tools keep returning structured JSON-compatible payloads so agents can reason over stable data, while humans can get a polished local report for their team. Custom presentation, team-branded summaries, and white-label reports belong in reporter plugins rather than new core HTML theming flags. See [Plugin Authoring](https://github.com/abhiyoheswaran1/projscan/blob/v4.2.0/docs/PLUGIN-AUTHORING.md) for manifest shape, `render(context)`, validation, and the trust model.
|
|
532
662
|
|
|
533
663
|
### Options
|
|
534
664
|
|
|
@@ -539,6 +669,24 @@ Reporter plugins are intentionally CLI-only. MCP tools keep returning structured
|
|
|
539
669
|
| `--include-ignored` | Explicitly include files hidden by Git ignore rules |
|
|
540
670
|
| `--scan-env-values` | Explicitly read `.env*` contents during secret checks |
|
|
541
671
|
| `--offline` | Block projscan network-capable features for this run |
|
|
672
|
+
| `--shortcuts` | Print the Mission Control shortcut command index (`start`) |
|
|
673
|
+
| `--shortcuts-json` | Print the Mission Control shortcut command index as JSON (`start`) |
|
|
674
|
+
| `--handoff-prompt` | Print only the concise Mission Control handoff prompt (`start`) |
|
|
675
|
+
| `--next-command` | Print only the current Mission Control cursor command (`start`) |
|
|
676
|
+
| `--next-tool-call` | Print only the current Mission Control cursor MCP tool call as JSON (`start`) |
|
|
677
|
+
| `--ready-tool-calls` | Print the current cursor and remaining MCP-callable proof queue as JSON (`start`) |
|
|
678
|
+
| `--proof-commands` | Print only ready Mission Control proof commands (`start`) |
|
|
679
|
+
| `--checklist` | Print only the Mission Control resume checklist (`start`) |
|
|
680
|
+
| `--resume-json` | Print only the Mission Control resume object as JSON (`start`) |
|
|
681
|
+
| `--handoff-json` | Print only the Mission Control handoff object as JSON (`start`) |
|
|
682
|
+
| `--mission-script` | Print the Mission Control shell script (`start`) |
|
|
683
|
+
| `--save-mission <dir>` | Write the Mission Control bundle to a directory (`start`) |
|
|
684
|
+
| `--task-card` | Print only the Mission Control Markdown task card (`start`) |
|
|
685
|
+
| `--review-gate` | Print only the Mission Control stop-and-review gate (`start`) |
|
|
686
|
+
| `--review-gate-json` | Print only the Mission Control review gate as JSON (`start`) |
|
|
687
|
+
| `--review-policy` | Print only the Mission Control review policy as JSON (`start`) |
|
|
688
|
+
| `--review-replies` | Print only copyable Mission Control reviewer replies (`start`) |
|
|
689
|
+
| `--runbook` | Print only the Mission Control Markdown runbook (`start`) |
|
|
542
690
|
| `--changed-only` | Scope to files changed vs base ref (ci/analyze/doctor) |
|
|
543
691
|
| `--base-ref <ref>` | Git base ref for `--changed-only` (default: origin/main) |
|
|
544
692
|
| `--reporter <name>` | Render `doctor`, `analyze`, or `ci` with a local reporter plugin |
|
|
@@ -695,7 +843,7 @@ If you read projscan's [Socket report](https://socket.dev/npm/package/projscan),
|
|
|
695
843
|
### Audit it yourself
|
|
696
844
|
|
|
697
845
|
- **Source is open** at [github.com/abhiyoheswaran1/projscan](https://github.com/abhiyoheswaran1/projscan). The npm tarball matches the `dist/` produced by `npm run build` at the matching tag.
|
|
698
|
-
- **Public API surface is locked** by `scripts/check-stability.mjs`, which runs in CI on every PR and fails on any rename or removal of an MCP tool, CLI command, or exit code. See [`docs/STABILITY.md`](https://github.com/abhiyoheswaran1/projscan/blob/v4.
|
|
846
|
+
- **Public API surface is locked** by `scripts/check-stability.mjs`, which runs in CI on every PR and fails on any rename or removal of an MCP tool, CLI command, or exit code. See [`docs/STABILITY.md`](https://github.com/abhiyoheswaran1/projscan/blob/v4.2.0/docs/STABILITY.md).
|
|
699
847
|
- **Run it offline:** `npm install -g projscan` followed by anything except `audit` and `--mode semantic` works without network.
|
|
700
848
|
- **Drop privilege further:** in CI, run projscan in a sandbox that disallows network egress; everything except `audit` will pass.
|
|
701
849
|
|
|
@@ -746,7 +894,7 @@ projscan ci --changed-only # Gate only on this PR's diff
|
|
|
746
894
|
projscan ci --format sarif > projscan.sarif # SARIF for Code Scanning
|
|
747
895
|
```
|
|
748
896
|
|
|
749
|
-
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.
|
|
897
|
+
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.2.0/docs/npx%20projscan%20ci%20--min-score%2070.gif" alt="npx projscan ci --min-score 70" width="700">
|
|
750
898
|
|
|
751
899
|
### GitHub Action (recommended)
|
|
752
900
|
|
|
@@ -823,7 +971,7 @@ Fields:
|
|
|
823
971
|
- `hotspots.limit` / `hotspots.since` - defaults for the `hotspots` command
|
|
824
972
|
- `monorepo.importPolicy` - cross-package import allow/deny rules in monorepos *(0.14+)*
|
|
825
973
|
|
|
826
|
-
See [`docs/GUIDE.md` -> Configuration](https://github.com/abhiyoheswaran1/projscan/blob/v4.
|
|
974
|
+
See [`docs/GUIDE.md` -> Configuration](https://github.com/abhiyoheswaran1/projscan/blob/v4.2.0/docs/GUIDE.md#configuration-projscanrc) for the full reference (field types, validation behavior, embedding config in `package.json`, monorepo `importPolicy` semantics).
|
|
827
975
|
|
|
828
976
|
## Tracking Health Over Time
|
|
829
977
|
|
|
@@ -836,7 +984,7 @@ projscan diff # Compare against baseline
|
|
|
836
984
|
projscan diff --format markdown # Markdown diff for PRs
|
|
837
985
|
```
|
|
838
986
|
|
|
839
|
-
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.
|
|
987
|
+
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.2.0/docs/npx%20projscan%20diff%20--save-baseline.gif" alt="npx projscan diff --save-baseline" width="700">
|
|
840
988
|
|
|
841
989
|
## Hotspots - Where to Fix First
|
|
842
990
|
|
|
@@ -925,7 +1073,7 @@ Coverage is also automatically joined into `projscan hotspots` when one of those
|
|
|
925
1073
|
|
|
926
1074
|
**This is the primary way to use projscan.** `projscan mcp` starts an [MCP](https://modelcontextprotocol.io) server over stdio so AI coding agents can query your codebase with real structural accuracy - not regex, not grep.
|
|
927
1075
|
|
|
928
|
-
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.
|
|
1076
|
+
<img src="https://raw.githubusercontent.com/abhiyoheswaran1/projscan/v4.2.0/docs/projscan-agent-demo.gif" alt="projscan answering two agent questions: what breaks if I rename buildCodeGraph (impact analysis with definitions, direct callers, transitive reach), and where should I fix first (ranked hotspots with cyclomatic complexity)" width="700">
|
|
929
1077
|
|
|
930
1078
|
Two questions an agent asks; structural answers in milliseconds. *"What breaks if I rename `buildCodeGraph`?"* → 31 direct callers, 97 files reachable. *"Where should I fix first?"* → ranked hotspots with AST cyclomatic complexity, churn, and ownership signals.
|
|
931
1079
|
|
|
@@ -1135,7 +1283,7 @@ Capability is advertised under `experimental.fileChanged` on `initialize` so cli
|
|
|
1135
1283
|
- **`projscan_apply_fix`** *(1.6)* - mechanically execute the safe fix templates. Default is dry-run; pass `confirm: true` to write. Atomic writes, per-apply rollback record at `.projscan-cache/rollbacks/<id>.json`. Reverse with `action: "rollback", rollback_id: ...`. Six templates supported at this release: `unused-dependency-*`, `missing-test-framework`, `missing-eslint`, `missing-prettier`, `missing-editorconfig`, `missing-readme`.
|
|
1136
1284
|
- **`projscan_taint`** *(1.6)* - source-to-sink reachability over the per-function call graph. Built-in defaults cover common JS / Python sources (`process.env`, `req.body`, etc.) and sinks (`exec`, `eval`, `db.query`, etc.). Project-specific names go in `.projscanrc.json` `taint`. `projscan_review` automatically diffs taint flows between base and head and **blocks any PR that introduces a new flow**. In 3.0.2, review surfaces hardened `newDataflowRisks`, compact `graphEvidence`, and graph-readiness gates for safer handoff.
|
|
1137
1285
|
|
|
1138
|
-
Analyzer plugins can optionally read graph/dataflow context through `check(rootPath, files, context)` while staying on manifest schema v1. The packaged `graph-context` example shows `context.getSemanticGraph()` and `context.getDataflow()` in a real analyzer. For analyzer and reporter plugin authoring, manifest validation, `--reporter <name>`, and the trust model, see [Plugin Authoring](https://github.com/abhiyoheswaran1/projscan/blob/v4.
|
|
1286
|
+
Analyzer plugins can optionally read graph/dataflow context through `check(rootPath, files, context)` while staying on manifest schema v1. The packaged `graph-context` example shows `context.getSemanticGraph()` and `context.getDataflow()` in a real analyzer. For analyzer and reporter plugin authoring, manifest validation, `--reporter <name>`, and the trust model, see [Plugin Authoring](https://github.com/abhiyoheswaran1/projscan/blob/v4.2.0/docs/PLUGIN-AUTHORING.md).
|
|
1139
1287
|
|
|
1140
1288
|
### Context-window budgeting
|
|
1141
1289
|
|