@viberaven/cli 0.1.0-beta.0 → 0.1.0-beta.1

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,37 +1,46 @@
1
- # VibeRaven CLI — agent instructions
2
-
3
- Use this when the user asks whether their app is **production-ready**, **launch-ready**, what they are **missing before ship**, or how to improve **auth / database / payments / deployment** on an AI-built project.
4
-
5
- ## Run (user does not need to type this — you run it)
6
-
7
- ```bash
8
- npx -y @viberaven/cli@beta scan --open
9
- ```
10
-
11
- If not signed in:
12
-
13
- ```bash
14
- npx -y @viberaven/cli@beta login
15
- ```
16
-
17
- Then scan again.
18
-
19
- ## Read
20
-
21
- 1. `.viberaven/agent-summary.md` — short briefing and top gaps
22
- 2. `.viberaven/last-scan.json` — full mission map, providers, checks
23
- 3. `.viberaven/report.html` — visual map for the user (opened with `--open`)
24
-
25
- ## Fix loop
26
-
27
- 1. `npx -y @viberaven/cli@beta prompt` — stdout = copy-ready prompt for the top gap
28
- Or: `viberaven prompt --gap <id>` / `--area database` / `--provider supabase`
29
- 2. Implement the change in the repo.
30
- 3. `npx -y @viberaven/cli@beta scan` — verify production core % and gap count improved.
31
- 4. Tell the user to review `.viberaven/report.html` for the provider map.
32
-
33
- ## Rules
34
-
35
- - Do not skip the scan — VibeRaven uses repo evidence plus managed analysis, not generic checklists.
36
- - Prefer fixing **critical** gaps first unless the user names an area.
37
- - Do not claim external dashboard setup is done unless checks pass or the user confirmed manually.
1
+ # VibeRaven CLI — agent instructions
2
+
3
+ Use this when the user asks whether their app is **production-ready**, **launch-ready**, what they are **missing before ship**, or how to improve **auth / database / payments / deployment** on an AI-built project.
4
+
5
+ ## Humans (interactive menu)
6
+
7
+ ```bash
8
+ npx -y @viberaven/cli@beta
9
+ # or: viberaven tui
10
+ ```
11
+
12
+ No subcommand needed — opens an interactive menu for scan, gaps, prompts, and sign-in.
13
+
14
+ ## Run (agents — you run this, not the user)
15
+
16
+ ```bash
17
+ npx -y @viberaven/cli@beta scan
18
+ ```
19
+
20
+ If not signed in:
21
+
22
+ ```bash
23
+ npx -y @viberaven/cli@beta login
24
+ ```
25
+
26
+ Then scan again. Agents should use `scan` without `--open`; open the report only when the user wants the browser map.
27
+
28
+ ## Read
29
+
30
+ 1. `.viberaven/agent-summary.md` — short briefing and top gaps
31
+ 2. `.viberaven/last-scan.json` full mission map, providers, checks
32
+ 3. `.viberaven/report.html` — visual map for the user (human menu or `--open`)
33
+
34
+ ## Fix loop
35
+
36
+ 1. `npx -y @viberaven/cli@beta prompt` stdout = copy-ready prompt for the top gap
37
+ Or: `viberaven prompt --gap <id>` / `--area database` / `--provider supabase`
38
+ 2. Implement the change in the repo.
39
+ 3. `npx -y @viberaven/cli@beta scan` — verify production core % and gap count improved.
40
+ 4. Tell the user to review `.viberaven/report.html` for the provider map.
41
+
42
+ ## Rules
43
+
44
+ - Do not skip the scan — VibeRaven uses repo evidence plus managed analysis, not generic checklists.
45
+ - Prefer fixing **critical** gaps first unless the user names an area.
46
+ - Do not claim external dashboard setup is done unless checks pass or the user confirmed manually.
package/README.md CHANGED
@@ -9,16 +9,17 @@ npx -y @viberaven/cli@beta login
9
9
  npx -y @viberaven/cli@beta scan --open
