VS Code Extension

The Orvanta VS Code extension allows you to build scripts and flows in VS Code or the Cursor editor, leveraging Orvanta UIs for testing and flow editing.

Installation

First, synchronize your workspace locally using the Orvanta CLI with orvanta sync pull and orvanta sync push commands. Then:

1. Install the orvanta extension from the VS Code marketplace.
2. From any script file, use > Orvanta: Run preview in the current editor or Ctrl+Enter and Shift+Enter to generate the UI preview.

Scripts must meet specific language requirements (main function, imports) and use dedicated file extensions (.py, .go, etc.). For Bun scripts, use [name].bun.ts (note that .ts defaults to Deno).

Actions

The extension splits your screen to display a panel that updates based on the edited document:

• Script/Flow Step Editing: View the script preview UI with auto-inference of parameters.
• Flow YAML Editing: See the flow builder and test UI.

Key features

Test scripts, flows and flow steps — Test them directly from VS Code once pulled or created locally.

Update UI from YAML — Editing flow YAML definitions instantly updates the rendered graph.

Update YAML from UI — Editing flows in the UI immediately modifies YAML definitions.

Flow YAML validation — Built-in syntax validation for flow.yaml files helps catch errors before testing or deployment.

Infer lockfile or use current lockfile — Toggle between using the metadata lockfile (derived from workspace dependencies) or inferring dependencies directly from scripts.

Commands

Access via the Command Palette (Ctrl/Cmd+Shift+P):

Command	Description
Orvanta: Show Preview	Launches a preview of your script in a new tab
Orvanta: Run preview	Runs the current script with preview in VS Code
Orvanta: Configure remote, workspace, and token	Opens setup wizard for environment configuration
Orvanta: Switch Orvanta workspace	Switch between different workspaces
Orvanta: Add an Orvanta workspace	Adds a new workspace to configuration

Settings

The extension automatically uses workspace settings from the Orvanta CLI configuration. Available settings include:

Setting	Description
orvanta.remote	Full remote URL including http and trailing slash (default: https://app.orvanta.cloud/)
orvanta.workspaceId	Workspace ID to use
orvanta.token	User token for authentication
orvanta.additionalWorkspaces	List of additional remotes for multiple workspaces
orvanta.currentWorkspace	Currently active workspace name (default: main or empty)
orvanta.configFolder	Override CLI config folder path

Create a user token in the Orvanta app per the Webhooks documentation.

For TypeScript scripts, Bun is the default runtime. Change it per-script using the .deno.ts extension or globally in orvanta.yaml with the defaultTs field.