Hello, workflow (60 seconds)

Steps

1. Open Workflows (Cmd/Ctrl+Shift+G) and choose New workflow.

2. Under Settings (next to Editor), name it Hello workflow.

3. Add a Code block. New Code blocks start as Bash.

4. In Properties → Code, set the snippet to:

   echo '{"ok":true}'

5. Open Properties → Schema and add a property named ok with type boolean.

6. Click Save, then Run.

The same workflow as YAML

Open the YAML tab. You should see something like this. The block ID is generated, so yours may differ.

schema: 1
name: Hello workflow
id: hello-workflow
blocks:
  - id: hello
    name: Hello
    kind: code
    language: bash
    body: |
      echo '{"ok":true}'
    outputs:
      type: object
      properties:
        ok:
          type: boolean

Check your run

Why the last line matters

Because the block declares an output (ok), the last non-empty line of stdout must be one JSON object, and that object must include ok as a boolean. Stage 2 covers this rule in detail.

Reference: Build a workflow → In 60 seconds

Pass a value to the next block

Steps

1. Create a new workflow and paste this into the YAML tab:

schema: 1
name: Pass a value
id: pass-a-value
blocks:
  - id: make_name
    name: Make name
    kind: code
    language: python
    body: |
      import json
      print(json.dumps({"name": "Ada"}))
    outputs:
      type: object
      properties:
        name:
          type: string

  - id: greet
    name: Greet
    kind: code
    language: python
    uses: [steps.make_name.name]
    body: |
      import json, os
      with open(os.environ["TERMORQ_INPUT"], encoding="utf-8") as f:
          data = json.load(f)
      name = data["steps"]["make_name"]["name"]
      print(json.dumps({"greeting": f"Hello, {name}!"}))
    outputs:
      type: object
      properties:
        greeting:
          type: string

2. Switch to Editor. Each card shows steps.<id> near its lower edge.
3. Select Greet and open Properties → Input. Available data lists steps.make_name.name with a string pill.
4. Click Save, then Run.

What happened

• make_name printed {"name": "Ada"} as its last line. Because name is declared in outputs, Termorq published it as steps.make_name.name.

• greet listed steps.make_name.name under uses. Termorq wrote a temporary JSON file containing only that value, keeping its nesting:

  {"steps":{"make_name":{"name":"Ada"}}}

• TERMORQ_INPUT holds the path to that file, not the JSON itself.

Check your run

  - id: shout
    kind: code
    language: python
    uses: [steps.greet.greeting]
    body: |
      import json, os
      data = json.load(open(os.environ["TERMORQ_INPUT"], encoding="utf-8"))
      print(json.dumps({"loud": data["steps"]["greet"]["greeting"].upper()}))
    outputs:
      type: object
      properties:
        loud:
          type: string

Save, and fix what Save rejects

Save checks the draft before writing anything. If the check fails, Termorq doesn’t write the file, doesn’t leave the page, and doesn’t start a run. The Not saved panel lists up to 20 reasons, one per line:

Line 19: property 'foo' is not recognised.
Line 23, column 13: malformed YAML.

Steps

1. Open your Pass a value workflow in YAML.
2. Add colour: blue under the greet block and click Save. The panel says property 'colour' is not recognised.
3. Change uses: [steps.make_name.name] to uses: [steps.make_name.nme] and click Save again. Save says 'steps.make_name.nme' is not a property this block can use., because make_name doesn’t declare nme.
4. Undo both changes and Save.

Rules the checker enforces

Unsaved edits

• The title shows Unsaved until you save.
• Run uses the draft on screen. It doesn’t write the file.
• If you leave with unsaved changes (via Back, Esc, the shortcut, or the jump list), Termorq asks Stay, Discard, or Save. Focus starts on Stay.

Reference: Build a workflow → YAML

Run, watch, and inspect

Watching a run

With prefers-reduced-motion: reduce, the colours and labels stay and the motion is turned off.

Make it fail

1. In Pass a value, change the greet body’s last line to print("not json").
2. Click Run. Greet turns red, and Output says the last non-empty line must be a JSON object.
3. Open the Runs tab and select the run. Every block captured at the start of the run is listed. Blocks that never ran are marked not run.
4. Use Copy input and Copy output on a block to copy exactly what it received and returned. Secret values stay masked.
5. Fix the line and run again.

Pause and Stop

• Pause run lets the current block finish, then holds the next one.
• Stop ends the process tree immediately, without asking for confirmation.