CLI reference

Every command, every flag, every example. The CLI is a peer consumer of the canonical APIs — anything you can click in the dashboard, you can script here.

⌘ Kor/to search every method, command, and endpoint

OverviewCLI overviewInstall, configure, and use the CLI across product-model workflows.CLICLI reference modelHow commands project from the canonical operation model, auth scope, output contract, and exit behavior.SurfacesProject capability surfacesProject-authored, project-published, project-installed capability surfaces across manifests, grants, exposure bindings, PCG, SDK, CLI, MCP, and usage evidence.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.ErrorsErrors referenceCanonical error envelopes, HTTP status mapping, machine-readable codes, reason codes, and correlation IDs.LimitsLimits & quotasRate limits, hard and soft quotas, budget enforcement, usage metering, and retry guidance.

Authentication

`vadyl auth login`

vadyl auth login [--api-key <key>] [--api-secret <secret>] [--no-browser]

Flags

Name	Type	Description
`--api-key`	string	Programmatic API key (machine-to-machine).
`--api-secret`	string	Paired secret for the API key.
`--no-browser`	bool	Force device-code flow (no browser).

Examples

vadyl auth login

vadyl auth login --api-key "$VADYL_API_KEY" --api-secret "$VADYL_API_SECRET"

Sample output

{
  "command": "vadyl auth login",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl auth logout`

vadyl auth logout

Clear local credentials.

Examples

vadyl auth logout

Sample output

{
  "ok": true,
  "command": "vadyl auth logout",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`vadyl auth whoami`

vadyl auth whoami [--output json]

Show the current actor identity, scopes, and auth strength.

Examples

vadyl auth whoami

vadyl auth whoami --output json | jq '.subjectId'

Sample output

{
  "command": "vadyl auth whoami",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl auth token`

vadyl auth token [--ttl <duration>]

Print a fresh bearer token (refreshes automatically).

Flags

Name	Type	Description
`--ttl`	duration	Min remaining validity (e.g. 30m). Default 5m.

Examples

export VADYL_TOKEN="$(vadyl auth token)"

Sample output

{
  "command": "vadyl auth token",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl auth switch`

vadyl auth switch <tenant>

Switch active tenant.

Examples

vadyl auth switch acme

Sample output

{
  "command": "vadyl auth switch",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Projects

Create, suspend, archive, traverse the project hierarchy.

`vadyl project list`

vadyl project list [--parent <id>]

List projects in current scope.

Flags

Name	Type	Description
`--parent`	string	Filter to descendants of a parent.

Examples

vadyl project list

vadyl project list --parent acme/billing

Sample output

{
  "command": "vadyl project list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl project use`

vadyl project use <slug>

Set active project for subsequent commands.

Examples

vadyl project use orders-prod

Sample output

{
  "command": "vadyl project use",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl project create`

vadyl project create <slug> [--parent <id>] [--region <region>]

Create a new project (root or child).

Flags

Name	Type	Description
`--parent`	string	Parent project id for nested creation.
`--region`	string	Region binding.

Examples

vadyl project create my-app

vadyl project create checkout --parent acme/storefront --region us-east-1

Sample output

{
  "command": "vadyl project create",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl project show`

vadyl project show [<slug>] [--output json]

Inspect project metadata, hierarchy, capability grants.

Examples

vadyl project show orders-prod

Sample output

{
  "command": "vadyl project show",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl project suspend`

vadyl project suspend <slug>

Suspend the project (denies writes; reads still allowed).

Examples

vadyl project suspend orders-stg

Sample output

{
  "command": "vadyl project suspend",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl project resume`

vadyl project resume <slug>

Resume a suspended project.

Examples

vadyl project resume orders-stg

Sample output

{
  "command": "vadyl project resume",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl project archive`

vadyl project archive <slug>

Archive a project — read-only forever.

Examples

vadyl project archive legacy-app

Sample output

{
  "command": "vadyl project archive",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Entities

List, inspect, mutate canonical entities.

`vadyl entity list`

vadyl entity list [--output json]

List entities in the current project.

Examples

vadyl entity list

vadyl entity list --output json | jq '.[] | .name'

Sample output

{
  "command": "vadyl entity list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl entity get`

vadyl entity get <name> [--include relations,indexes,access] [--output json]

Show full entity definition.

Flags

Name	Type	Description
`--include`	csv	Sections to include — relations, indexes, access, validation.

Examples

vadyl entity get Order --include relations,indexes

Sample output

{
  "command": "vadyl entity get",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl entity create`

vadyl entity create <name> --schema <file>

Create entity from a typed schema file.

Flags

Name	Type	Description
`--schema`required	path	Path to schema (.vadyl.ts \| .json).

Examples

vadyl entity create Order --schema schema/Order.vadyl.ts

Sample output

{
  "command": "vadyl entity create",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl entity update`

vadyl entity update <name> --schema <file>

Apply schema changes to an existing entity.

Flags

Name	Type	Description
`--schema`required	path	Updated schema file.

Examples

vadyl entity update Order --schema schema/Order.vadyl.ts

Sample output

{
  "command": "vadyl entity update",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl entity delete`

vadyl entity delete <name> [--cascade]

Drop an entity and its data.

Flags

Name	Type	Description
`--cascade`	bool	Cascade delete dependent rows in related entities.

Examples

vadyl entity delete TempStaging --cascade

Sample output

{
  "ok": true,
  "command": "vadyl entity delete",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`vadyl entity diff`

vadyl entity diff <name> --against <branch|env>

Diff an entity definition between two branches/envs.

Flags

Name	Type	Description
`--against`required	string	Comparison target (branch name or environment).

Examples

vadyl entity diff Order --against production

Sample output

{
  "command": "vadyl entity diff",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Schema

Schema-transition pipeline operations.

`vadyl schema diff`

vadyl schema diff [--against <ref>]

Diff project schema against a target.

Flags

Name	Type	Description
`--against`	string	Branch / environment / snapshot ref. Default: current target.

Examples

vadyl schema diff --against production

Sample output

{
  "command": "vadyl schema diff",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl schema preview`

vadyl schema preview [--target <env>]

Plan schema transitions, show classification + reason codes.

Flags

Name	Type	Description
`--target`	string	Target environment.

Examples

vadyl schema preview --target sandbox

Sample output

{
  "command": "vadyl schema preview",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl schema apply`

vadyl schema apply [--target <env>] [--allow-destructive]

Apply pending schema transitions.

Flags

Name	Type	Description
`--target`	string	Target environment.
`--allow-destructive`	bool	Permit destructive ops with explicit acknowledgement.

Examples

vadyl schema apply --target staging

Sample output

{
  "command": "vadyl schema apply",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl schema snapshot`

vadyl schema snapshot create [--name <n>]

Create an immutable snapshot of current schema.

Flags

Name	Type	Description
`--name`	string	Optional name.

Examples

vadyl schema snapshot create --name pre-refunds

Sample output

{
  "command": "vadyl schema snapshot",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl schema restore`

vadyl schema restore <snapshot>

Restore schema from a snapshot.

Examples

vadyl schema restore snapshot:pre-refunds

Sample output

{
  "command": "vadyl schema restore",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl schema validate`

vadyl schema validate

Validate schema invariants (FK, keys, capability requirements) without applying.

Examples

vadyl schema validate

Sample output

{
  "command": "vadyl schema validate",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Branches

Manage branches and workspaces for the canonical contract.

`vadyl branch create`

vadyl branch create <name> [--from <base>]

Create a new branch.

Flags

Name	Type	Description
`--from`	string	Base branch (default: main).

Examples

vadyl branch create feature/refunds

Sample output

{
  "command": "vadyl branch create",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl branch list`

vadyl branch list

List all branches.

Examples

vadyl branch list

Sample output

{
  "command": "vadyl branch list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl branch switch`

vadyl branch switch <name>

Switch active branch.

Examples

vadyl branch switch feature/refunds

Sample output

{
  "command": "vadyl branch switch",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl branch head`

vadyl branch head [<branch>]

Show the HEAD commit of a branch.

Examples

vadyl branch head main

Sample output

{
  "command": "vadyl branch head",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl branch log`

vadyl branch log [<branch>] [--limit <n>]

Show commit history of a branch.

Flags

Name	Type	Description
`--limit`	int	Max commits (default: 25).

Examples

vadyl branch log feature/refunds

Sample output

{
  "command": "vadyl branch log",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl branch delete`

vadyl branch delete <name>

Delete a branch (must not have open proposals).

Examples

vadyl branch delete feature/refunds

Sample output

{
  "ok": true,
  "command": "vadyl branch delete",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

Sandboxes

Real-DB sandboxes per branch for testing.

`vadyl sandbox create`

vadyl sandbox create [--branch <name>] [--seed <ref>]

Provision a sandbox database for a branch.

Flags

Name	Type	Description
`--branch`	string	Branch (default: current).
`--seed`	string	Snapshot or production-latest.

Examples

vadyl sandbox create --branch feature/refunds --seed snapshot:latest

Sample output

{
  "command": "vadyl sandbox create",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl sandbox apply`

vadyl sandbox apply

Apply pending DDL to the sandbox.

Examples

vadyl sandbox apply

Sample output

{
  "command": "vadyl sandbox apply",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl sandbox destroy`

vadyl sandbox destroy [--branch <name>]

Tear down a sandbox.

Examples

vadyl sandbox destroy --branch feature/refunds

Sample output

{
  "command": "vadyl sandbox destroy",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl sandbox list`

vadyl sandbox list

List active sandboxes.

Examples

vadyl sandbox list

Sample output

{
  "command": "vadyl sandbox list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Proposals

Open / approve / merge typed proposals between branches.

`vadyl proposal open`

vadyl proposal open --title <t> --base <b> --head <h>

Open a proposal (head → base).

Flags

Name	Type	Description
`--title`required	string	Proposal title.
`--base`required	string	Target branch.
`--head`required	string	Source branch.

Examples

vadyl proposal open --title "Add refunds" --base main --head feature/refunds

Sample output

{
  "command": "vadyl proposal open",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl proposal list`

vadyl proposal list [--status open|merged|closed]

List proposals.

Examples

vadyl proposal list --status open

Sample output

{
  "command": "vadyl proposal list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl proposal show`

vadyl proposal show <id>

Show a proposal — diff, validation, approvals.

Examples

vadyl proposal show prop_abc

Sample output

{
  "command": "vadyl proposal show",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl proposal approve`

vadyl proposal approve <id>

Sign an approval on a proposal.

Examples

vadyl proposal approve prop_abc

Sample output

{
  "command": "vadyl proposal approve",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl proposal request-changes`

vadyl proposal request-changes <id> --comment <c>

Request changes with feedback.

Flags

Name	Type	Description
`--comment`required	string	Reviewer comment.

Examples

vadyl proposal request-changes prop_abc --comment "missing migration"

Sample output

{
  "command": "vadyl proposal request-changes",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl proposal merge`

vadyl proposal merge <id>

Merge a proposal once gates pass.

Examples

vadyl proposal merge prop_abc

Sample output

{
  "command": "vadyl proposal merge",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Deploy

Plan, apply, ramp, and roll back deployments.

`vadyl deploy preview`

vadyl deploy preview --target <env>

Show the planned change for a target.

Flags

Name	Type	Description
`--target`required	string	Environment name.

Examples

vadyl deploy preview --target production

Sample output

{
  "command": "vadyl deploy preview",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl deploy apply`

vadyl deploy apply --target <env> [--ramp <s>] [--bake <d>]

Apply current branch to a target with optional ramp.

Flags

Name	Type	Description
`--target`required	string	Environment.
`--ramp`	csv	Ramp percentages, e.g. 5%,25%,50%,100%.
`--bake`	duration	Bake time per ramp step.

Examples

vadyl deploy apply --target production --ramp 5%,25%,50%,100% --bake 10m

Sample output

{
  "command": "vadyl deploy apply",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl deploy rollback`

vadyl deploy rollback --target <env> --to <version>

Roll back to a prior publication version.

Flags

Name	Type	Description
`--target`required	string	Environment.
`--to`required	string	Publication version (e.g. v412).

Examples

vadyl deploy rollback --target production --to v412

Sample output

{
  "command": "vadyl deploy rollback",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl deploy status`

vadyl deploy status --target <env> [--follow]

Show ramp status and health gates.

Flags

Name	Type	Description
`--target`required	string	Environment.
`--follow`	bool	Stream until rollout completes.

Examples

vadyl deploy status --target production --follow

Sample output

{
  "command": "vadyl deploy status",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl deploy history`

vadyl deploy history --target <env>

Show deployment history.

Flags

Name	Type	Description
`--target`required	string	Environment.

Examples

vadyl deploy history --target production

Sample output

{
  "command": "vadyl deploy history",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Build

Hermetic builds for authored runtime artifacts.

`vadyl build build`

vadyl build [<unit>]

Build authored runtime artifacts (deterministic, signed).

Examples

vadyl build

vadyl build src/handlers/orders/charge.ts

Sample output

{
  "command": "vadyl build build",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl build publish`

vadyl build publish [--unit <u>]

Publish a built artifact to the registry.

Flags

Name	Type	Description
`--unit`	string	Unit id (default: all).

Examples

vadyl build publish

Sample output

{
  "command": "vadyl build publish",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl build verify`

vadyl build verify <artifact>

Verify an artifact's signature.

Examples

vadyl build verify artifact:abc

Sample output

{
  "command": "vadyl build verify",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Publications

Project runtime publications.

`vadyl publication list`

vadyl publication list

List publication versions.

Examples

vadyl publication list

Sample output

{
  "command": "vadyl publication list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl publication show`

vadyl publication show <version>

Show a publication's bindings, artifacts, contract version.

Examples

vadyl publication show v412

Sample output

{
  "command": "vadyl publication show",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl publication lineage`

vadyl publication lineage <version>

Show ancestry / templates / source commits.

Examples

vadyl publication lineage v412

Sample output

{
  "command": "vadyl publication lineage",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl publication current`

vadyl publication current --target <env>

Show the publication currently serving a target.

Flags

Name	Type	Description
`--target`required	string	Environment.

Examples

vadyl publication current --target production

Sample output

{
  "command": "vadyl publication current",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl publication set-current`

vadyl publication set-current --target <env> <version>

Atomically set publication for a target.

Flags

Name	Type	Description
`--target`required	string	Environment.

Examples

vadyl publication set-current --target production v412

Sample output

{
  "command": "vadyl publication set-current",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Connections

Manage governed connections.

`vadyl connection list`

vadyl connection list

List governed connections.

Examples

vadyl connection list

Sample output

{
  "command": "vadyl connection list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl connection show`

vadyl connection show <name>

Show a connection's binding, capabilities, secret refs.

Examples

vadyl connection show stripe

Sample output

{
  "command": "vadyl connection show",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl connection create`

vadyl connection create <name> --config <file>

Create a connection from a typed config file.

Flags

Name	Type	Description
`--config`required	path	Connection config (.vadyl.ts \| .json).

Examples

vadyl connection create stripe --config connections/stripe.ts

Sample output

{
  "command": "vadyl connection create",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl connection update`

vadyl connection update <name> --config <file>

Update connection definition.

Flags

Name	Type	Description
`--config`required	path	Updated config.

Examples

vadyl connection update stripe --config connections/stripe.ts

Sample output

{
  "command": "vadyl connection update",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl connection delete`

vadyl connection delete <name>

Delete a connection.

Examples

vadyl connection delete stripe

Sample output

{
  "ok": true,
  "command": "vadyl connection delete",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`vadyl connection test`

vadyl connection test <name>

Test connectivity (uses egress-policy + secret resolver).

Examples

vadyl connection test stripe

Sample output

{
  "command": "vadyl connection test",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl connection describe`

vadyl connection describe <name>

Describe upstream-side capabilities of the bound connector.

Examples

vadyl connection describe stripe

Sample output

{
  "command": "vadyl connection describe",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Secrets

Key-ring backed secret management.

`vadyl secret list`

vadyl secret list

List secret names (values never printed).

Examples

vadyl secret list

Sample output

{
  "command": "vadyl secret list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl secret set`

vadyl secret set <name> [--from-stdin] [--from-file <path>]

Set a secret value (encrypted by IKeyRing).

Flags

Name	Type	Description
`--from-stdin`	bool	Read value from stdin.
`--from-file`	path	Read value from a file.

Examples

vadyl secret set STRIPE_SECRET --from-stdin

Sample output

{
  "command": "vadyl secret set",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl secret rotate`

vadyl secret rotate <name>

Rotate the secret's key version.

Examples

vadyl secret rotate STRIPE_SECRET

Sample output

{
  "command": "vadyl secret rotate",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl secret reveal`

vadyl secret reveal <name> --reason <reason>

Print the secret value (audited; admin-gated).

Flags

Name	Type	Description
`--reason`required	string	Audit reason.

Examples

vadyl secret reveal STRIPE_SECRET --reason "incident triage"

Sample output

{
  "command": "vadyl secret reveal",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl secret delete`

vadyl secret delete <name>

Delete a secret (consumers will fail until replaced).

Examples

vadyl secret delete STRIPE_SECRET

Sample output

{
  "ok": true,
  "command": "vadyl secret delete",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

Agents

List, inspect, run agents.

`vadyl agent list`

vadyl agent list

List agent definitions in the project.

Examples

vadyl agent list

Sample output

{
  "command": "vadyl agent list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl agent show`

vadyl agent show <name>

Show an agent's bindings, model, skills, memory scope.

Examples

vadyl agent show SupportAgent

Sample output

{
  "command": "vadyl agent show",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl agent run`

vadyl agent run <name> --prompt <p> [--user <id>] [--budget-tokens <n>]

Run an agent.

Flags

Name	Type	Description
`--prompt`required	string	Prompt.
`--user`	string	Acting user id.
`--budget-tokens`	int	Override max tokens.

Examples

vadyl agent run SupportAgent --prompt "Refund order #12345 due to defect"

Sample output

{
  "command": "vadyl agent run",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl agent runs list`

vadyl agent runs list [<agent>]

List agent runs.

Examples

vadyl agent runs list SupportAgent

Sample output

{
  "command": "vadyl agent runs list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl agent runs show`

vadyl agent runs show <runId>

Show run details — plan, steps, tokens, cost.

Examples

vadyl agent runs show run_abc

Sample output

{
  "command": "vadyl agent runs show",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl agent runs tail`

vadyl agent runs tail <runId>

Stream a live run.

Examples

vadyl agent runs tail run_abc

Sample output

event: vadyl.cli.stream
data: { "kind": "event", "id": "evt_123", "correlationId": "01HXZ..." }

`vadyl agent memory recall`

vadyl agent memory recall <agent> --kind <k> [--subject <s>]

Recall memory facts.

Flags

Name	Type	Description
`--kind`required	string	Fact kind.
`--subject`	string	Subject id.

Examples

vadyl agent memory recall SupportAgent --kind preference --subject user:abc

Sample output

{
  "command": "vadyl agent memory recall",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Workflows

Start, signal, query, replay durable workflows.

`vadyl workflow list`

vadyl workflow list

List workflow definitions.

Examples

vadyl workflow list

Sample output

{
  "command": "vadyl workflow list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl workflow start`

vadyl workflow start <name> --input <json|file>

Start a workflow run.

Flags

Name	Type	Description
`--input`required	string	JSON object or @path/to/file.

Examples

vadyl workflow start fulfillOrder --input '{"orderId":"ord_abc"}'

Sample output

{
  "command": "vadyl workflow start",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl workflow signal`

vadyl workflow signal <runId> <signalName> [--payload <json>]

Send a signal to a running workflow.

Flags

Name	Type	Description
`--payload`	string	Signal payload.

Examples

vadyl workflow signal run_abc shipped --payload '{"trackingNumber":"1Z"}'

Sample output

{
  "command": "vadyl workflow signal",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl workflow query`

vadyl workflow query <runId>

Query workflow run state.

Examples

vadyl workflow query run_abc

Sample output

{
  "command": "vadyl workflow query",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl workflow cancel`

vadyl workflow cancel <runId> [--reason <r>]

Cancel a workflow run; runs compensations.

Flags

Name	Type	Description
`--reason`	string	Audit reason.

Examples

vadyl workflow cancel run_abc --reason "customer requested"

Sample output

{
  "command": "vadyl workflow cancel",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl workflow runs`

vadyl workflow runs <name> [--status <s>]

List runs of a workflow.

Flags

Name	Type	Description
`--status`	string	Filter by status.

Examples

vadyl workflow runs fulfillOrder --status failed

Sample output

{
  "command": "vadyl workflow runs",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl workflow replay`

vadyl workflow replay <runId> [--dry]

Replay a run (for debugging) — by default dry-run.

Flags

Name	Type	Description
`--dry`	bool	Dry-run only (default true).

Examples

vadyl workflow replay run_abc

Sample output

{
  "command": "vadyl workflow replay",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Events

Tail / replay / search canonical event log.

`vadyl events tail`

vadyl events tail [--filter <expr>]

Stream the canonical event log.

Flags

Name	Type	Description
`--filter`	string	Filter expression (kind, entity, time, correlation).

Examples

vadyl events tail --filter "kind=order.paid"

Sample output

event: vadyl.cli.stream
data: { "kind": "event", "id": "evt_123", "correlationId": "01HXZ..." }

`vadyl events search`

vadyl events search [--filter <expr>] [--since <t>] [--until <t>]

Search historical events.

Flags

Name	Type	Description
`--filter`	string	Filter expression.
`--since`	time	Start time.
`--until`	time	End time.

Examples

vadyl events search --filter "kind=order.paid" --since 2026-05-01

Sample output

{
  "command": "vadyl events search",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl events replay`

vadyl events replay <eventId>

Replay an event into its registered consumers.

Examples

vadyl events replay evt_abc

Sample output

{
  "command": "vadyl events replay",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Audit

Tail / search the canonical audit log.

`vadyl audit tail`

vadyl audit tail [--filter <expr>]

Stream audit trail.

Flags

Name	Type	Description
`--filter`	string	Filter expression (reasonCode, actor, entity, scope).

Examples

vadyl audit tail --filter "reasonCode startsWith 'Access.Denied'"

Sample output

event: vadyl.cli.stream
data: { "kind": "event", "id": "evt_123", "correlationId": "01HXZ..." }

`vadyl audit search`

vadyl audit search [--filter <expr>] [--since <t>] [--until <t>]

Search historical audit rows.

Flags

Name	Type	Description
`--filter`	string	Filter expression.
`--since`	time	Start.
`--until`	time	End.

Examples

vadyl audit search --filter "actor.subjectId=user:abc"

Sample output

{
  "command": "vadyl audit search",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Explainability

Project canonical decision reasoning.

`vadyl explain access`

vadyl explain access --entity <e> [--filter <expr>] [--as <actor>]

Why was a read/write allowed/denied.

Flags

Name	Type	Description
`--entity`required	string	Entity name.
`--filter`	string	Optional row filter.
`--as`	string	Evaluate as a specific actor.

Examples

vadyl explain access --entity Order --filter status=paid --as user:abc

Sample output

{
  "command": "vadyl explain access",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl explain read-plan`

vadyl explain read-plan --entity <e> [--include <rels>]

Show AST plan, cache decision, chosen provider.

Flags

Name	Type	Description
`--entity`required	string	Entity name.
`--include`	csv	Relations to expand.

Examples

vadyl explain read-plan --entity Order --include customer

Sample output

{
  "command": "vadyl explain read-plan",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl explain project-runtime`

vadyl explain project-runtime

Show why the current publication is serving traffic.

Examples

vadyl explain project-runtime

Sample output

{
  "command": "vadyl explain project-runtime",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl explain agent-run`

vadyl explain agent-run <runId>

Show canonical reasoning trace for an agent run.

Examples

vadyl explain agent-run run_abc

Sample output

{
  "command": "vadyl explain agent-run",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

SDKs

Generate / inspect language SDKs.

`vadyl sdk generate`

vadyl sdk generate --language <lang> [--output <dir>]

Generate a language SDK from the canonical contract.

Flags

Name	Type	Description
`--language`required	enum	typescript \| python \| csharp \| go \| rust
`--output`	path	Output directory.

Examples

vadyl sdk generate --language typescript --output ./sdk

Sample output

{
  "command": "vadyl sdk generate",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl sdk manifest`

vadyl sdk manifest [--language <lang>]

Print the generated-format compatibility manifest.

Flags

Name	Type	Description
`--language`	string	Language filter.

Examples

vadyl sdk manifest --language typescript

Sample output

{
  "command": "vadyl sdk manifest",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl sdk verify`

vadyl sdk verify <path>

Verify a generated SDK against the current server's manifest.

Examples

vadyl sdk verify ./sdk

Sample output

{
  "command": "vadyl sdk verify",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Source assets

Folders, files, blobs, trees, upload/download, and scope shape.

`vadyl source folder list`

vadyl source folder list [--parent <id>]

List source folders.

Flags

Name	Type	Description
`--parent`	string	Parent folder id.

Examples

vadyl source folder list

Sample output

{
  "command": "vadyl source folder list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl source folder create`

vadyl source folder create <path>

Create a source folder.

Examples

vadyl source folder create src/handlers/orders

Sample output

{
  "command": "vadyl source folder create",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl source folder rename`

vadyl source folder rename <id> <name>

Rename a folder.

Examples

vadyl source folder rename fld_123 checkout

Sample output

{
  "command": "vadyl source folder rename",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl source folder delete`

vadyl source folder delete <id>

Delete a folder.

Examples

vadyl source folder delete fld_123

Sample output

{
  "ok": true,
  "command": "vadyl source folder delete",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`vadyl source file list`

vadyl source file list [--folder <id>]

List source files.

Examples

vadyl source file list --folder fld_123

Sample output

{
  "command": "vadyl source file list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl source file get`

vadyl source file get <id|path>

Read file metadata and content.

Examples

vadyl source file get src/handlers/orders/charge.ts

Sample output

{
  "command": "vadyl source file get",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl source file put`

vadyl source file put <path> --content <text|@file>

Create or update a file.

Flags

Name	Type	Description
`--content`required	string	Inline content or @path.

Examples

vadyl source file put src/handlers/orders/charge.ts --content @charge.ts

Sample output

{
  "command": "vadyl source file put",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl source file rename`

vadyl source file rename <id> <path>

Rename or move a file.

Examples

vadyl source file rename file_123 src/handlers/orders/pay.ts

Sample output

{
  "command": "vadyl source file rename",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl source file delete`

vadyl source file delete <id>

Delete a file.

Examples

vadyl source file delete file_123

Sample output

{
  "ok": true,
  "command": "vadyl source file delete",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`vadyl source tree`

vadyl source tree [--ref <branch|commit>]

Print source tree shape.

Examples

vadyl source tree --ref feature/checkout

Sample output

{
  "command": "vadyl source tree",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl source scope shape`

vadyl source scope shape

Show source-asset scope shape used by builds.

Examples

vadyl source scope shape

Sample output

{
  "command": "vadyl source scope shape",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Storage

Object upload, download, list, metadata, presign, delete.

`vadyl storage upload`

vadyl storage upload <local> <storagePath> [--content-type <type>]

Upload an object.

Examples

vadyl storage upload ./invoice.pdf invoices/2026/inv_123.pdf

Sample output

{
  "command": "vadyl storage upload",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl storage download`

vadyl storage download <storagePath> [--output <local>]

Download an object.

Examples

vadyl storage download invoices/2026/inv_123.pdf --output ./invoice.pdf

Sample output

{
  "command": "vadyl storage download",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl storage exists`

vadyl storage exists <storagePath>

Check object existence.

Examples

vadyl storage exists invoices/2026/inv_123.pdf

Sample output

{
  "command": "vadyl storage exists",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl storage delete`

vadyl storage delete <storagePath>

Delete an object.

Examples

vadyl storage delete tmp/upload.bin

Sample output

{
  "ok": true,
  "command": "vadyl storage delete",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`vadyl storage list`

vadyl storage list [--prefix <prefix>]

List objects under a prefix.

Examples

vadyl storage list --prefix invoices/2026

Sample output

{
  "command": "vadyl storage list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl storage providers`

vadyl storage providers

List storage provider bindings.

Examples

vadyl storage providers

Sample output

{
  "command": "vadyl storage providers",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl storage info`

vadyl storage info <storagePath>

Show object metadata.

Examples

vadyl storage info invoices/2026/inv_123.pdf

Sample output

{
  "command": "vadyl storage info",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Webhooks

Outbound endpoints, inbound receivers, deliveries, replay, secret rotation.

`vadyl webhook endpoint list`

vadyl webhook endpoint list

List outbound endpoints.

Examples

vadyl webhook endpoint list

Sample output

{
  "command": "vadyl webhook endpoint list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl webhook endpoint create`

vadyl webhook endpoint create --url <url> [--filter <json>] [--signing-secret <name>]

Create an outbound endpoint.

Examples

vadyl webhook endpoint create --url https://example.com/webhooks/vadyl --filter '{"op":"startsWith","path":"$.type","value":"order."}'

Sample output

{
  "command": "vadyl webhook endpoint create",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl webhook endpoint update`

vadyl webhook endpoint update <id> --url <url>

Update an endpoint.

Examples

vadyl webhook endpoint update wh_end_123 --url https://example.com/v2

Sample output

{
  "command": "vadyl webhook endpoint update",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl webhook endpoint delete`

vadyl webhook endpoint delete <id>

Delete an endpoint.

Examples

vadyl webhook endpoint delete wh_end_123

Sample output

{
  "ok": true,
  "command": "vadyl webhook endpoint delete",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`vadyl webhook endpoint rotate-secret`

vadyl webhook endpoint rotate-secret <id>

Rotate endpoint signing material.

Examples

vadyl webhook endpoint rotate-secret wh_end_123

Sample output

{
  "command": "vadyl webhook endpoint rotate-secret",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl webhook deliveries list`

vadyl webhook deliveries list <endpointId>

List endpoint deliveries.

Examples

vadyl webhook deliveries list wh_end_123

Sample output

{
  "command": "vadyl webhook deliveries list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl webhook deliveries replay`

vadyl webhook deliveries replay <deliveryId>

Replay a delivery.

Examples

vadyl webhook deliveries replay whdel_123

Sample output

{
  "command": "vadyl webhook deliveries replay",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl webhook receiver list`

vadyl webhook receiver list

List inbound receivers.

Examples

vadyl webhook receiver list

Sample output

{
  "command": "vadyl webhook receiver list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl webhook receiver create`

vadyl webhook receiver create --name <name> --secret <secret>

Create an inbound receiver.

Examples

vadyl webhook receiver create --name stripe --secret STRIPE_WEBHOOK_SECRET

Sample output

{
  "command": "vadyl webhook receiver create",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl webhook diagnostics`

vadyl webhook diagnostics

Show webhook scanner and receiver diagnostics.

Examples

vadyl webhook diagnostics

Sample output

{
  "command": "vadyl webhook diagnostics",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Analytics

Catalog, query, models, metrics, reports, dashboards, materializations.

`vadyl analytics catalog`

vadyl analytics catalog

Print analytics catalog.

Examples

vadyl analytics catalog

Sample output

{
  "command": "vadyl analytics catalog",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl analytics query validate`

vadyl analytics query validate --input <json|@file>

Validate an analytics query.

Examples

vadyl analytics query validate --input @query.json

Sample output

{
  "command": "vadyl analytics query validate",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl analytics query explain`

vadyl analytics query explain --input <json|@file>

Explain query plan and lineage.

Examples

vadyl analytics query explain --input @query.json

Sample output

{
  "command": "vadyl analytics query explain",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl analytics query execute`

vadyl analytics query execute --input <json|@file>

Execute a query.

Examples

vadyl analytics query execute --input @query.json

Sample output

{
  "command": "vadyl analytics query execute",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl analytics model list`

vadyl analytics model list

List analytics models.

Examples

vadyl analytics model list

Sample output

{
  "command": "vadyl analytics model list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl analytics metric list`

vadyl analytics metric list

List metrics.

Examples

vadyl analytics metric list

Sample output

{
  "command": "vadyl analytics metric list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl analytics report run`

vadyl analytics report run <reportId>

Run a report.

Examples

vadyl analytics report run rpt_123

Sample output

{
  "command": "vadyl analytics report run",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl analytics dashboard render`

vadyl analytics dashboard render <dashboardId>

Render dashboard data.

Examples

vadyl analytics dashboard render dash_123

Sample output

{
  "command": "vadyl analytics dashboard render",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl analytics materialization refresh`

vadyl analytics materialization refresh <id>

Refresh a materialization.

Examples

vadyl analytics materialization refresh mat_123

Sample output

{
  "command": "vadyl analytics materialization refresh",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl analytics lineage`

vadyl analytics lineage <subjectId>

Show lineage graph for a subject.

Examples

vadyl analytics lineage Order

Sample output

{
  "command": "vadyl analytics lineage",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Automation

Compile definitions, manage runs, approvals, attempts, signals, compensation.

`vadyl automation compile`

vadyl automation compile --definition <json|@file>

Compile and type-check an automation definition.

Examples

vadyl automation compile --definition @refunds.automation.json

Sample output

{
  "command": "vadyl automation compile",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl automation definition list`

vadyl automation definition list

List automation definitions.

Examples

vadyl automation definition list

Sample output

{
  "command": "vadyl automation definition list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl automation definition create`

vadyl automation definition create --file <path>

Create a definition.

Examples

vadyl automation definition create --file refunds.automation.json

Sample output

{
  "command": "vadyl automation definition create",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl automation definition update`

vadyl automation definition update <id> --file <path>

Update a definition.

Examples

vadyl automation definition update auto_123 --file refunds.automation.json

Sample output

{
  "command": "vadyl automation definition update",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl automation definition lifecycle`

vadyl automation definition lifecycle <id> --state active|paused|retired

Change definition lifecycle.

Examples

vadyl automation definition lifecycle auto_123 --state active

Sample output

{
  "command": "vadyl automation definition lifecycle",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl automation run start`

vadyl automation run start <definitionId> --input <json|@file>

Start a run.

Examples

vadyl automation run start auto_123 --input '{"orderId":"ord_123"}'

Sample output

{
  "command": "vadyl automation run start",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl automation run show`

vadyl automation run show <runId>

Show run state.

Examples

vadyl automation run show arun_123

Sample output

{
  "command": "vadyl automation run show",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl automation run cancel`

vadyl automation run cancel <runId>

Cancel a run.

Examples

vadyl automation run cancel arun_123

Sample output

{
  "command": "vadyl automation run cancel",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl automation run signal`

vadyl automation run signal <runId> --payload <json>

Signal a waiting run.

Examples

vadyl automation run signal arun_123 --payload '{"approved":true}'

Sample output

{
  "command": "vadyl automation run signal",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl automation approval approve`

vadyl automation approval approve <approvalTaskId>

Approve a pending task.

Examples

vadyl automation approval approve appr_123

Sample output

{
  "command": "vadyl automation approval approve",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Connectors

Contracts, implementations, bindings, builds, conformance, invocation.

`vadyl connector contracts`

vadyl connector contracts

List connector contracts.

Examples

vadyl connector contracts

Sample output

{
  "command": "vadyl connector contracts",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl connector implementations`

vadyl connector implementations

List implementations.

Examples

vadyl connector implementations

Sample output

{
  "command": "vadyl connector implementations",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl connector build declarative`

vadyl connector build declarative --manifest <path>

Build a declarative bundle.

Examples

vadyl connector build declarative --manifest stripe.connector.json

Sample output

{
  "command": "vadyl connector build declarative",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl connector conformance run`

vadyl connector conformance run --implementation <id>

Run conformance.

Examples

vadyl connector conformance run --implementation impl_123

Sample output

{
  "command": "vadyl connector conformance run",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl connector binding create`

vadyl connector binding create <alias> --implementation <id>

Create a binding.

Examples

vadyl connector binding create stripe --implementation impl_123

Sample output

{
  "command": "vadyl connector binding create",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl connector invoke`

vadyl connector invoke <alias> <operation> --input <json|@file>

Invoke a connector operation.

Examples

vadyl connector invoke stripe createCharge --input @charge.json

Sample output

{
  "command": "vadyl connector invoke",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Runtime fabric

Topology, scaling, resources, ingress, realization, health, binding, deployment plans, reconcile, drain.

`vadyl runtime-fabric topology`

vadyl runtime-fabric topology [--project <id>]

Show topology.

Examples

vadyl runtime-fabric topology --project proj_123

Sample output

{
  "command": "vadyl runtime-fabric topology",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl runtime-fabric health`

vadyl runtime-fabric health <environmentId>

Show runtime health.

Examples

vadyl runtime-fabric health prod

Sample output

{
  "command": "vadyl runtime-fabric health",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl runtime-fabric plan`

vadyl runtime-fabric plan --project <id> --env <id>

Plan realization.

Examples

vadyl runtime-fabric plan --project proj_123 --env prod

Sample output

{
  "command": "vadyl runtime-fabric plan",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl runtime-fabric apply`

vadyl runtime-fabric apply <intentId>

Apply a runtime intent.

Examples

vadyl runtime-fabric apply rti_123

Sample output

{
  "command": "vadyl runtime-fabric apply",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl runtime-fabric reconcile`

vadyl runtime-fabric reconcile --project <id> --env <id>

Reconcile runtime state.

Examples

vadyl runtime-fabric reconcile --project proj_123 --env prod

Sample output

{
  "command": "vadyl runtime-fabric reconcile",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl runtime-fabric drain`

vadyl runtime-fabric drain --project <id> --env <id>

Drain workloads.

Examples

vadyl runtime-fabric drain --project proj_123 --env prod

Sample output

{
  "command": "vadyl runtime-fabric drain",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl runtime-fabric scaling preview`

vadyl runtime-fabric scaling preview --project <id> --file <topology.json>

Dry-run scaling, resource, and ingress policy changes.

Examples

vadyl runtime-fabric scaling preview --project proj_123 --file runtime-topology.json

Sample output

{
  "command": "vadyl runtime-fabric scaling preview",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl runtime-fabric scaling targets`

vadyl runtime-fabric scaling targets --project <id> --env <id>

List runtime scale targets.

Examples

vadyl runtime-fabric scaling targets --project proj_123 --env prod

Sample output

{
  "command": "vadyl runtime-fabric scaling targets",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl runtime-fabric scaling set-desired`

vadyl runtime-fabric scaling set-desired --project <id> --env <id> --surface <kind> --count <n>

Set desired count for a manual target.

Examples

vadyl runtime-fabric scaling set-desired --project proj_123 --env prod --surface CoreHandler --count 6

Sample output

{
  "command": "vadyl runtime-fabric scaling set-desired",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl runtime-fabric scaling set-policy`

vadyl runtime-fabric scaling set-policy --project <id> --surface <kind> --file <policy.json>

Replace a surface scaling policy.

Examples

vadyl runtime-fabric scaling set-policy --project proj_123 --surface EventConsumer --file autoscale.json

Sample output

{
  "command": "vadyl runtime-fabric scaling set-policy",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl runtime-fabric scaling set-resources`

vadyl runtime-fabric scaling set-resources --project <id> --surface <kind> --cpu <millicores> --memory <MiB>

Set vendor-neutral vertical resource policy.

Examples

vadyl runtime-fabric scaling set-resources --project proj_123 --surface CoreHandler --cpu 1000 --memory 2048

Sample output

{
  "command": "vadyl runtime-fabric scaling set-resources",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl runtime-fabric scaling set-ingress`

vadyl runtime-fabric scaling set-ingress --project <id> --surface <kind> --load-balancing managed-public

Set canonical ingress and load-balancing policy.

Examples

vadyl runtime-fabric scaling set-ingress --project proj_123 --surface ApiIngress --load-balancing managed-public --protocol http2

Sample output

{
  "command": "vadyl runtime-fabric scaling set-ingress",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl runtime-fabric autoscale suspend`

vadyl runtime-fabric autoscale suspend --project <id> --env <id> --surface <kind>

Suspend autoscale for a target.

Examples

vadyl runtime-fabric autoscale suspend --project proj_123 --env prod --surface CoreHandler

Sample output

{
  "command": "vadyl runtime-fabric autoscale suspend",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl runtime-fabric autoscale resume`

vadyl runtime-fabric autoscale resume --project <id> --env <id> --surface <kind>

Resume autoscale for a target.

Examples

vadyl runtime-fabric autoscale resume --project proj_123 --env prod --surface CoreHandler

Sample output

{
  "command": "vadyl runtime-fabric autoscale resume",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl runtime-fabric autoscale explain`

vadyl runtime-fabric autoscale explain --project <id> --env <id> --surface <kind>

Explain the latest autoscale decision or rejection.

Examples

vadyl runtime-fabric autoscale explain --project proj_123 --env prod --surface EventConsumer

Sample output

{
  "command": "vadyl runtime-fabric autoscale explain",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Distribution

CDN bindings, policy, realization, delivery, invalidation, replica policies.

`vadyl distribution binding list`

vadyl distribution binding list --project <id>

List distribution bindings.

Examples

vadyl distribution binding list --project proj_123

Sample output

{
  "command": "vadyl distribution binding list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl distribution policy show`

vadyl distribution policy show --project <id>

Show project distribution policy.

Examples

vadyl distribution policy show --project proj_123

Sample output

{
  "command": "vadyl distribution policy show",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl distribution realization`

vadyl distribution realization --project <id> --env <id>

Show realized provider state.

Examples

vadyl distribution realization --project proj_123 --env prod

Sample output

{
  "command": "vadyl distribution realization",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl distribution asset delivery`

vadyl distribution asset delivery --namespace <id> --class <class> --path <path>

Create delivery URL/descriptor.

Examples

vadyl distribution asset delivery --namespace public --class image --path hero.png

Sample output

{
  "command": "vadyl distribution asset delivery",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl distribution asset invalidate`

vadyl distribution asset invalidate --namespace <id> --class <class> --path <path>

Invalidate an asset.

Examples

vadyl distribution asset invalidate --namespace public --class image --path hero.png

Sample output

{
  "command": "vadyl distribution asset invalidate",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl distribution replica policy preview-route`

vadyl distribution replica policy preview-route <entityName>

Preview entity replica routing.

Examples

vadyl distribution replica policy preview-route Order

Sample output

{
  "command": "vadyl distribution replica policy preview-route",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Status

Health and version.

`vadyl status status`

vadyl status

Show current scope, active publication, and server health.

Examples

vadyl status

Sample output

{
  "command": "vadyl status status",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl status version`

vadyl version

Show CLI version + manifest compatibility window.

Examples

vadyl version

Sample output

{
  "command": "vadyl status version",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

`vadyl status doctor`

vadyl doctor

Run local environment checks (auth, dev deps, network).

Examples

vadyl doctor

Sample output

{
  "command": "vadyl status doctor",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Project capability surfaces

Publish, validate, describe, install, upgrade, grant, consume, explain, suspend, resume, and revoke project capability surfaces.

`vadyl surface validate`

vadyl surface validate <manifest>

Validate ProjectCapabilitySurfaceManifest slices, exposure bindings, PCG contribution, SDK/CLI/MCP projection, grants, and lifecycle policy.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl surface validate ./vadyl.surface.ts

Sample output

{
  "command": "vadyl surface validate",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl surface publish`

vadyl surface publish <name>@<version> --manifest <path>

Publish a signed provider surface version.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl surface publish RevenueOps@2.4.0 --manifest ./vadyl.surface.ts

Sample output

{
  "command": "vadyl surface publish",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl surface list`

vadyl surface list [--publisher <project>] [--installed]

List visible published surfaces or installed surfaces in the active project.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl surface list

vadyl surface list --installed --output json

Sample output

{
  "command": "vadyl surface list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl surface describe`

vadyl surface describe <name>[@<version>]

Show descriptor hash, slices, projection bindings, required grants, publisher, and lifecycle state.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl surface describe RevenueOps@2.4.0

Sample output

{
  "command": "vadyl surface describe",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl surface install`

vadyl surface install <name>@<version> --publisher <project> [--grant <grant>...]

Install a provider surface into the active consumer project with version pinning, grant narrowing, and billing attribution.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl surface install RevenueOps@2.4.0 --publisher acme/revenue-ops --grant cli:revenue.reconcile

Sample output

{
  "command": "vadyl surface install",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl surface upgrade`

vadyl surface upgrade <name> --to <version>

Upgrade an installation after compatibility, grant, quota, and dependency checks.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl surface upgrade RevenueOps --to 2.5.0

Sample output

{
  "command": "vadyl surface upgrade",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl surface grants`

vadyl surface grants <installationId> [--set <grant>...]

Inspect or update narrowed grants for an installation.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl surface grants sinst_123 --set operation:ledger.reconcile

Sample output

{
  "command": "vadyl surface grants",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl surface consumption`

vadyl surface consumption <name> [--group-by <fields>]

Query ProjectCapabilityConsumptionDescriptor evidence for usage, billing, audit, and dependency impact.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl surface consumption RevenueOps --group-by operation,consumerProject

Sample output

{
  "command": "vadyl surface consumption",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl surface explain`

vadyl surface explain <subject>

Explain publish, install, grant, projection, invocation, or consumption decisions.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl surface explain RevenueOps

vadyl surface explain-consumption cons_123

Sample output

{
  "command": "vadyl surface explain",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl surface suspend`

vadyl surface suspend <installationId>

Suspend a consumer installation without uninstalling it.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl surface suspend sinst_123

Sample output

{
  "command": "vadyl surface suspend",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl surface resume`

vadyl surface resume <installationId>

Resume a suspended installation.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl surface resume sinst_123

Sample output

{
  "command": "vadyl surface resume",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl surface revoke`

vadyl surface revoke <name>@<version> --reason <text>

Revoke a published provider surface version and fail closed for affected installations.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl surface revoke RevenueOps@2.4.0 --reason security-replacement

Sample output

{
  "command": "vadyl surface revoke",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

Plane Capability Graph

Inspect PCG descriptors, nodes, edges, actions, triggers, measures, effects, policies, and transforms.

`vadyl graph descriptor`

vadyl graph descriptor [--project <id>] [--output json]

Print the full Plane Capability Graph descriptor.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl graph descriptor --output json

Sample output

{
  "command": "vadyl graph descriptor",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl graph nodes`

vadyl graph nodes --kind <kind>

List PCG nodes by typed kind.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl graph nodes --kind Action

Sample output

{
  "command": "vadyl graph nodes",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl graph node`

vadyl graph node <nodeId>

Inspect one typed PCG node and its incoming/outgoing edges.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl graph node action:Order.refund

Sample output

{
  "command": "vadyl graph node",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl graph edges`

vadyl graph edges --from <nodeId> [--type <edge>]

Trace dependencies, grants, triggers, and effects.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl graph edges --from action:Order.refund

Sample output

{
  "command": "vadyl graph edges",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl graph validate`

vadyl graph validate

Validate dangling edges, unknown capabilities, unit compatibility, and publication hash.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl graph validate

Sample output

{
  "command": "vadyl graph validate",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl graph explain`

vadyl graph explain <nodeId>

Explain why a node exists and which descriptor contributed it.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl graph explain action:Order.refund

Sample output

{
  "command": "vadyl graph explain",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

Measures

Measure descriptors, units, instruments, freshness, grants, query, and explanation.

`vadyl measure descriptors`

vadyl measure descriptors [--subject <id>]

List all first-class measure descriptors.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl measure descriptors --subject Order

Sample output

{
  "command": "vadyl measure descriptors",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl measure show`

vadyl measure show <nodeId>

Inspect semantic kind, unit, aggregation, instrument, dimensions, grants, and redaction.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl measure show measure:Order.grossRevenue

Sample output

{
  "command": "vadyl measure show",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl measure query`

vadyl measure query <nodeId> --from <time> --to <time> [--group-by <dim>]

Query a measure through the analytics fabric.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl measure query measure:Order.grossRevenue --from 2026-05-01 --to 2026-05-07 --group-by region

Sample output

{
  "command": "vadyl measure query",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl measure explain`

vadyl measure explain <nodeId>

Explain source, transformations, freshness, and suppression.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl measure explain measure:Order.grossRevenue

Sample output

{
  "command": "vadyl measure explain",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

Cache

Cache provider bindings, descriptor fingerprints, entity-read cache gates, generations, and invalidation.

`vadyl cache bindings`

vadyl cache bindings [--project <id>]

List cache bindings resolved through project ancestry.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl cache bindings --project proj_123

Sample output

{
  "command": "vadyl cache bindings",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl cache descriptor`

vadyl cache descriptor [--project <id>]

Print the compiled CacheRuntimeDescriptor and fingerprint.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl cache descriptor --project proj_123

Sample output

{
  "command": "vadyl cache descriptor",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl cache invalidate project`

vadyl cache invalidate project <projectId>

Bump project-scope cache generation.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl cache invalidate project proj_123

Sample output

{
  "command": "vadyl cache invalidate project",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl cache invalidate entity`

vadyl cache invalidate entity <entityName>

Bump entity-scope cache generation.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl cache invalidate entity Order

Sample output

{
  "command": "vadyl cache invalidate entity",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl cache explain gate`

vadyl cache explain gate --entity <name> --operation read

Explain whether post-access entity-read caching applies.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl cache explain gate --entity Order --operation read

Sample output

{
  "command": "vadyl cache explain gate",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

Database sources

External database-source registration, artifacts, acceptance, import, staging, and ingestion jobs.

`vadyl database-source list`

vadyl database-source list

List configured external database sources.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl database-source list

Sample output

{
  "command": "vadyl database-source list",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl database-source artifacts`

vadyl database-source artifacts <alias>

List imported artifacts for a source.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl database-source artifacts legacy-postgres

Sample output

{
  "command": "vadyl database-source artifacts",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl database-source acceptance`

vadyl database-source acceptance <alias> --file <manifest>

Record acceptance evidence before import.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl database-source acceptance legacy-postgres --file acceptance.json

Sample output

{
  "command": "vadyl database-source acceptance",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl database-source import`

vadyl database-source import <alias> --plan <file>

Start an import job from a validated source manifest.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl database-source import legacy-postgres --plan import.json

Sample output

{
  "command": "vadyl database-source import",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.

`vadyl database-source staging sweep`

vadyl database-source staging sweep

Sweep expired staging rows using the canonical TTL policy.

Flags

Name	Type	Description
`--output`	enum	text \| json. JSON preserves the canonical response envelope.
`--project`	string	Override active project scope for this command.

Examples

vadyl database-source staging sweep

Sample output

{
  "command": "vadyl database-source staging sweep",
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Exit codes

Code	Description
`0`	Success.
`2`	Validation failed before dispatch.
`3`	Access denied, quota exceeded, or surface unavailable.
`4`	Remote operation failed with a canonical error envelope.