CLI Reference

Complete Command-Line Interface Documentation

NAAb Pivot provides a comprehensive CLI for analyzing, synthesizing, validating, and benchmarking code evolution.

Global Options
Commands
- analyze
- synthesize
- validate
- benchmark
- evolve
- migrate
- dashboard
Environment Variables
Configuration Files
Exit Codes
Examples

Global Options

These options apply to all commands:

./naab/build/naab-lang pivot.naab [GLOBAL OPTIONS] <command> [COMMAND OPTIONS]

`--help, -h`

Display help information

./naab/build/naab-lang pivot.naab --help
./naab/build/naab-lang pivot.naab analyze --help

`--version, -v`

Display version information

./naab/build/naab-lang pivot.naab --version
# Output: NAAb Pivot v1.0.0

`--verbose`

Enable verbose logging

./naab/build/naab-lang pivot.naab --verbose analyze slow.py

`--quiet, -q`

Suppress all output except errors

./naab/build/naab-lang pivot.naab --quiet evolve slow.py

`--profile <name>`

Select optimization profile

Options: ultra-safe, conservative, balanced (default), aggressive, experimental, minimal, embedded, wasm

./naab/build/naab-lang pivot.naab --profile aggressive evolve slow.py

`--output <path>`

Set output directory for vessels

./naab/build/naab-lang pivot.naab --output ./build/vessels evolve slow.py

`--format <format>`

Set report output format

Options: json (default), html, csv, sarif, markdown

./naab/build/naab-lang pivot.naab --format html benchmark ./vessels

`--governance-override`

Override governance checks (use with caution)

./naab/build/naab-lang pivot.naab --governance-override evolve slow.py

`--governance-report <path>`

Generate governance compliance report

./naab/build/naab-lang pivot.naab --governance-report report.json evolve slow.py

Commands

analyze

Analyze source code for optimization opportunities

Synopsis

./naab/build/naab-lang pivot.naab analyze <file> [OPTIONS]

Options

`--language <lang>`

Force language detection (auto-detected by default)

Options: python, ruby, javascript, naab, php, java, go, csharp

./naab/build/naab-lang pivot.naab analyze script.txt --language python

`--min-complexity <n>`

Only report functions with complexity >= n (default: 5)

./naab/build/naab-lang pivot.naab analyze slow.py --min-complexity 10

`--target <lang>`

Force target language recommendation

Options: go, cpp, rust, ruby, js, php, zig, julia

./naab/build/naab-lang pivot.naab analyze slow.py --target rust

`--hotspot-only`

Only analyze functions detected as hotspots (requires profiling data)

./naab/build/naab-lang pivot.naab analyze slow.py --hotspot-only --profile-data profile.json

`--profile-data <path>`

Use profiling data for hotspot detection

./naab/build/naab-lang pivot.naab analyze slow.py --profile-data cProfile.prof

`--json-output <path>`

Write analysis blueprint to JSON file

./naab/build/naab-lang pivot.naab analyze slow.py --json-output analysis.json

Examples

Basic analysis:

./naab/build/naab-lang pivot.naab analyze slow_compute.py

Output:

{
  "status": "ANALYZED",
  "source": "PYTHON",
  "functions": [
    {
      "name": "heavy_computation",
      "complexity": 8,
      "target": "GO"
    }
  ]
}

Force Rust target:

./naab/build/naab-lang pivot.naab analyze slow.py --target rust > blueprint.json

Profile-guided analysis:

# Generate profile data
python -m cProfile -o slow.prof slow.py

# Analyze with profiling
./naab/build/naab-lang pivot.naab analyze slow.py \
  --profile-data slow.prof \
  --hotspot-only

synthesize

Generate optimized vessel code from analysis blueprint

Synopsis

./naab/build/naab-lang pivot.naab synthesize <blueprint.json> [OPTIONS]

Options

`--profile <name>`

Optimization profile (overrides global)

