Scanverion.Cli 0.1.0

Scanverion CLI

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

Download and install

Download Scanverion.Cli.0.1.0.nupkg from the developer tooling page. The package is a .NET global tool and requires the .NET 8 SDK or runtime. From the directory containing the download:

dotnet tool install --global Scanverion.Cli --version 0.1.0 --add-source .
scanverion --help

To upgrade a previously installed local package:

dotnet tool update --global Scanverion.Cli --version 0.1.0 --add-source .

The package is currently distributed directly and is not yet published to NuGet.org. The --add-source directory must contain the downloaded .nupkg file.

Configure and run

$env:SCANVERION_API_KEY = "skv_..."
$env:SCANVERION_API_URL = "http://localhost:5009"

dotnet run --project apps/cli/Scanverion.Cli.csproj -- doctor
dotnet run --project apps/cli/Scanverion.Cli.csproj -- auth test --output json
dotnet run --project apps/cli/Scanverion.Cli.csproj -- document process .\invoice.pdf --output json
dotnet run --project apps/cli/Scanverion.Cli.csproj -- vehicle process .\car.jpg --output json
dotnet run --project apps/cli/Scanverion.Cli.csproj -- batch process .\samples --output json
dotnet run --project apps/cli/Scanverion.Cli.csproj -- usage show --output json

After global installation, omit the dotnet run --project ... -- prefix:

scanverion doctor
scanverion auth test --output json
scanverion document process .\invoice.pdf --output json

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.

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.