Vadyl
Build on Vadyl

CLI

Standalone console app. Same product model, same auth, same surfaces.

This page is the documentation contract for the CLI surface in Vadyl's final form. It is not a marketing summary: it names the authorities, projections, runtime behavior, examples, limits, errors, and observability expectations that every product implementation must honor.

What this surface owns

  • CLI owns the canonical product-facing contract described here; provider-specific machinery stays behind capability declarations.
  • Standalone console app. Same product model, same auth, same surfaces.
  • The final docs treat this as complete: REST, GraphQL, gRPC, SDK, CLI, MCP, dashboard, observability, limits, errors, and explainability are all covered as projections of one authority.

Canonical authorities

AuthorityRole
ProjectCapabilitySurfaceManifestPlaces CLI inside the UCSA taxonomy and enforces binding, grants, conformance, and consumption.
ExposureBindingDescriptorDefines how CLI appears through REST, OpenAPI, GraphQL, gRPC, SDK, CLI, MCP, dashboard, webhooks, realtime, and events.
PlaneCapabilityGraphPlaces CLI inside the UCSA taxonomy and enforces binding, grants, conformance, and consumption.
EffectiveGovernanceEnvelopeCanonical owner for CLI; downstream surfaces derive from this rather than inventing their own truth.

Projection coverage

Surface kindsOperationProjectionSurface, CommandSurface, ToolSurface, UiProjectionSurface, GovernancePolicySurface
Projection facetsExposureBindings, PlaneCapabilityGraph, Operations, Cli, Observability
ProtocolsRest, OpenApi, Sdk, Cli, Mcp, Dashboard
Public projectionsREST; OpenAPI; SDK; CLI; MCP; dashboard actions; automation actions; webhooks; realtime

Project-scope parity

    Publish, install, consume

      Consumption evidence

        Runtime behavior

        • project runtime compiler
        • branch-aware publication
        • surface manifest validator
        • install grant resolver
        • consumption evidence emitter

        REST and controller surface

        Code-backed controllers are listed here so the docs menu does not hide the real endpoint surface. The complete route-by-route table remains in the REST controller atlas.

        ControllerBase routeEndpoint countExamples
        Projects/api/projects14
        POST create
        GET resolve
        POST {parentProjectId}/children
        GET {projectId}/provider-bindings
        Surface/api/Surface9
        GET /
        GET {id}
        GET {id}/is-installed
        POST /
        ContractProjection/api/ContractProjection4
        GET descriptor
        GET {language}/declarations
        GET cli
        GET events
        Operation/api/Operation2
        POST Execute
        POST Plan
        PlaneCapabilityGraph/api/PlaneCapabilityGraph2
        GET descriptor
        GET nodes/{kind}
        Usage/api/Usage7
        GET {projectId}/events
        GET {projectId}/rollups
        GET {projectId}/quotas
        POST {projectId}/quotas

        SDK and CLI surface

        ProjectionNamespace / groupCoverage
        SDKsurfacespublish, validate, describe, install, upgrade, grant, consume, invoke, explain, suspend, resume, revoke project capability surfaces. Rendered methods: 10.
        SDKplatformprovider health/capabilities, runtime fabric scaling, distribution, version governance, data portability. Rendered methods: 12.
        SDKbranchingbranches, commits, workspaces, sandboxes, proposals, environments, deploy, rollback. Rendered methods: 5.
        CLIvadyl surfacePublish, validate, describe, install, upgrade, grant, consume, explain, suspend, resume, and revoke project capability surfaces. Rendered commands: 12.
        CLIvadyl projectCreate, suspend, archive, traverse the project hierarchy. Rendered commands: 7.
        CLIvadyl graphInspect PCG descriptors, nodes, edges, actions, triggers, measures, effects, policies, and transforms. Rendered commands: 6.

        Input request and output

        POST /api/projects/create HTTP/1.1
Host: api.vadyl.app
Authorization: Bearer $VADYL_TOKEN
X-Vadyl-Tenant: acme
X-Vadyl-Project: billing
Content-Type: application/json

{
  "surface": "cli",
  "publicationVersion": 412,
  "explain": true
}

        Limits and quotas

          Error model

          ErrorMeaning

          Observability and explainability

            Related references

            Previous
            Full surface atlas
            Next
            Exposure bindings