Quickstart

This quickstart runs a local script component, captures an output, inspects state, and tears the environment down.

Install ork

On macOS:

brew install orkhq/tap/ork

On Linux, or for a direct installer:

curl -fsSL https://tryork.dev/install | sh

Create A Manifest

Generate a starter manifest:

ork init --id hello

Or create ork.yaml manually:

version: ork/1.0

metadata:
  id: hello
  description: Local script example
  owner:
    name: ork
    email: ork@example.com

runners:
  local:
    type: local
    config: {}

components:
  hello:
    type: script
    runner: local
    source:
      embedded: |
        echo "message=hello from ork" >> "$ORK_OUTPUT_ENV"
    outputs:
      - name: message

Apply

ork up -e demo

ork applies the component and writes state under .ork/demo by default.

The environment ID names this concrete instance of the manifest. To boot another variant, use a different ID:

ork up -e demo-two

Inspect

ork state inspect -e demo

The default table output shows component status, stage, type, runner, and timestamps. It intentionally does not print outputs, payloads, or artifact contents.

Destroy

ork down -e demo

After a successful destroy, ork deletes the whole environment state bundle, including artifacts.