./naab/build/naab-lang pivot.naab synthesize blueprint.json --profile aggressive

`--parallel <n>`

Compile N vessels in parallel (default: CPU count)

./naab/build/naab-lang pivot.naab synthesize blueprint.json --parallel 8

`--no-cache`

Disable vessel cache (force recompilation)

./naab/build/naab-lang pivot.naab synthesize blueprint.json --no-cache

`--enable-simd`

Enable SIMD optimizations (AVX2, AVX-512)

./naab/build/naab-lang pivot.naab synthesize blueprint.json --enable-simd

`--enable-lto`

Enable Link-Time Optimization

./naab/build/naab-lang pivot.naab synthesize blueprint.json --enable-lto

`--strip-debug`

Strip debug symbols from binaries

./naab/build/naab-lang pivot.naab synthesize blueprint.json --strip-debug

`--template-dir <path>`

Use custom template directory

./naab/build/naab-lang pivot.naab synthesize blueprint.json --template-dir ./custom-templates

Examples

Basic synthesis:

./naab/build/naab-lang pivot.naab synthesize analysis.json

Output:

  [SYNTHESIZER] Loading blueprint: analysis.json
  [SYNTHESIZER] Generating heavy_computation (GO)...
    ✓ Code generated: vessels/heavy_computation_GO.go
    ✓ Compiling...
    ✓ Compilation successful: vessels/heavy_computation_vessel

Aggressive optimization:

./naab/build/naab-lang pivot.naab synthesize blueprint.json \
  --profile aggressive \
  --enable-simd \
  --enable-lto \
  --strip-debug

Parallel compilation:

./naab/build/naab-lang pivot.naab synthesize blueprint.json --parallel 16

validate

Validate parity between legacy and vessel implementations

Synopsis

./naab/build/naab-lang pivot.naab validate <legacy> <vessel> [OPTIONS]

Options

`--test-count <n>`

Number of test cases to run (default: 100)

./naab/build/naab-lang pivot.naab validate slow.py vessel --test-count 1000

`--tolerance <float>`

Maximum allowed relative error (default: 0.001 = 0.1%)

./naab/build/naab-lang pivot.naab validate slow.py vessel --tolerance 0.01

`--confidence <float>`

Required confidence level (default: 0.9999 = 99.99%)

./naab/build/naab-lang pivot.naab validate slow.py vessel --confidence 0.999

`--test-cases <file>`

Use custom test cases from JSON file

./naab/build/naab-lang pivot.naab validate slow.py vessel --test-cases cases.json

Format (cases.json):

{
  "test_cases": [
    {"input": [1, 2, 3], "expected": 6},
    {"input": [10, 20], "expected": 30}
  ]
}

`--fuzz-test`

Enable fuzz testing (random inputs)

./naab/build/naab-lang pivot.naab validate slow.py vessel --fuzz-test --test-count 10000

`--property-based`

Enable property-based testing (QuickCheck-style)

./naab/build/naab-lang pivot.naab validate slow.py vessel --property-based

`--report <path>`

Save validation report to file

./naab/build/naab-lang pivot.naab validate slow.py vessel --report validation.json

Examples

Basic validation:

./naab/build/naab-lang pivot.naab validate slow_compute.py vessels/heavy_computation_vessel

Output:

  [VALIDATOR] Comparing implementations...
    Legacy: slow_compute.py
    Vessel: vessels/heavy_computation_vessel

  Running 100 test cases...
  ✓ Test 0: ✓ (error: 0.00001%)
  ...
  ✓ Test 99: ✓ (error: 0.00001%)

  ═══════════════════════════════════════════════
  ✅ PARITY CERTIFIED
  ═══════════════════════════════════════════════

  Performance:
    Legacy: 2843ms
    Vessel: 812ms
    Speedup: 3.5x ⚡

Strict validation:

./naab/build/naab-lang pivot.naab validate slow.py vessel \
  --test-count 10000 \
  --tolerance 0.0001 \
  --confidence 0.99999

