@vibedrift/cli 0.1.4 → 0.3.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 CHANGED
@@ -21,6 +21,13 @@ vibedrift ./my-project
21
21
 
22
22
  That's it. No signup, no API key, no config file. The default run produces an interactive HTML report and serves it on a local port.
23
23
 
24
+ To unlock AI-powered deep analysis (semantic duplicates, intent mismatches, anomaly detection):
25
+
26
+ ```bash
27
+ vibedrift login # one-time browser sign-in, no password
28
+ vibedrift . --deep # run with cloud AI on top of the local scan
29
+ ```
30
+
24
31
  ---
25
32
 
26
33
  ## What It Catches
@@ -38,20 +45,29 @@ VibeDrift learns the dominant patterns your codebase follows and flags files tha
38
45
  ## Usage
39
46
 
40
47
  ```
41
- vibedrift [path] [options]
42
-
43
- Arguments:
44
- path Project directory to scan (default: ".")
45
-
46
- Options:
48
+ vibedrift [command] [path] [options]
49
+
50
+ Commands:
51
+ scan [path] Scan a project for vibe drift (default)
52
+ login Log in to your VibeDrift account
53
+ logout Log out and revoke the current token
54
+ status Show the current account, plan, and token
55
+ usage Show this billing period's scan usage
56
+ upgrade Open the VibeDrift pricing page
57
+ billing Open the Stripe Customer Portal
58
+ doctor Diagnose CLI installation, auth, and API
59
+ update Update the CLI to the latest version
60
+
61
+ Scan options:
47
62
  --format <type> Output format: html, terminal, json, csv, docx (default: html)
48
63
  --output <path> Write report to a file
49
64
  --json Shorthand for --format json
50
65
  --fail-on-score <n> Exit with code 1 if composite score is below threshold
51
66
  --no-codedna Skip Code DNA semantic analysis
52
- --ml Enable premium ML-powered analysis (requires VibeDrift key)
53
- --ml-key <key> VibeDrift API key for premium features
54
- --update Update VibeDrift CLI to the latest version
67
+ --deep Enable AI-powered deep analysis (requires `vibedrift login`)
68
+ --include <pattern> Only scan files matching this glob (repeatable)
69
+ --exclude <pattern> Exclude files matching this glob (repeatable)
70
+ --update Update the VibeDrift CLI to the latest version
55
71
  --verbose Show timing breakdown and analyzer details
56
72
  -V, --version Show installed version
57
73
  -h, --help Show help
@@ -60,15 +76,29 @@ Options:
60
76
  ### Examples
61
77
 
62
78
  ```bash
63
- vibedrift # scan the current directory
64
- vibedrift ./my-project # scan a specific project
65
- vibedrift --format terminal # print results to the terminal
66
- vibedrift --json > report.json # pipe JSON output to a file
67
- vibedrift --fail-on-score 70 # fail CI if score drops below 70
68
- vibedrift --ml --ml-key vd_... # run premium ML-powered analysis
69
- vibedrift --update # update to the latest version
79
+ vibedrift # scan the current directory
80
+ vibedrift ./my-project # scan a specific project
81
+ vibedrift --format terminal # print results to the terminal
82
+ vibedrift --json > report.json # pipe JSON output to a file
83
+ vibedrift --fail-on-score 70 # fail CI if score drops below 70
84
+ vibedrift --include "src/**" # only scan files under src/
85
+ vibedrift --exclude "**/*.spec.*" # skip test files
86
+ vibedrift --deep # run premium AI-powered deep analysis
87
+ vibedrift login # sign in to enable --deep
88
+ vibedrift status # check current auth state
89
+ vibedrift usage # view this month's scan usage
90
+ vibedrift billing # manage your Stripe subscription
91
+ vibedrift update # update to the latest version
70
92
  ```
71
93
 
94
+ ### Environment
95
+
96
+ | Variable | Purpose |
97
+ |----------------------|---------|
98
+ | `VIBEDRIFT_TOKEN` | Bearer token for CI / non-interactive use (overrides `~/.vibedrift/config.json`) |
99
+ | `VIBEDRIFT_API_URL` | Override the API base URL (staging / self-hosted) |
100
+ | `VIBEDRIFT_NO_BROWSER` | Set to `1` to never auto-open the browser |
101
+
72
102
  ### Output Formats
73
103
 
74
104
  | Format | Description |
@@ -84,6 +114,10 @@ vibedrift --update # update to the latest version
84
114
  ```bash
85
115
  # Fail the build if score drops below 70
86
116
  npx @vibedrift/cli . --format json --fail-on-score 70
117
+
118
+ # Same, with deep AI analysis (token from VIBEDRIFT_TOKEN secret)
119
+ VIBEDRIFT_TOKEN=$VIBEDRIFT_TOKEN \
120
+ npx @vibedrift/cli . --deep --format json --fail-on-score 70
87
121
  ```
88
122
 
89
123
  Exit code 1 when the score drops below the threshold. JSON output includes every finding for downstream tooling.
@@ -99,7 +133,9 @@ JavaScript · TypeScript · Python · Go · Rust
99
133
  ## Privacy
100
134
 
101
135
  - **Default scans** run 100% locally. Zero bytes leave your machine.
102
- - **`--ml` (premium)** sends function snippets (not full files) to the VibeDrift API. Snippets are processed in memory and not stored. All AI/ML processing happens on VibeDrift's infrastructure — you never need to bring your own API key.
136
+ - **`--deep` (premium)** sends function snippets (not full files) to the VibeDrift API. Snippets are processed in memory and not stored. All AI processing happens on VibeDrift's infrastructure — you never need to bring your own API key.
137
+ - **Auth state** lives at `~/.vibedrift/config.json` (mode 0600). The token is opaque and revocable from the CLI (`vibedrift logout`) or the dashboard.
138
+ - **Scan history** lives at `~/.vibedrift/scans/` — never inside your project tree.
103
139
 
104
140
  ---
105
141