Skip to main content
VelinStyle v1.4.0
⌂ Home

Docs for VelinStyle 1.4.x · verified against 1.4.0

CLI command fails or reports too much 1.4.0

Use the package-qualified CLI and narrow checks to the intended profile or severity. Deutsch

Run diagnostics

Problem

Commands 404, hang on huge trees, or flood the terminal with findings.

First check

Run the general diagnostic from the project directory first.

npx @birdapi/velinstyle doctor

Deeper check

npx @birdapi/velinstyle check . --profile app --json
npx @birdapi/velinstyle scan ./src --severity error

Quick check

  • Run commands from the intended project directory.
  • Use only documented profiles and flags.
  • Check again after every change.

The CLI package cannot be found

Cause: Bare npx velinstyle resolves the wrong package and often returns 404.

  1. Solution 1: Always call npx @birdapi/velinstyle <command>.
  2. Solution 2: Start with npx @birdapi/velinstyle doctor to confirm the local install.
  3. Solution 3: Avoid inventing flags; use documented commands only.
Verify again
npx @birdapi/velinstyle doctor
npx @birdapi/velinstyle check ./index.html --profile docs

A check returns too many findings

Cause: The profile or target is broader than the page you meant to validate.

  1. Solution 1: Pick one profile: marketing, app, docs, fragment, or ecommerce.
  2. Solution 2: Prefer a single file for docs work: check ./index.html --profile docs.
  3. Solution 3: For scans, raise the floor with --severity error on a focused path like ./src.
Verify again
npx @birdapi/velinstyle doctor
npx @birdapi/velinstyle check ./index.html --profile docs

Scan findings are not all auto-fixes

Cause: scan reports diagnostics, candidates, and SAFE/REVIEW/BLOCKED/UNKNOWN — only a small SAFE set can apply.

  1. Solution 1: Treat REVIEW / CANDIDATE as analysis only — never as automatic apply.
  2. Solution 2: Apply only when policy marks SAFE and the finding is fixable: true (five SAFE rules; use --fix-dry-run first).
  3. Solution 3: links/* stays Detect-only; BLOCKED/UNKNOWN must not be rewritten by automation.
Verify again
npx @birdapi/velinstyle scan ./src --fix-dry-run
npx @birdapi/velinstyle scan ./src --json
npx @birdapi/velinstyle scan ./src --sarif

Human Experience output may show a branding footer; --quiet, --json, SARIF, compact, and markdown suppress it. Details: CLI Experience · AI Resources.

Still broken?

Copy this template into a support request and add the outputs.

BirdAPI Forum · VelinStyle Support