Fuzz testing:

./naab/build/naab-lang pivot.naab validate slow.py vessel \
  --fuzz-test \
  --test-count 100000 \
  --report fuzz-results.json

benchmark

Run performance benchmarks on vessels

Synopsis

./naab/build/naab-lang pivot.naab benchmark <vessel-dir> [OPTIONS]

Options

`--iterations <n>`

Number of benchmark iterations (default: 100)

./naab/build/naab-lang pivot.naab benchmark vessels/ --iterations 1000

`--warmup <n>`

Number of warmup iterations (default: 10)

./naab/build/naab-lang pivot.naab benchmark vessels/ --warmup 50

`--baseline <file>`

Compare against baseline results

./naab/build/naab-lang pivot.naab benchmark vessels/ --baseline baseline.json

`--regression-threshold <percent>`

Fail if performance degrades by more than N% (default: 10)

./naab/build/naab-lang pivot.naab benchmark vessels/ \
  --baseline baseline.json \
  --regression-threshold 5

`--save-baseline <file>`

Save current results as new baseline

./naab/build/naab-lang pivot.naab benchmark vessels/ --save-baseline baseline.json

`--format <format>`

Output format (json, html, csv, sarif)

./naab/build/naab-lang pivot.naab benchmark vessels/ --format html > report.html

`--compare`

Compare multiple vessels

./naab/build/naab-lang pivot.naab benchmark vessels/ --compare

Examples

Basic benchmark:

./naab/build/naab-lang pivot.naab benchmark vessels/

Output:

  [BENCHMARK] Running benchmark suite: vessels/

  Benchmark: heavy_computation_vessel
    Iterations: 100
    Mean: 812.34ms
    Median: 812.00ms
    P95: 814.50ms
    P99: 815.00ms

  ✓ Benchmark complete: vessels/benchmark-report.json

Regression detection:

./naab/build/naab-lang pivot.naab benchmark vessels/ \
  --baseline previous-run.json \
  --regression-threshold 5

HTML report:

./naab/build/naab-lang pivot.naab benchmark vessels/ \
  --format html \
  --output benchmark-report.html

evolve

Run full evolution pipeline (analyze → synthesize → validate → benchmark)

Synopsis

./naab/build/naab-lang pivot.naab evolve <file> [OPTIONS]

Options

Accepts all options from analyze, synthesize, validate, and benchmark commands.

Common Options

--profile <name>           # Optimization profile
--target <lang>            # Force target language
--min-complexity <n>       # Minimum complexity threshold
--test-count <n>           # Validation test count
--tolerance <float>        # Validation tolerance
--format <format>          # Report format
--output <path>            # Output directory

Examples

Basic evolution:

./naab/build/naab-lang pivot.naab evolve slow_compute.py

Output:

╔══════════════════════════════════════════════╗
║        NAAb Pivot - Code Evolution           ║
╚══════════════════════════════════════════════╝

[1/4] Analyzing...
  ✓ Detected: Python
  ✓ Found 1 function: heavy_computation
  ✓ Recommended target: GO

[2/4] Synthesizing...
  ✓ Generated: vessels/heavy_computation_GO.go
  ✓ Compiled: vessels/heavy_computation_vessel

[3/4] Validating...
  ✓ Running 100 test cases...
  ✓ PARITY CERTIFIED (99.99% confidence)

[4/4] Benchmarking...
  ✓ Legacy: 2843ms
  ✓ Vessel: 812ms
  ✓ Speedup: 3.5x ⚡

═══════════════════════════════════════════════
✅ EVOLUTION COMPLETE
═══════════════════════════════════════════════

Vessels: ./vessels/
Reports: ./vessels/evolution-report.json

Aggressive optimization:

./naab/build/naab-lang pivot.naab evolve slow.py \
  --profile aggressive \
  --target rust \
  --enable-simd \
  --enable-lto \
  --test-count 1000

