Guides

Use the coding workspace

Edit source assets, consume generated types, build artifacts, invoke handlers in a sandbox, publish, and deploy.

CodingCoding environment referenceWorkspace commands, runtime SDK surfaces, source assets, tests, deploys, and local execution.CLICLI command referenceEvery command group, subcommand, flag, sample output, and exit code for automation and CI.SDKSDK method referenceEvery client method across TypeScript, Python, C#, Go, and Rust with inputs, returns, and errors.BindingsExposure bindingsThe shared projection model that binds MCP, REST, GraphQL, gRPC, SDKs, CLI, dashboards, and Runtime Fabric scaling vocabulary.

1. Open a branch workspace

vadyl branch create feature/charge-flow
vadyl workspace open --branch feature/charge-flow

{
  "workspaceId": "ws_123",
  "branch": "feature/charge-flow"
}

2. Add source

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

3. Use generated types

Monaco and local editors receive declarations from /api/ContractProjection/typescript/declarations. The same contract powers the runtime SDK and external TypeScript SDK.

4. Build and invoke in sandbox

vadyl build preview --unit orders.charge
vadyl sandbox create --branch feature/charge-flow
vadyl authored-runtime sandbox publish sbox_123 --unit orders.charge
vadyl authored-runtime sandbox invoke sbox_123 --handler orders.charge --input '{"orderId":"ord_123"}'

{
  "ok": true,
  "chargeId": "ch_123"
}

5. Commit and deploy

vadyl workspace stage ws_123 src/handlers/orders/charge.ts
vadyl workspace commit ws_123 --message "Charge orders through governed connection"
vadyl proposal open --base main --head feature/charge-flow --title "Add charge flow"
vadyl deploy apply --target production --ramp 5%,25%,50%,100% --bake 10m

Author a custom connector

Monitor and observe