@oculum/cli 1.0.16 → 1.0.18

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.
Files changed (3) hide show
  1. package/README.md +21 -21
  2. package/dist/index.js +11228 -1096
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -8,7 +8,7 @@ AI-native security scanner for detecting vulnerabilities in AI-generated code, B
8
8
  ## Features
9
9
 
10
10
  - 🤖 **AI-Native Security**: Specialized detection for AI-era risks (BYOK patterns, agent tools, AI-generated code)
11
- - ⚡ **Multiple Scan Depths**: Choose between cheap (fast), validated (AI-verified), or deep (comprehensive) scans
11
+ - ⚡ **Multiple Scan Depths**: Choose between local (fast), verified (AI-verified), or deep (comprehensive) scans
12
12
  - 🎯 **Low False Positives**: AI validation reduces noise by ~70%
13
13
  - 📊 **Multiple Output Formats**: Terminal, JSON, SARIF, or Markdown
14
14
  - 🔄 **Incremental Scanning**: Scan only changed files for faster CI/CD
@@ -40,11 +40,11 @@ This will open a browser window for GitHub authentication. Follow the prompts to
40
40
  ### 2. Run Your First Scan
41
41
 
42
42
  ```bash
43
- # Quick scan (fast, local-only)
43
+ # Local scan (fast, local-only)
44
44
  oculum scan .
45
45
 
46
- # Validated scan (AI-verified, recommended)
47
- oculum scan . --mode validated
46
+ # Verified scan (AI-verified, recommended)
47
+ oculum scan . --mode verified
48
48
 
49
49
  # Deep scan (comprehensive analysis)
50
50
  oculum scan . --mode deep
@@ -64,7 +64,7 @@ Scan a directory or file for security vulnerabilities.
64
64
 
65
65
  **Options:**
66
66
 
67
- - `-d, --depth <mode>` - Scan depth: `cheap`, `validated`, or `deep` (default: `cheap`)
67
+ - `-d, --depth <mode>` - Scan depth: `local`, `verified`, or `deep` (default: `local`)
68
68
  - `-f, --format <format>` - Output format: `terminal`, `json`, `sarif`, or `markdown` (default: `terminal`)
69
69
  - `-o, --output <file>` - Write output to file instead of stdout
70
70
  - `--incremental` - Only scan files changed since last commit (git required)
@@ -73,14 +73,14 @@ Scan a directory or file for security vulnerabilities.
73
73
  **Examples:**
74
74
 
75
75
  ```bash
76
- # Scan current directory with validated mode
77
- oculum scan . --mode validated
76
+ # Scan current directory with verified mode
77
+ oculum scan . --mode verified
78
78
 
79
79
  # Scan specific file with JSON output
80
80
  oculum scan src/api/auth.ts --format json
81
81
 
82
82
  # Incremental scan for CI/CD
83
- oculum scan . --incremental --mode validated
83
+ oculum scan . --incremental --mode verified
84
84
 
85
85
  # Save results to file
86
86
  oculum scan . --output results.sarif --format sarif
@@ -123,14 +123,14 @@ Remove stored credentials and log out.
123
123
 
124
124
  ## Scan Depth Modes
125
125
 
126
- ### Cheap (Free)
126
+ ### Local (Free)
127
127
 
128
128
  - **Speed**: Very fast (~5-10s for 100 files)
129
129
  - **Cost**: Free, runs locally
130
130
  - **Detection**: Pattern-based detection (Layer 1 + Layer 2)
131
131
  - **Use Case**: Quick checks, pre-commit hooks, local development
132
132
 
133
- ### Validated (Pro)
133
+ ### Verified (Pro)
134
134
 
135
135
  - **Speed**: Moderate (~30-60s for 100 files)
136
136
  - **Cost**: Paid, requires API key
@@ -150,7 +150,7 @@ Create `oculum.config.json` in your project root:
150
150
 