Generate HTML report:

./naab/build/naab-lang pivot.naab evolve slow.py --format html > report.html

migrate

Create incremental migration plan for large codebases

Synopsis

./naab/build/naab-lang migrate.naab create_migration_plan <project-dir> [OPTIONS]

Options

`--min-score <n>`

Minimum optimization score to include (default: 50)

./naab/build/naab-lang migrate.naab create_migration_plan ./project --min-score 80

`--phases <n>`

Number of migration phases (default: 4)

./naab/build/naab-lang migrate.naab create_migration_plan ./project --phases 6

`--output <path>`

Save migration plan to file

./naab/build/naab-lang migrate.naab create_migration_plan ./project --output plan.json

`--estimate-effort`

Include time/resource estimates

./naab/build/naab-lang migrate.naab create_migration_plan ./project --estimate-effort

Examples

Create migration plan:

./naab/build/naab-lang migrate.naab create_migration_plan /path/to/large/project

Output:

{
  "status": "PLAN_CREATED",
  "total_files": 156,
  "candidates": [
    {
      "file": "core/sales_aggregator.py",
      "score": 92.3,
      "estimated_speedup": 12.5,
      "functions": [...]
    }
  ],
  "phases": [
    {
      "phase": 1,
      "name": "Low-hanging fruit",
      "files": 12,
      "estimated_effort_weeks": 6
    }
  ]
}

dashboard

Launch web dashboard for visualization

Synopsis

./naab/build/naab-lang dashboard.naab [OPTIONS]

Options

`--port <n>`

Dashboard port (default: 8080)

./naab/build/naab-lang dashboard.naab --port 3000

`--host <addr>`

Bind address (default: 0.0.0.0)

./naab/build/naab-lang dashboard.naab --host localhost

`--workspace <path>`

Workspace directory to monitor (default: ./workspace)

./naab/build/naab-lang dashboard.naab --workspace /path/to/projects

Examples

./naab/build/naab-lang dashboard.naab

# Output:
# 📊 Dashboard URL: http://localhost:8080
# 🚀 Press Ctrl+C to stop

Environment Variables

`PIVOT_OUTPUT`

Default output directory for vessels

export PIVOT_OUTPUT=/opt/vessels
./naab/build/naab-lang pivot.naab evolve slow.py

`PIVOT_PROFILE`

Default optimization profile

export PIVOT_PROFILE=aggressive
./naab/build/naab-lang pivot.naab evolve slow.py

`PIVOT_TOLERANCE`

Default validation tolerance

export PIVOT_TOLERANCE=0.01  # 1%
./naab/build/naab-lang pivot.naab validate slow.py vessel

`PIVOT_WORKSPACE`

Workspace directory for dashboard

export PIVOT_WORKSPACE=/path/to/projects
./naab/build/naab-lang dashboard.naab

`PIVOT_DASHBOARD_PORT`

Dashboard port

export PIVOT_DASHBOARD_PORT=3000
./naab/build/naab-lang dashboard.naab

Configuration Files

Global Config: `~/.pivotrc`

{
  "profile": "balanced",
  "output": "~/vessels",
  "format": "json",
  "test_count": 100,
  "tolerance": 0.001,
  "parallel": 8,
  "enable_simd": false,
  "enable_lto": false
}

Project Config: `./.pivotrc`

Overrides global config for current project:

{
  "project_name": "MyProject",
  "profile": "aggressive",
  "output": "./build/vessels",
  "enable_simd": true,
  "enable_lto": true,
  "governance": {
    "enforce": true,
    "config": "./govern.json"
  }
}

Exit Codes

Code	Meaning
0	Success
1	General error
2	Invalid arguments
3	Analysis failed
4	Synthesis failed (compilation error)
5	Validation failed (parity NOT certified)
6	Benchmark failed (regression detected)
7	Governance violation
8	File not found
9	Permission denied
10	Timeout