10
10
  ```
11
11
 
12
- Uses the **same VibeRaven account and scan quota** as the VS Code extension.
12
+ Sign in once, then scan with `--open` to view `.viberaven/report.html` in the browser (same editorial Mission Map skin as the extension). Or run **`viberaven`** with no args for the interactive terminal menu.
13
13
 
14
- Opens `.viberaven/report.html` with an interactive provider map and copy-ready agent prompts.
14
+ Uses the **same VibeRaven account and scan quota** as the VS Code extension. **Does not use your `OPENAI_API_KEY`** scans go through the managed API after login. See [SECURITY.md](./SECURITY.md).
15
15
 
16
16
  ## For coding agents
17
17
 
18
- See [AGENTS.md](./AGENTS.md). Typical loop:
18
+ See [AGENTS.md](./AGENTS.md). Paste [templates/AGENTS.snippet.md](./templates/AGENTS.snippet.md) into your repo's `AGENTS.md`. Typical loop:
19
19
 
20
20
  ```bash
21
- npx -y @viberaven/cli@beta scan --open
21
+ npx -y @viberaven/cli@beta login # once
22
+ npx -y @viberaven/cli@beta scan # no --open needed for agents
22
23
  # read .viberaven/agent-summary.md
23
24
  npx -y @viberaven/cli@beta prompt
24
25
  # implement, then scan again
@@ -30,7 +31,7 @@ npx -y @viberaven/cli@beta prompt
30
31
  |------|---------|
31
32
  | `.viberaven/last-scan.json` | Full scan payload |
32
33
  | `.viberaven/agent-summary.md` | Short briefing for agents |
33
- | `.viberaven/report.html` | Visual mission map (Phase A) |
34
+ | `.viberaven/report.html` | Visual mission map + `report/station.css` (extension editorial UI) |
34
35
 
35
36
  ## Switch providers (matches the extension map)
36
37
 