151
151
  ```json
152
152
  {
153
- "depth": "validated",
153
+ "depth": "verified",
154
154
  "format": "terminal",
155
155
  "ignore": [
156
156
  "**/node_modules/**",
@@ -166,7 +166,7 @@ Create `oculum.config.json` in your project root:
166
166
 
167
167
  **Options:**
168
168
 
169
- - `depth` - Default scan depth (`cheap`, `validated`, `deep`)
169
+ - `depth` - Default scan depth (`local`, `verified`, `deep`)
170
170
  - `format` - Default output format (`terminal`, `json`, `sarif`, `markdown`)
171
171
  - `ignore` - Glob patterns to exclude from scanning
172
172
  - `include` - Glob patterns to include in scanning (overrides ignore)
@@ -276,7 +276,7 @@ jobs:
276
276
  run: echo "${{ secrets.OCULUM_API_KEY }}" | oculum login --stdin
277
277
 
278
278
  - name: Scan
279
- run: oculum scan . --mode validated --format sarif --output results.sarif
279
+ run: oculum scan . --mode verified --format sarif --output results.sarif
280
280
 
281
281
  - name: Upload SARIF
282
282
  uses: github/codeql-action/upload-sarif@v2
@@ -292,7 +292,7 @@ security_scan:
292
292
  script:
293
293
  - npm install -g @oculum/cli
294
294
  - echo "$OCULUM_API_KEY" | oculum login --stdin
295
- - oculum scan . --mode validated --format json --output results.json
295
+ - oculum scan . --mode verified --format json --output results.json
296
296
  artifacts:
297
297
  reports:
298
298
  codequality: results.json
@@ -316,7 +316,7 @@ security_scan:
316
316
  **Solution**:
317
317
  - Check your usage: `oculum status`
318
318
  - Upgrade to Pro tier for higher limits
319
- - Use `--mode cheap` for unlimited local scans
319
+ - Use `--mode local` for unlimited local scans
320
320
 
321
321
  **Problem**: Too many files being scanned
322
322
 
@@ -330,7 +330,7 @@ security_scan:
330
330
  **Problem**: Scans are slow
331
331
 
332
332
  **Solution**:
333
- - Use `--mode cheap` for faster local scans
333
+ - Use `--mode local` for faster local scans
334
334
  - Enable incremental scanning: `--incremental`
335
335
  - Reduce scope with ignore patterns
336
336
  - Scan only changed files in CI/CD
@@ -364,14 +364,14 @@ export OCULUM_API_KEY="your-key-here"
364
364
  ## Pricing
365
365
 
366
366
  ### Free Tier
367
- - ✅ Unlimited cheap (local) scans
367
+ - ✅ Unlimited local scans
368
368
  - ✅ Basic CLI access
369
369
  - ✅ All output formats
370
- - ❌ No validated/deep scans
370
+ - ❌ No verified/deep scans
371
371
 
372
372
  ### Pro Tier
373
373
  - ✅ Everything in Free
374
- - ✅ Validated scans (AI-verified)
374
+ - ✅ Verified scans (AI-verified)
375
375
  - ✅ Deep scans (semantic analysis)
376
376
  - ✅ API access
377
377
  - ✅ Priority support
@@ -386,7 +386,7 @@ export OCULUM_API_KEY="your-key-here"
386
386
  #!/bin/bash
387
387
  # .git/hooks/pre-commit
388
388
 
389
- oculum scan . --mode cheap --format terminal
389
+ oculum scan . --mode local --format terminal
390
390
  if [ $? -ne 0 ]; then
391
391
  echo "Security issues found. Commit blocked."
392
392
  exit 1
@@ -397,7 +397,7 @@ fi
397
397
 
398
398
  ```bash
399
399
  # Scan on file changes
400
- oculum watch src/ --mode cheap
400
+ oculum watch src/ --mode local
401
401
  ```
402
402
 
403
403
  ### Scan Specific File Types