Examples

Example 1: Quick Evolution

./naab/build/naab-lang pivot.naab evolve slow.py

Example 2: Custom Profile & Target

./naab/build/naab-lang pivot.naab evolve slow.py \
  --profile aggressive \
  --target rust

Example 3: Strict Validation

./naab/build/naab-lang pivot.naab evolve slow.py \
  --test-count 10000 \
  --tolerance 0.0001 \
  --confidence 0.99999

Example 4: Pipeline with HTML Report

./naab/build/naab-lang pivot.naab evolve slow.py \
  --format html \
  --output ./reports/evolution.html

Example 5: Incremental Migration

# Analyze project
./naab/build/naab-lang migrate.naab create_migration_plan ./my-project > plan.json

# Evolve Phase 1 files
for file in $(jq -r '.phases[0].files[]' plan.json); do
  ./naab/build/naab-lang pivot.naab evolve "$file"
done

Example 6: CI/CD Integration

# Run in CI pipeline
./naab/build/naab-lang pivot.naab benchmark vessels/ \
  --baseline baseline.json \
  --regression-threshold 5 \
  --format sarif > benchmark.sarif

# Upload to GitHub Code Scanning
gh api repos/:owner/:repo/code-scanning/sarifs \
  --method POST \
  --field sarif=@benchmark.sarif

Next: API Reference | Profiles Guide

FilesExpand file tree

cli-reference.md

Latest commit

History

cli-reference.md

File metadata and controls

CLI Reference

Table of Contents

Global Options

--help, -h

--version, -v

--verbose

--quiet, -q

--profile <name>

--output <path>

--format <format>

--governance-override

--governance-report <path>

Commands

analyze

Synopsis

Options

--language <lang>

--min-complexity <n>

--target <lang>

--hotspot-only

--profile-data <path>

--json-output <path>

Examples

synthesize

Synopsis

Options

--profile <name>

--parallel <n>

--no-cache

--enable-simd

--enable-lto

--strip-debug

--template-dir <path>

Examples

validate

Synopsis

Options

--test-count <n>

--tolerance <float>

--confidence <float>

--test-cases <file>

--fuzz-test

--property-based

--report <path>

Examples

benchmark

Synopsis

Options

--iterations <n>

--warmup <n>

--baseline <file>

--regression-threshold <percent>

--save-baseline <file>

--format <format>

--compare

Examples

evolve

Synopsis

Options

Common Options

Examples

migrate

Synopsis

Options

--min-score <n>

--phases <n>

--output <path>

--estimate-effort

Examples

dashboard

Synopsis

Options

--port <n>

--host <addr>

`--help, -h`

`--version, -v`

`--verbose`

`--quiet, -q`

`--profile <name>`

`--output <path>`

`--format <format>`

`--governance-override`

`--governance-report <path>`

`--language <lang>`

`--min-complexity <n>`

`--target <lang>`

`--hotspot-only`

`--profile-data <path>`

`--json-output <path>`

`--profile <name>`

`--parallel <n>`

`--no-cache`

`--enable-simd`

`--enable-lto`

`--strip-debug`

`--template-dir <path>`

`--test-count <n>`

`--tolerance <float>`

`--confidence <float>`

`--test-cases <file>`

`--fuzz-test`

`--property-based`

`--report <path>`

`--iterations <n>`

`--warmup <n>`

`--baseline <file>`

`--regression-threshold <percent>`

`--save-baseline <file>`

`--format <format>`

`--compare`

`--min-score <n>`

`--phases <n>`

`--output <path>`

`--estimate-effort`

`--port <n>`

`--host <addr>`

`--workspace <path>`

`PIVOT_OUTPUT`

`PIVOT_PROFILE`

`PIVOT_TOLERANCE`

`PIVOT_WORKSPACE`

`PIVOT_DASHBOARD_PORT`

Global Config: `~/.pivotrc`

Project Config: `./.pivotrc`