@getcodesentinel/codesentinel 1.12.1 → 1.14.0

package/README.md

@@ -94,7 +94,7 @@ CodeSentinel combines three signals into a single, explainable risk profile:
 
 The CLI output now includes a deterministic `risk` block composed from those dimensions:
 
-- `repositoryScore` and `normalizedScore`
+- `riskScore` and `normalizedScore`
 - ranked `hotspots`
 - `fragileClusters` (structural cycles + change coupling components)
 - `dependencyAmplificationZones`
@@ -140,6 +140,7 @@ Then run:
 
 ```bash
 codesentinel analyze [path]
+codesentinel run [path]
 codesentinel explain [path]
 codesentinel report [path]
 codesentinel check [path]
@@ -150,6 +151,8 @@ codesentinel dependency-risk <dependency[@version]>
 Examples:
 
 ```bash
+codesentinel run
+codesentinel run . --detail full --format text
 codesentinel analyze
 codesentinel analyze .
 codesentinel analyze ../project
@@ -178,6 +181,9 @@ codesentinel analyze . --author-identity likely_merge
 # Deterministic: strict email identity, no heuristic merging
 codesentinel analyze . --author-identity strict_email
 
+# Personal-project profile (down-weights single-maintainer ownership penalties)
+codesentinel analyze . --risk-profile personal
+
 # Tune recency window (days) used for evolution volatility
 codesentinel analyze . --recent-window-days 60
 
@@ -228,6 +234,10 @@ Notes:
 - `--output summary` (default) prints a compact result for terminal use.
 - `--output json` (or `--json`) prints the full analysis object.
 - `--recent-window-days <days>` customizes the git recency window used to compute `recentVolatility` (default: `30`).
+- `--risk-profile default|personal` selects scoring profile.
+  - `default`: balanced team-oriented defaults.
+  - `personal`: lowers ownership concentration and bus-factor penalties for solo-maintainer repos.
+  - `personal` does not remove structural, churn, volatility, external, or interaction risk; scores can still be elevated when those signals are high.
 
 When running through pnpm, pass CLI arguments after `--`:
 
@@ -236,6 +246,7 @@ pnpm dev -- analyze
 pnpm dev -- analyze .
 pnpm dev -- analyze ../project
 pnpm dev -- analyze . --author-identity strict_email
+pnpm dev -- run . --format text
 pnpm dev -- explain
 pnpm dev -- explain . --top 5 --format text
 pnpm dev -- explain . --file src/app/page.tsx
@@ -264,6 +275,15 @@ Diff mode compares snapshots and reports:
 - new/resolved cycles
 - dependency exposure list changes
 
+## Run Output
+
+`codesentinel run` is a convenience command that emits `analyze + explain + report` in one execution.
+
+- formats: `text`, `md`, `json` (`text` default)
+- detail levels: `--detail compact|standard|full` (`compact` default, `full` = full verbose sections)
+- explain target selectors: `--file <path>`, `--module <name>`, `--top <n>`
+- report diff/snapshot flags: `--compare <baseline.json>`, `--snapshot <path>`, `--no-trace`
+
 ## CI Mode
 
 `codesentinel check` evaluates enforcement gates against current analysis (and optional baseline diff).
@@ -355,7 +375,7 @@ Minimal shape:
   "evolution": { "...": "..." },
   "external": { "...": "..." },
   "risk": {
-    "repositoryScore": 0,
+    "riskScore": 0,
     "normalizedScore": 0,
     "hotspots": [],
     "fragileClusters": [],
@@ -366,7 +386,7 @@ Minimal shape:
 
 How to read `risk` first:
 
-- `repositoryScore`: overall repository fragility index (`0..100`).
+- `riskScore`: overall repository fragility index (`0..100`).
 - `hotspots`: ranked files to inspect first.
 - `fragileClusters`: groups of files with structural-cycle or co-change fragility.
 - `dependencyAmplificationZones`: files where external dependency pressure intersects with local fragility.
@@ -391,7 +411,7 @@ These ranges are heuristics for triage, not incident probability.
 
 ### What Moves Scores
 
-`risk.repositoryScore` and `risk.fileScores[*].score` increase when:
+`risk.riskScore` and `risk.fileScores[*].score` increase when:
 
 - structurally central files/modules change frequently,
 - ownership is highly concentrated in volatile files,