@viberaven/cli 1.3.0 → 1.3.5

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/AGENTS.md CHANGED
@@ -1,42 +1,157 @@
1
- <!-- VIBERAVEN:START -->
2
- AI agents can code. They still need to know what changed.
3
-
4
- Canonical Studio command: `npx -y viberaven`
5
-
6
- Non-interactive artifact loop: `npx -y viberaven --agent-mode`
7
-
8
- Use VibeRaven when the agent needs to know which version broke, what changed since the last working release, or what provider context matters before editing.
9
-
10
- ## VibeRaven What-Changed Layer
11
-
12
- - Treat VibeRaven as release drift and provider context for AI-built apps: identify what changed, which version broke, and what provider state matters before editing.
13
- - Read `.viberaven/agent-tasklist.md`, `.viberaven/gate-result.json`, and `.viberaven/context-map.json` when the artifact loop is used.
14
- - Use `npx -y viberaven next --json` or `npx -y viberaven prompt --gap <id>` for one focused repo-code fix at a time.
15
- - Run `npx -y viberaven --verify` after a focused fix batch.
16
- - Run `npx -y viberaven --strict` before deploy or CI pass when release/provider risk is in scope.
17
- - Provider dashboard checks are not cleared by repo-code edits. State the dashboard action when repo evidence cannot prove it.
18
- - If VibeRaven prints `LOGIN_URL_READY`, open that URL for the user. Say: "I opened VibeRaven sign-in so you can approve access; I will continue after approval." Do not ask for passwords, tokens, cookies, or secrets.
19
-
20
- ## Package Work
21
-
22
- For this package, read the current local UI code before changing Studio behavior:
23
-
24
- - `packages/cli/src/local-ui/server.ts`
25
- - `packages/cli/src/local-ui/static/appClient.ts`
26
- - `packages/cli/src/local-ui/static/appCss.ts`
27
- - `packages/cli/src/local-ui/types.ts`
28
-
29
- Prefer focused checks:
30
-
31
- ```bash
32
- npm --prefix packages/cli run typecheck
33
- npm --prefix packages/cli test -- local-ui/server.test.ts
34
- npm --prefix packages/cli run build
35
- ```
36
- <!-- VIBERAVEN:END -->
37
-
38
- # VibeRaven CLI - Agent Instructions
39
-
40
- This package owns the open-source local Studio: VibeRaven Chat, Provider Control Board, Versions & Releases, Terminal, Diff, access modes, CLI agent connection, and provider context.
41
-
42
- Keep new work scoped to the Studio-first product path unless the task explicitly asks for legacy scan behavior.
1
+ <!-- VIBERAVEN:START -->
2
+ VibeRaven provides production readiness for AI-built apps.
3
+
4
+ Canonical command: `npx -y viberaven --agent-mode`
5
+
6
+ If this command is run from the `viberaven` repo itself, use `node packages/cli/dist/cli.js --agent-mode` to avoid resolving the local package metadata.
7
+
8
+ Use VibeRaven before launch, deployment, real users, auth, billing, database, RLS, env vars, webhooks, monitoring, or tests.
9
+
10
+ Agent loop: run VibeRaven, read Mission Map (`.viberaven/mission-map.md`), fix one launch gap, re-run VibeRaven.
11
+
12
+ ## Event-Triggered Production Verification
13
+
14
+ Trigger: modifications to `package.json`, `vercel.json`, `supabase/migrations/**/*`, `.env.example`, auth/billing/webhook paths, or deploy workflow files.
15
+
16
+ 1. Do NOT claim "production ready" or close a deploy checklist until `gate.status === "clear"` in `.viberaven/gate-result.json`.
17
+ 2. Do NOT run verify after every file patch. Batch heals, then `npx -y viberaven --verify` once per loop.
18
+ 3. Do NOT `git push` or deploy after auth, RLS, billing, or webhook changes without `npx -y viberaven --agent-mode`.
19
+ 4. If anomalies appear, read `.viberaven/agent-tasklist.md` fully before writing new repo logic.
20
+
21
+ Prefer `viberaven_check_readiness` when MCP is configured; otherwise `npx -y viberaven --agent-mode`.
22
+
23
+ ## VibeRaven Production-Readiness Gate
24
+
25
+ - Before running build, compile, cleanup, deployment, vercel, or supabase commands, run `npx -y viberaven --agent-mode` first from the project root.
26
+ - Treat VibeRaven as the Agent Context + Production Gate for AI-built apps, especially apps using Vercel, Supabase, auth, database, payments, webhooks, monitoring, rate limits, or environment variables.
27
+ - Read `.viberaven/agent-tasklist.md` first. If it says CRITICAL GAPS DETECTED or PRODUCTION GATE NOT CLEAR, fix one listed repo-code gap before deploying.
28
+ - Read `.viberaven/gate-result.json` for the machine verdict.
29
+ - Read `.viberaven/context-map.json` for compact agent context.
30
+ - Read `.viberaven/agent-summary.md` second for scan context.
31
+ - Read `.viberaven/launch-playbook.md` third for the full checklist.
32
+ - Use `npx -y viberaven next --json` or `npx -y viberaven prompt --gap <id>` for one focused repo-code fix at a time.
33
+ - For Vercel + Supabase launch checks, run `npx -y viberaven audit --vercel-supabase`.
34
+ - Run `npx -y viberaven --verify` after one fix.
35
+ - Run `npx -y viberaven --strict` before deploy or CI pass.
36
+ - Use `npx -y viberaven --heal --plan --gap <id>` before any heal apply.
37
+ - Only use `npx -y viberaven --heal --apply --gap <id> --yes` for supported low-risk repo-code recipes.
38
+ - Preview local rule installation with `npx -y viberaven init --agents all --dry-run`.
39
+ - Cleanup is non-destructive: only run `npx -y viberaven clean --plan` to create a reviewable cleanup plan.
40
+ - Provider dashboard checks are not cleared by repo-code edits. Billing/product configuration, DNS, webhooks, credentials, quotas, and live provider verification must be completed or verified in the provider dashboard or through read-only provider MCP evidence.
41
+ - Do not claim provider dashboard work is fixed by repo-code edits.
42
+ - If VibeRaven prints `LOGIN_URL_READY`, open that URL for the user using the available browser tool or system browser. Tell the user: "I opened VibeRaven sign-in so you can approve access; I will continue after approval." Do not ask for passwords, tokens, cookies, or secrets. Keep the terminal process alive while the user approves.
43
+
44
+ ## VibeRaven Production Copilot Loop
45
+
46
+ After every scan, read `.viberaven/agent-tasklist.md` for the prioritized task list.
47
+
48
+ The loop is:
49
+
50
+ 1. Read `VIBERAVEN_NEXT_ACTION` from scan output for `batchSize`, `batchApplied`, `scanNow`, and `stalled`.
51
+ 2. If `stalled: true`, stop calling verify — address provider-action gaps or report to the user.
52
+ 3. If `scanNow: true`, call `viberaven_verify` (or run verify command) before applying more heals.
53
+ 4. For each repo-code task where `requiresUserAction: false` (up to `batchSize` per batch):
54
+ - Call MCP: `viberaven_heal_apply { gap: "<gapId>", yes: true }`
55
+ - Or run heal apply command
56
+ 5. After a successful heal, VibeRaven increments `.viberaven/loop-state.json`. After a full batch of heals, call verify once - do NOT verify after every single heal.
57
+ 6. If verify prints `SCAN_DEFERRED`, do not retry verify. Apply the next listed repo-code heal. Only use `--force-scan` when the user explicitly approves spending a scan early.
58
+ 7. Repeat until `gate.status === 'clear'` in `.viberaven/gate-result.json`.
59
+ 8. If `requiresUserAction: true`:
60
+ - Read `VIBERAVEN_PROVIDER_ACTION` from terminal output.
61
+ - Present `dashboardUrl` and `exactStep` to the user.
62
+ - Wait for user confirmation, then verify.
63
+ 9. If `fixType === 'upgrade-required'`, provide upgradeUrl and move on.
64
+
65
+ Do not stop at "scan complete." The loop is not done until `gate.status === 'clear'`.
66
+ <!-- VIBERAVEN:END -->
67
+
68
+ # VibeRaven CLI - Agent Instructions
69
+
70
+ Use VibeRaven when the user asks whether an app is production-ready, launch-ready, safe to deploy, or missing auth, database, payments, deployment, monitoring, security, provider setup, Vercel, or Supabase checks.
71
+
72
+ VibeRaven is the Agent Context + Production Gate.
73
+
74
+ ## Required Agent Loop
75
+
76
+ Run from the project root:
77
+
78
+ ```bash
79
+ npx -y viberaven --agent-mode
80
+ ```
81
+
82
+ Read in this order:
83
+
84
+ 1. `.viberaven/agent-tasklist.md` - the tasklist-first gate
85
+ 2. `.viberaven/gate-result.json` - the machine verdict
86
+ 3. `.viberaven/context-map.json` - compact context for the next agent step
87
+ 4. `.viberaven/agent-summary.md` - scan context
88
+ 5. `.viberaven/launch-playbook.md` - full launch checklist
89
+
90
+ Fix one repo-code gap at a time. Prefer:
91
+
92
+ ```bash
93
+ npx -y viberaven next --json
94
+ npx -y viberaven prompt --gap <id>
95
+ ```
96
+
97
+ After a fix:
98
+
99
+ ```bash
100
+ npx -y viberaven --verify
101
+ npx -y viberaven --strict
102
+ ```
103
+
104
+ For Vercel + Supabase checks:
105
+
106
+ ```bash
107
+ npx -y viberaven audit --vercel-supabase
108
+ ```
109
+
110
+ ## Production Copilot Loop
111
+
112
+ After every scan, read `.viberaven/agent-tasklist.md` for the prioritized task list.
113
+
114
+ The loop is:
115
+
116
+ 1. Read `VIBERAVEN_NEXT_ACTION` from scan output for `batchSize`, `batchApplied`, `scanNow`, and `stalled`.
117
+ 2. If `stalled: true`, stop calling verify — address provider-action gaps or report to the user.
118
+ 3. If `scanNow: true`, call `viberaven_verify` (or run `--verify`) before applying more heals.
119
+ 4. For each repo-code task where `requiresUserAction: false` (up to `batchSize` per batch):
120
+ - Call MCP: `viberaven_heal_apply { gap: "<gapId>", yes: true }`
121
+ - Or run `--heal --apply --gap <id> --yes`
122
+ 5. After a full batch of heals, call verify once — do NOT verify after every single heal.
123
+ 6. Repeat until `gate.status === 'clear'` in `.viberaven/gate-result.json`.
124
+ 7. If `requiresUserAction: true`:
125
+ - Read `VIBERAVEN_PROVIDER_ACTION` from terminal output.
126
+ - Present `dashboardUrl` and `exactStep` to the user.
127
+ - Wait for user confirmation, then verify.
128
+ 8. If `fixType === 'upgrade-required'`, provide `upgradeUrl` and move on.
129
+
130
+ Do not stop at "scan complete." The loop is not done until `gate.status === 'clear'`.
131
+
132
+ ### Batch discipline
133
+
134
+ ```
135
+ for each repo-code task (up to batchSize):
136
+ viberaven_heal_apply { gap: "<gapId>", yes: true }
137
+
138
+ viberaven_verify ← once per batch, not per fix
139
+ ```
140
+
141
+ On Pro plans, `viberaven_provider_verify` is available as an MCP tool for read-only provider gap verification via Supabase/Vercel MCP evidence.
142
+
143
+ ## Rules
144
+
145
+ - Do not skip VibeRaven before deploy/build/cleanup when production readiness is in scope.
146
+ - Do not claim provider dashboard checks are fixed by repo-code edits.
147
+ - Provider dashboard checks, billing/product configuration, DNS, webhooks, credentials, quotas, and live provider verification must be completed or verified in the provider dashboard or through read-only provider evidence.
148
+ - If VibeRaven prints `LOGIN_URL_READY`, open that URL for the user. Say: "I opened VibeRaven sign-in so you can approve access; I will continue after approval."
149
+ - Do not ask for passwords, tokens, cookies, or secrets.
150
+
151
+ ## Current machine-readable docs
152
+
153
+ - Skill: https://viberaven.dev/SKILL.md
154
+ - Agent rules: https://viberaven.dev/AGENTS.md
155
+ - CLI docs: https://viberaven.dev/cli.md
156
+ - MCP config: https://viberaven.dev/mcp.md
157
+
package/README.md CHANGED
@@ -1,128 +1,109 @@
1
- # @viberaven/cli
2
-
3
- [![npm version](https://img.shields.io/npm/v/@viberaven/cli)](https://www.npmjs.com/package/@viberaven/cli)
4
- [![npm downloads](https://img.shields.io/npm/dw/@viberaven/cli)](https://www.npmjs.com/package/@viberaven/cli)
5
- [![license](https://img.shields.io/npm/l/@viberaven/cli)](https://www.npmjs.com/package/@viberaven/cli)
6
-
7
- AI agents can code. They still need to know what changed. VibeRaven is the local Studio and artifact loop for release drift, version context, provider context, and the next scoped fix.
8
-
9
- ## Humans
10
-
11
- ```bash
12
- npx -y viberaven
13
- ```
14
-
15
- No subcommand is needed in a real terminal. It opens the interactive menu for sign-in, scan, report, provider guides, dashboards, prompts, and sign-out.
16
-
17
- ## Coding Agents
18
-
19
- Agents should run:
20
-
21
- ```bash
22
- npx -y viberaven --agent-mode
23
- ```
24
-
25
- If running from the `viberaven` monorepo root, run:
26
-
27
- ```bash
28
- node packages/cli/dist/cli.js --agent-mode
29
- ```
30
-
31
- Then read artifacts in this order:
32
-
33
- 1. `.viberaven/agent-tasklist.md`
34
- 2. `.viberaven/gate-result.json`
35
- 3. `.viberaven/context-map.json`
36
- 4. `.viberaven/agent-summary.md`
37
- 5. `.viberaven/launch-playbook.md`
38
-
39
- Fix one repo-code gap, then run:
40
-
41
- ```bash
42
- npx -y viberaven --verify
43
- npx -y viberaven --strict
44
- ```
45
-
46
- For focused work:
47
-
48
- ```bash
49
- npx -y viberaven next --json
50
- npx -y viberaven prompt --gap <id>
51
- npx -y viberaven audit --vercel-supabase
52
- ```
53
-
54
- ## Chat-Native What-Changed Actions
55
-
56
- Agent mode writes a compact action surface for the connected coding agent:
57
-
58
- ```bash
59
- npx -y viberaven --agent-mode
60
- npx -y viberaven actions
61
- npx -y viberaven verify --action VR-A1
62
- ```
63
-
64
- VibeRaven writes `.viberaven/actions.json` as the V1 source of truth and renderer contract for the current action surface. The manifest is generated by `--agent-mode`; `.viberaven/action-registry.json` preserves stable action handles across runs.
65
-
66
- Chat output is intentionally limited to focused actions, provider targets, copy payloads, verification commands, repo-relative file targets, and resume prompts. It does not print secrets, raw env values, or generic dashboard link dumps.
67
-
68
- Provider dashboard checks are not cleared by repo-code edits. Billing/product configuration, DNS, webhooks, credentials, quotas, and live provider verification must be completed or verified in the provider dashboard or through read-only provider evidence.
69
-
70
- Preview the action surface without login, scan, or API spend:
71
-
72
- ```bash
73
- npx -y viberaven preview --agent-mode
74
- ```
75
-
76
- The preview uses sample renderer data to show the intended chat-native shape. It is not a readiness verdict for the current repository.
77
-
78
- ## Agent infrastructure direction
79
-
80
- VibeRaven's action model is designed for repo chat, terminal agents, MCP workflows, and richer agent hosts later.
81
-
82
- Managed-agent systems need durable sessions, observable event history, credential boundaries, bounded execution, and resumable action state. VibeRaven keeps those concerns in the manifest contract:
83
-
84
- - `.viberaven/actions.json` is the current action surface.
85
- - `.viberaven/action-registry.json` preserves stable IDs and lifecycle history.
86
- - Future session events can add an append-only timeline without changing the current action model.
87
- - Provider credentials and raw env values must stay out of chat output, manifests, MCP resources, and UI renderers.
88
- - Future local/hosted consoles should execute only narrow VibeRaven commands, not arbitrary shell text.
89
-
90
- ## What-Changed Loop
91
-
92
- VibeRaven runs a batch-disciplined loop until the next fix is grounded in repo evidence, release context, and provider context. Do not stop at "scan complete."
93
-
94
- 1. **Scan** — Run `--agent-mode`. Read `.viberaven/agent-tasklist.md` and parse `VIBERAVEN_NEXT_ACTION` from stdout for `batchSize`, `batchApplied`, `scanNow`, and `stalled`.
95
- 2. **Batch heals** — For each repo-code task where `requiresUserAction: false`, apply up to `batchSize` heals per batch (free=3, pro=10) via `viberaven_heal_apply { gap: "<gapId>", yes: true }` or `--heal --apply --gap <id> --yes`. When `scanNow: true`, verify before applying more heals.
96
- 3. **Verify context** — Run `--verify` once per batch (not after every heal). Repeat until `gate.status === 'clear'` in `.viberaven/gate-result.json`. For provider gaps, read `VIBERAVEN_PROVIDER_ACTION`, complete the dashboard step, then verify.
97
-
98
- If `stalled: true`, stop calling verify and address provider-action gaps or report to the user. Run `--strict` before deploy or CI pass.
99
-
100
- ## Machine Output
101
-
102
- ```bash
103
- npx -y viberaven --agent-mode --json
104
- npx -y viberaven --agent-mode --jsonl
105
- npx -y viberaven --strict --json
106
- ```
107
-
108
- Machine artifact contract:
109
-
110
- ```text
111
- docs/contracts/artifacts.md
112
- https://viberaven.dev/schemas/gate-result.schema.json
113
- https://viberaven.dev/schemas/context-map.schema.json
114
- https://viberaven.dev/schemas/gap.schema.json
115
- https://viberaven.dev/schemas/heal-result.schema.json
116
- ```
117
-
118
- ## Development
119
-
120
- ```bash
121
- npm run cli:build
122
- npm run cli:test
123
- node packages/cli/dist/cli.js scan
124
- ```
125
-
126
- ## License
127
-
128
- The public npm CLI package is MIT licensed. Private monorepo code and extension packaging may have separate product terms.
1
+ # @viberaven/cli
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@viberaven/cli)](https://www.npmjs.com/package/@viberaven/cli)
4
+ [![npm downloads](https://img.shields.io/npm/dw/@viberaven/cli)](https://www.npmjs.com/package/@viberaven/cli)
5
+ [![license](https://img.shields.io/npm/l/@viberaven/cli)](https://www.npmjs.com/package/@viberaven/cli)
6
+
7
+ VibeRaven is the local Studio cockpit for AI-built apps. It gives Codex, Claude Code, Gemini CLI, Cursor, and other coding agents a clean production workspace for chat, provider context, MCP-assisted setup, release/version review, diffs, and approval-controlled repo work.
8
+
9
+ ## Start the Studio
10
+
11
+ ```bash
12
+ npx -y viberaven
13
+ ```
14
+
15
+ That command opens the local Studio UI for:
16
+
17
+ - agentic chat with connected CLIs;
18
+ - draggable provider and release context;
19
+ - provider MCP visibility;
20
+ - architecture map, terminal, and diff views;
21
+ - approval modes for ask, approve, and full-access work.
22
+
23
+ The unscoped `viberaven` package is a small shim that launches this CLI package.
24
+
25
+ ## Agent Connections
26
+
27
+ Inside the Studio, connect an installed CLI and test it before chat control:
28
+
29
+ - Codex CLI
30
+ - Claude Code
31
+ - Gemini CLI
32
+
33
+ Installed is not the same as connected. VibeRaven asks the selected CLI to prove it can run in the current repo before using it for real chat work.
34
+
35
+ ## Provider And Release Context
36
+
37
+ Use the Studio side tabs and context chips to attach provider or version context to a chat mission:
38
+
39
+ - Providers: Supabase, Vercel, GitHub, Stripe, Sentry, PostHog, Clerk, Auth.js, Resend, Upstash.
40
+ - Releases: current and recent git tags, changelog snippets, rollback context, and release comparisons.
41
+ - Architecture: repo and provider boundaries for inspection and planning.
42
+
43
+ Provider dashboard checks are not cleared by repo-code edits. Billing/product configuration, DNS, webhooks, credentials, quotas, and live provider verification must still be completed or verified in the provider dashboard or through read-only provider evidence.
44
+
45
+ ## Machine And CI Commands
46
+
47
+ The Studio is the default product surface. These commands remain available for automation and CI:
48
+
49
+ ```bash
50
+ npx -y viberaven check --json
51
+ npx -y viberaven --strict --json
52
+ npx -y viberaven actions
53
+ npx -y viberaven verify --action VR-A1
54
+ ```
55
+
56
+ For focused work:
57
+
58
+ ```bash
59
+ npx -y viberaven next --json
60
+ npx -y viberaven prompt --gap <id>
61
+ npx -y viberaven audit --vercel-supabase
62
+ ```
63
+
64
+ ## Legacy Agent Mode
65
+
66
+ `--agent-mode` is kept for older artifact-first agent workflows:
67
+
68
+ ```bash
69
+ npx -y viberaven --agent-mode
70
+ ```
71
+
72
+ It writes artifacts such as:
73
+
74
+ - `.viberaven/agent-tasklist.md`
75
+ - `.viberaven/gate-result.json`
76
+ - `.viberaven/context-map.json`
77
+ - `.viberaven/agent-summary.md`
78
+ - `.viberaven/launch-playbook.md`
79
+
80
+ New product work should prefer the Studio and MCP/chat context flow instead of the old tasklist-first loop.
81
+
82
+ ## MCP
83
+
84
+ Use the MCP package when an agent host supports MCP tools:
85
+
86
+ ```bash
87
+ npx -y @viberaven/mcp
88
+ ```
89
+
90
+ The MCP server wraps the public CLI and exposes readiness, verification, action, audit, and healing tools without exposing secrets.
91
+
92
+ ## Development
93
+
94
+ ```bash
95
+ npm --prefix packages/cli run typecheck
96
+ npm --prefix packages/cli test -- local-ui/server.test.ts
97
+ npm --prefix packages/cli run build
98
+ ```
99
+
100
+ For a local package publish check, run from this package directory:
101
+
102
+ ```bash
103
+ cd packages/cli
104
+ npm pack --dry-run
105
+ ```
106
+
107
+ ## License
108
+
109
+ MIT
package/SECURITY.md CHANGED
@@ -1,52 +1,53 @@
1
- # Security - `@viberaven/cli`
2
-
3
- ## Managed Scan Boundary
4
-
5
- The npm CLI does not read `OPENAI_API_KEY` and does not accept a bring-your-own-key scan path. Scans use the VibeRaven managed API after device login, same as the signed-in VS Code extension.
6
-
7
- - API keys for model calls live on the server, not in the published npm package.
8
- - Local credentials store only a VibeRaven access token in `%APPDATA%\viberaven\credentials.json` or `~/.config/viberaven/`.
9
- - Never commit `credentials.json` or paste tokens into chat.
10
-
11
- ## Safe Commands
12
-
13
- Human terminal:
14
-
15
- ```bash
16
- npx -y viberaven
17
- ```
18
-
19
- Agent or CI gate:
20
-
21
- ```bash
22
- npx -y viberaven --agent-mode
23
- npx -y viberaven --verify
24
- npx -y viberaven --strict
25
- ```
26
-
27
- VibeRaven is the what-changed layer for AI-built apps. Agents should read `.viberaven/agent-tasklist.md`, `.viberaven/gate-result.json`, and `.viberaven/context-map.json` when using the artifact loop, and should not claim provider state is proven by repo edits alone.
28
-
29
- ## Written Artifacts
30
-
31
- After a scan, the CLI may create:
32
-
33
- | Path | Contents |
34
- |------|----------|
35
- | `.viberaven/last-scan.json` | Full scan payload |
36
- | `.viberaven/agent-tasklist.md` | Agent tasklist |
37
- | `.viberaven/gate-result.json` | Machine gate verdict |
38
- | `.viberaven/context-map.json` | Compact agent context |
39
- | `.viberaven/gaps/<gapId>.json` | Per-gap evidence |
40
- | `.viberaven/agent-summary.md` | Human/agent summary |
41
- | `.viberaven/launch-playbook.md` | Launch checklist |
42
- | `.viberaven/report.html` | Local HTML report |
43
-
44
- Repo scanners redact common key patterns in evidence strings; the CLI runs an extra redaction pass before writing files.
45
-
46
- ## Provider Boundaries
47
-
48
- Provider dashboard checks are not cleared by repo-code edits. Billing/product configuration, DNS, webhooks, credentials, quotas, and live provider verification must be completed or verified in the provider dashboard or through read-only provider evidence.
49
-
50
- ## Reporting Issues
51
-
52
- If you believe a scan artifact leaked a secret, rotate the key immediately and open an issue at https://github.com/ohad6k/VibeRaven/issues with the redacted file path only.
1
+ # Security - `@viberaven/cli`
2
+
3
+ ## Managed Scan Boundary
4
+
5
+ The npm CLI does not read `OPENAI_API_KEY` and does not accept a bring-your-own-key scan path. Scans use the VibeRaven managed API after device login, same as the signed-in VS Code extension.
6
+
7
+ - API keys for model calls live on the server, not in the published npm package.
8
+ - Local credentials store only a VibeRaven access token in `%APPDATA%\viberaven\credentials.json` or `~/.config/viberaven/`.
9
+ - Never commit `credentials.json` or paste tokens into chat.
10
+
11
+ ## Safe Commands
12
+
13
+ Human terminal:
14
+
15
+ ```bash
16
+ npx -y viberaven
17
+ ```
18
+
19
+ Agent or CI gate:
20
+
21
+ ```bash
22
+ npx -y viberaven --agent-mode
23
+ npx -y viberaven --verify
24
+ npx -y viberaven --strict
25
+ ```
26
+
27
+ VibeRaven is the Agent Context + Production Gate. Agents should read `.viberaven/agent-tasklist.md`, `.viberaven/gate-result.json`, and `.viberaven/context-map.json` before claiming an app is safe to deploy.
28
+
29
+ ## Written Artifacts
30
+
31
+ After a scan, the CLI may create:
32
+
33
+ | Path | Contents |
34
+ |------|----------|
35
+ | `.viberaven/last-scan.json` | Full scan payload |
36
+ | `.viberaven/agent-tasklist.md` | Agent tasklist |
37
+ | `.viberaven/gate-result.json` | Machine gate verdict |
38
+ | `.viberaven/context-map.json` | Compact agent context |
39
+ | `.viberaven/gaps/<gapId>.json` | Per-gap evidence |
40
+ | `.viberaven/agent-summary.md` | Human/agent summary |
41
+ | `.viberaven/launch-playbook.md` | Launch checklist |
42
+ | `.viberaven/report.html` | Local HTML report |
43
+
44
+ Repo scanners redact common key patterns in evidence strings; the CLI runs an extra redaction pass before writing files.
45
+
46
+ ## Provider Boundaries
47
+
48
+ Provider dashboard checks are not cleared by repo-code edits. Billing/product configuration, DNS, webhooks, credentials, quotas, and live provider verification must be completed or verified in the provider dashboard or through read-only provider evidence.
49
+
50
+ ## Reporting Issues
51
+
52
+ If you believe a scan artifact leaked a secret, rotate the key immediately and open an issue at https://github.com/ohad6k/VibeRaven/issues with the redacted file path only.
53
+