orvanta init & sync

The Orvanta CLI keeps your scripts, flows, and apps as files in a directory and synchronises them with a workspace. This makes your automation reviewable in git and promotable between environments.

orvanta init

Initialise the current directory as an Orvanta project.

orvanta init

orvanta init creates:

• a sync configuration file (which folders/types to track),
• AGENTS.md + CLAUDE.md: the agent prompt for AI coding assistants,
• .claude/skills/: per-task guides used by tools like Claude Code.

It also offers to bind a workspace profile to the current git branch.

Editor validation for orvanta.yaml

The generated orvanta.yaml starts with a schema directive:

# yaml-language-server: $schema=https://docs.orvanta.cloud/schema/orvanta.schema.json

Any editor running yaml-language-server — VS Code with the YAML extension, Neovim, JetBrains IDEs — fetches that URL and gives you completion, inline descriptions, and validation of every option. Keep the line: it needs no local file and no authentication, and removing it just turns validation off.

The schema is published from the CLI’s own configuration reference, so it always describes the most recently released version of orvanta. You can browse it directly at docs.orvanta.cloud/schema/orvanta.schema.json, or run orvanta config for the same reference as a table.

Note

The directive is an absolute URL, so your editor needs network access the first time it loads the schema (most cache it afterwards). If your editor is offline or behind a proxy that blocks it, yaml-language-server simply provides no validation — it does not report an error.

orvanta sync pull

Pull remote changes and apply them locally.

orvanta sync pull

orvanta sync push

Push local changes and apply them remotely. This is how you deploy.

orvanta sync push

Tip

Use --show-diffs to see what will change before syncing (note: diffs may include sensitive values).

What gets synced

sync pull/sync push cover every resource kind in a workspace: variables and secrets, resources, resource types, scripts, flows, apps, folders, workspace dependencies, BPMN flows, and DMN decisions. Skip any one kind with --skip-<kind> (e.g. --skip-flows, --skip-apps, --skip-secrets) — --skip-dmn skips DMN decisions specifically.

A DMN decision on disk is a pair: the raw, byte-exact {path}.dmn XML file, plus a {path}.dmn_decision.yaml (or .json) sidecar carrying summary, description, and labels — metadata that has no home in DMN 1.3 XML itself. See orvanta dmn for managing that pair directly.

Live preview

While editing, orvanta dev watches local files and live-reloads a preview page. It does not deploy, so use orvanta sync push for that.

orvanta dev --path f/my_folder/my_flow

Related

• Workspace: Connect a workspace before syncing.
• Scripts · Flows · orvanta dmn: What you’re syncing.