Scanverion.Cli 0.1.1

Scanverion CLI

The CLI uses the curated .NET SDK and keeps API keys out of command arguments.

Install from NuGet

Install Scanverion.Cli from NuGet.org using the .NET SDK. The global tool targets .NET 8 and requires the .NET 8 runtime to run.

dotnet tool install --global Scanverion.Cli --version 0.1.1
scanverion --help

To update an existing installation:

dotnet tool update --global Scanverion.Cli --version 0.1.1

Document and vehicle commands use Detection. They do not expose a Scanner option; use an SDK or the REST API for OCR and field extraction.

Configure and run

$env:SCANVERION_API_KEY = "skv_..."
$env:SCANVERION_API_URL = "https://api.scanverion.com"

scanverion doctor
scanverion auth test --output json
scanverion document process .\invoice.pdf --output json
scanverion vehicle process .\car.jpg --output json
scanverion batch process .\samples --output json
scanverion usage show --output json

For repository development, replace scanverion with dotnet run --project apps/cli/Scanverion.Cli.csproj -- and set SCANVERION_API_URL to your local API origin.

doctor does not require an API key. auth test, document processing, and usage queries require SCANVERION_API_KEY. JSON output is stable for automation; diagnostics and errors are written to stderr.

Exit codes are stable: 0 success, 1 API or service failure, 2 command or input error, and 3 authentication failure.

Identity templates and camera liveness

scanverion template create portrait.png second-view.jpg --processing-authorized --idempotency-key create-001 --save-template template.json
scanverion template compare template.json candidate.png --processing-authorized --idempotency-key compare-001 --output json
scanverion liveness create --processing-authorized --idempotency-key liveness-001 --save-session session.json --output json
scanverion liveness result session.json --output json

Create commands require a new output file and never overwrite an existing file. Files are owner-only on Windows and mode 0600 on Unix. Templates and session access tokens are saved there, never printed or accepted as command arguments. Secure, transfer and delete these files according to your biometric-data policy. An unsuccessful request can leave an empty file; investigate uncertain completion before removing it or resubmitting.

Template creation accepts 1-8 JPEG/PNG images (10 MiB each, 40 MiB total). Comparison accepts a template JSON file or one portrait per side; create a multi-view template first for multi-view references. Each successful operation costs 2 credits and requires a 1-96 character key. Cosine similarity always needs human review, not an identity verdict.

Liveness creation reserves credits and returns capture metadata, not an assessment. Complete the session in a trusted browser/mobile AWS Amplify capture client using the privately saved metadata, then run liveness result once. The CLI cannot operate a camera; the website try-out creates a different session. Valid completed assessments cost 6 credits regardless of pass/fail. These commands never automatically retry or poll. No real camera or billable-provider test is performed by the CLI test suite.

Face comparison

Release 0.1.1 includes independent face comparison. For repository development:

dotnet run --project apps/cli/Scanverion.Cli.csproj -- face compare reference.jpg candidate.png --idempotency-key face-comparison-001 --output json

The equivalent installed command after release is scanverion face compare reference.jpg candidate.png --idempotency-key face-comparison-001 --output json. Inputs must be JPEG or PNG, at most 10 MB each; --policy balanced is optional. It does not run Detection or Scanner. Results include similarity, decision, review reasons, bounds, landmarks, and credits. Obtain approval before processing face images. Similarity is not identity proof or liveness. Successful requests use the configured workspace price. Automatic retries are disabled; reuse a key only for the same logical request and investigate uncertain completion before resubmitting.

Self-contained publishing

The release script publishes single-file, self-contained binaries for the six supported desktop and server targets:

npm run cli:publish

Use -RuntimeIdentifiers win-x64 or another subset when validating locally. Outputs are written under .tmp-cli-publish/<runtime>. Each target must be built and smoke-tested independently before release.