Reference
CLI reference model
How Vadyl.Cli discovers commands, binds arguments and flags, dispatches canonical operations, returns JSON, handles auth, and reports exit codes.
CLICLI command referenceEvery command group, subcommand, flag, sample output, and exit code for automation and CI.CodingCoding environment referenceWorkspace commands, runtime SDK surfaces, source assets, tests, deploys, and local execution.RESTREST controller atlasEvery controller-backed endpoint with parameters, request examples, responses, errors, and samples.SDKSDK method referenceEvery client method across TypeScript, Python, C#, Go, and Rust with inputs, returns, and errors.ErrorsErrors referenceCanonical error envelopes, HTTP status mapping, machine-readable codes, reason codes, and correlation IDs.
The full command list lives at the CLI reference. This page documents the model behind it: the CLI is a thin runtime dispatcher over the Cli contract projection facet, not a parallel hand-authored API.
Bootstrap and descriptor flow
- Parse global options and environment variables.
- Bootstrap
status,version, andintrospectionlocally if needed. - Fetch
GET /api/ContractProjection/cliwith ETag caching. - Longest-prefix match the command path against descriptor commands.
- Bind path arguments, query options, headers, and body fields.
- Dispatch the canonical operation over HTTP and print structured output.
Global options
| Option/env | Meaning |
|---|---|
--api-base-url / VADYL_API_BASE_URL | API base URL. |
--api-key / VADYL_API_KEY | Service credential key. |
--api-secret / VADYL_API_SECRET | Service credential secret. |
--tenant-id / VADYL_TENANT_ID | Tenant scope. |
--project-id / VADYL_PROJECT_ID | Project scope. |
--output json | Stable JSON output for scripts. |
Command invocation
vadyl schema preview \ --target production \ --output json
Exit codes
| Code | Meaning |
|---|---|
0 | Success. |
1 | Request failed with a Vadyl error envelope. |
2 | Usage or argument binding error. |
3 | Descriptor fetch or compatibility failure. |
4 | Local environment or auth bootstrap failure. |
JSON output contract
Script against JSON, not display strings. Errors preserve the same envelope as REST.
{
"error": {
"code": "VALIDATION_FAILED",
"reasonCode": "Cli.Argument.MissingRequired",
"message": "Missing required option --schema",
"correlationId": "local:cli:..."
}
}