CLI Reference

Installation

No installation required — run directly with npx:

npx @sprinno/scan

Or install globally:

npm install -g @sprinno/scan

sprinno

Quick Start

Navigate to any project directory and run the scanner. On first run, you’ll be asked a few context questions (funding stage, sector, team size) that take about 30 seconds. These are used to benchmark you against similar companies.

cd /path/to/your/project

npx @sprinno/scan

The scan typically completes in 10–30 seconds and outputs:

• A terminal report with scores and findings
• A .sprinno.json machine-readable quality manifest

Commands

npx @sprinno/scan

npx @sprinno/scan --ci --fail-below 60 --card

npx @sprinno/scan setup

npx @sprinno/scan connect

Flags Reference

All flags are used with the scan command (or the default command).

npx @sprinno/scan --json

npx @sprinno/scan --card

npx @sprinno/scan --ci --fail-below 60

npx @sprinno/scan --ci --fail-below 70

npx @sprinno/scan --stage series-a

npx @sprinno/scan --format json

npx @sprinno/scan --version

npx @sprinno/scan --help

Output Files

{
  "$schema": "https://schema.sprinno.com/quality/v1",
  "version": 1,
  "overall": 67.4,
  "pillars": {
    "codeHealth": { "score": 72.8 },
    "processMaturity": { "score": 61.3 },
    "architecture": { "score": 68.0 },
    "resilience": { "score": 54.9 },
    "documentation": { "score": 70.1 }
  },
  "context": {
    "stage": "seed",
    "sector": "fintech",
    "teamSize": "small"
  }
}

# Embed in your README:
![Sprinno Quality Score](.sprinno-score.svg)

Configuration

Configuration is stored in ~/.sprinnorc (created during first-run setup). You can also set configuration via environment variables for CI/CD.

Configuration File

{
  "termsAccepted": true,
  "context": {
    "stage": "seed",
    "sector": "fintech",
    "teamSize": "small"
  },
  "reporting": true
}

Environment Variables

Override context in CI without interactive setup:

Disabling Telemetry

Set reporting: false in your .sprinnorc to opt out of anonymous score reporting. Scanning continues to work fully offline.

CI/CD Integration

GitHub Actions

name: Quality Gate
on: [push, pull_request]

jobs:
  quality:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - run: npx @sprinno/scan --ci --fail-below 60
        env:
          SPRINNO_STAGE: seed
          SPRINNO_SECTOR: fintech
          SPRINNO_TEAM_SIZE: small

GitHub Action (Marketplace)

- uses: sprinno/scan-action@v1
  with:
    fail-below: 60
    stage: seed
    sector: fintech
    team-size: small

GitLab CI

quality-gate:
  image: node:20
  script:
    - npx @sprinno/scan --ci --fail-below 60
  variables:
    SPRINNO_STAGE: seed
    SPRINNO_SECTOR: fintech
    SPRINNO_TEAM_SIZE: small

CI Mode Behavior

When using --ci, the scanner:

• Exits with code 0 if score ≥ threshold (pass)
• Exits with code 1 if score < threshold (fail)
• Reads context from environment variables (no interactive prompts)
• Still generates .sprinno.json for downstream consumption

What Gets Scanned

The scanner assesses your codebase across five engineering pillars. Each pillar contains multiple sub-metrics that are weighted by their empirical discrimination power (via Latent Capability Scoring).

Score Interpretation

Telemetry & Privacy

By default, Sprinno sends anonymous quality scores (numeric only) to improve the LCS calibration model for everyone. Source code is never sent.

Opt-out: Set "reporting": false in ~/.sprinnorc. Full details in our Terms and Privacy Policy.

Troubleshooting