package/SECURITY.md ADDED
@@ -0,0 +1,36 @@
1
+ # Security — `@viberaven/cli`
2
+
3
+ ## Your OpenAI key stays on your machine (extension only)
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 (`viberaven 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
+ ## What gets written to your repo
12
+
13
+ After `viberaven scan`, the CLI may create:
14
+
15
+ | Path | Contents |
16
+ |------|----------|
17
+ | `.viberaven/last-scan.json` | Mission map + gaps (secrets redacted before write) |
18
+ | `.viberaven/agent-summary.md` | Agent briefing |
19
+ | `.viberaven/report.html` | Local HTML report + `report/station.css` |
20
+
21
+ Repo scanners already redact common key patterns in evidence strings; the CLI runs an extra redaction pass before writing files.
22
+
23
+ ## Safe `npx` usage
24
+
25
+ ```bash
26
+ npx -y @viberaven/cli@beta login
27
+ npx -y @viberaven/cli@beta scan
28
+ ```
29
+
30
+ - Use official package name `@viberaven/cli` from npm.
31
+ - Do not set `OPENAI_API_KEY` for CLI scans — it is ignored by design.
32
+ - Add `.viberaven/` to `.gitignore` if you do not want scan output in git (optional; files should not contain raw keys after redaction).
33
+
34
+ ## Reporting issues
35
+
36
+ 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 (not the secret).
@@ -0,0 +1,5 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" aria-hidden="true">
2
+ <path fill="#412991" d="M32 5 11 16.8v13.7c0 12.2 8.9 23.3 21 27 12.1-3.7 21-14.8 21-27V16.8L32 5Z"/>
3
+ <path fill="#EB5424" d="M32 5v48.7c-3.1-1.1-6.1-2.7-8.7-4.7L32 5Z"/>
4
+ <path fill="#FBC22C" d="m32 5 8.7 44c-2.6 2-5.6 3.6-8.7 4.7V5Z"/>
5
+ </svg>
@@ -0,0 +1,5 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 96 64" aria-hidden="true">
2
+ <text x="48" y="31" text-anchor="middle" font-family="Arial, Helvetica, sans-serif" font-size="21" font-weight="800" letter-spacing="-1.4" fill="#111827">AWS</text>
3
+ <path fill="#FF9900" d="M23.6 42.4c13.9 7.5 31.5 7.5 45.1-.1 1.1-.6 2.2.8 1.3 1.7-12.3 12.5-34.3 12.6-47.2.8-.9-.8-.3-2.9.8-2.4Z"/>
4
+ <path fill="#FF9900" d="M66.8 39.8c2.4-.3 7.8-.8 8.8 1 .9 1.6-1 5.8-2.5 8.2-.5.8-1.7.4-1.5-.6.5-2.1 1.3-4.8.5-5.8-.8-1-3.8-.8-5.4-.6-1 .1-1.2-2-.1-2.2h.2Z"/>
5
+ </svg>
@@ -0,0 +1,4 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" aria-hidden="true">
2
+ <path fill="#764ABC" fill-rule="evenodd" clip-rule="evenodd" d="M26.8 12.9A20.8 20.8 0 0 1 32.3 7a20.5 20.5 0 0 1 5.5 5.8 29.3 29.3 0 0 1 5.1 17.1c1.1.9 2.3 1.8 3.4 2.7a6.2 6.2 0 0 1 2 5.7c-.5 2.6-1.1 5.2-1.6 7.8a2.2 2.2 0 0 1-3.3 1.1c-1.8-1.5-3.6-3-5.4-4.5a8.4 8.4 0 0 1-5.2 2.3 8.5 8.5 0 0 1-6.1-2.2c-1.3 1-2.5 2.1-3.8 3.2-.6.6-1.2 1-1.9 1.4a2.2 2.2 0 0 1-2.9-1.4c-.6-2.5-1.2-5.1-1.8-7.6a6.3 6.3 0 0 1 2.1-6c1-.8 2-1.6 3-2.3.3-.2.1-.5.2-.7a29.3 29.3 0 0 1 5.2-16.5Zm2.2 8.2a4.3 4.3 0 0 0 .4 5.8 4.8 4.8 0 0 0 6.5.1 4.3 4.3 0 0 0 1.1-4.8 4.4 4.4 0 0 0-3.9-2.9 4.5 4.5 0 0 0-4.1 1.8Zm3.3 4.9a2.1 2.1 0 1 0 0-4.2 2.1 2.1 0 0 0 0 4.2Z"/>
3
+ <path fill="#764ABC" d="M26.4 48.1a1.1 1.1 0 0 1 1.6-.9 10.4 10.4 0 0 0 9 0 1.1 1.1 0 0 1 1.6.8v4.8a1.1 1.1 0 0 1-1.7.8c-.5-.4-.9-.9-1.4-1.3-.7 1.4-1.4 2.8-2.1 4.1a1.1 1.1 0 0 1-1.8 0c-.8-1.4-1.4-2.8-2.2-4.1-.4.4-.9.9-1.3 1.3a1.1 1.1 0 0 1-1.7-.8v-4.7Z"/>
4
+ </svg>
@@ -0,0 +1,7 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" role="img" aria-label="VibeRaven raven mark">
2
+ <path fill="currentColor" d="M12 1.8 14.1 7l5.2-2.2-2.2 5.2 5.1 2-5.1 2 2.2 5.2-5.2-2.2L12 22.2 9.9 17l-5.2 2.2 2.2-5.2-5.1-2 5.1-2-2.2-5.2L9.9 7 12 1.8Zm0 5.2-1.2 3-3 .9 2.5 1.9-.1 3.2 1.8-2.6 1.8 2.6-.1-3.2 2.5-1.9-3-.9L12 7Z"/>
3
+ <path fill="currentColor" d="M7.2 6.1C4.6 7.4 2.9 9.4 2.1 12c1.4-.5 2.8-.7 4.1-.4.4-2.1 1.2-3.9 2.4-5.4l-1.4-.1Z"/>
4
+ <path fill="currentColor" d="M16.8 6.1c2.6 1.3 4.3 3.3 5.1 5.9-1.4-.5-2.8-.7-4.1-.4-.4-2.1-1.2-3.9-2.4-5.4l1.4-.1Z"/>
5
+ <path fill="currentColor" d="M8.6 14.8 12 22.2l3.4-7.4-2.1 1.3L12 14.4l-1.3 1.7-2.1-1.3Z"/>
6
+ <path fill="currentColor" d="M10 9.9c.3-1.5 1-2.9 2-4.1 1 1.2 1.7 2.6 2 4.1l-2 1.5-2-1.5Z"/>
7
+ </svg>