Verisco
Documentation

VERISCO Shield Integrate

The analyzer CLI

verisco-analyzer scans your project, writes the integration into it, checks that it works, and turns protection on.

Install#

Shell
curl -fsSL https://your-verisco-host/api/v1/cli/install | sh

The installer downloads the CLI from your VERISCO platform and verifies its SHA-256 checksum before installing it. It needs Node.js. The platform address is remembered in ~/.verisco/platform-url, so later commands do not need --platform-url.

It is not on the public npm registry

npx and npm install -g resolve against the public registry, which does not have this package. Use the command above.

Commands#

Command What it does
verisco-analyzer analyze <path> Scans an application directory for authentication code.
verisco-analyzer apply [path] Mounts the middleware. With --api-key, also applies the per-file edits from your AI guide. Backs up every file it touches.
verisco-analyzer verify [path] Checks the integration and reports the result to your console.
verisco-analyzer download-key Downloads your tenant's RS256 public key.
verisco-analyzer go-live Turns protection on. Refused until verify has confirmed the middleware and the key.
verisco-analyzer go-back Returns to pass-through. Nobody is blocked, and there is no DNS change.

Options#

Option Applies to Meaning
--api-key <key> All but a plain analyze Your analyzer key, from your integration page in the console.
--platform-url <url> All Your VERISCO platform. Defaults to the one the installer fetched the CLI from, then $VERISCO_PLATFORM_URL.
--json <file> analyze Save the report as JSON.
--output <file> analyze Save the report as Markdown.
--output <path> download-key Where to save the key. Default verisco_public.pem under ./config/.
--use-ai analyze AI-first analysis. See below.
--ci analyze Non-interactive: no prompts, JSON on standard output.

Two ways to analyze#

Standard#

Shell
verisco-analyzer analyze ./my-app --json report.json

Runs entirely on your machine. It builds your project's import graph, including tsconfig and jsconfig path aliases, narrows it to the files that deal with authentication, and reports what it found. Upload report.json on your integration page for a guide tailored to your code.

AI-first#

Shell
verisco-analyzer analyze ./my-app --use-ai --api-key <your analyzer key>

Sends the authentication-related files, and only those, to your VERISCO platform, which returns a structured guide: which files to change and exactly how. The guide is validated and security-reviewed before it is shown to you.

What is sent The files the import graph marks as authentication-related. Not your whole repository.
Rate limit 5 analyses per hour, per tenant.
Where the result goes Your integration page, and apply can write it.

Apply#

Shell
verisco-analyzer apply --api-key <your analyzer key>

Mounts the middleware at your application's entry point and applies the guide's edits. Three safeguards:

  • every file is backed up before it is changed;
  • an edit is refused unless the file on disk still matches what the guide was written against;
  • an edit that would leave a file that no longer parses is not written.

Review the changes with your version control before you commit them.

In a pipeline#

Shell
verisco-analyzer analyze ./my-app --use-ai --ci --api-key "$VERISCO_ANALYZER_KEY"

Keep the key in your pipeline's secret store.

Something missing or wrong on this page? Tell us and we will fix it.

↑↓ to move Enter to open Esc to close