Skip to content
Orvanta Docs

Quick Start

This guide walks you through creating and running your first Orvanta workflow from scratch.

Prerequisites: An Orvanta account (cloud or self-hosted) and the Orvanta CLI installed. See Installation if you haven’t done that yet.

  1. Connect a workspace

    Terminal window
    orvanta workspace add

    Add a workspace profile using a token from User Settings → Tokens. See Installation.

  2. Initialise a project

    Terminal window
    orvanta init

    This sets up a local project directory and sync configuration.

  3. Create a script

    Terminal window
    orvanta script new f/demo/hello bash

    Edit the generated file to print a greeting:

    #!/usr/bin/env bash
    echo "Hello from Orvanta!"

  4. Run it

    Terminal window
    orvanta script run f/demo/hello

    You should see Hello from Orvanta! in the output.

  5. Deploy to the workspace

    Terminal window
    orvanta sync push

    Your script is now in the workspace, where you can wire it into a flow in the editor.

  6. Inspect jobs

    Terminal window
    orvanta job list
    orvanta job logs <id>

What next?

Section titled “What next?”