Build Your First Video

Start from the root of the repository where you want to keep the recording source.

Create the workspace

omegaflow bootstrap=project

OmegaFlow creates project settings, recording defaults, ignored local service credentials, and a small test-video recording. The generated source belongs in version control; runtime runs and secrets do not.

Understand the generated source

recordings/test-video/index.md separates the information you author by purpose:

• Frontmatter contains basic metadata: kind, title, and description. The directory name supplies the command-line recording id.
• One optional leading config directive contains production settings that differ from workspace defaults.
• One optional panes directive declares reusable panes for multi-pane video.
• Each singular beat directive defines one section of the video, in playback order.

---
kind: video
title: Test Video
---

```yaml studio-directive
config:
  audio:
    enabled: false
```

```yaml studio-directive
beat:
  id: first-video-beat
  heading: First Video Beat
  actions:
  - commands:
    - run: "# First video beat"
```

The frontmatter title becomes the player title. Each following beat block becomes its own section in the player.

Build and watch

omegaflow recording=test-video action=build
omegaflow recording=test-video action=watch

The build captures the scripted workflow and assembles a local player. Watch serves the latest successful build and rebuilds when the recording source changes.

Recordings that read additional source files can declare them with command-level inputs so those changes also trigger a rebuild. This is an optional freshness optimization; force=true always captures the workflow again.

Make one source change

Open recordings/test-video/index.md and change the visible text in one terminal command and its matching expectation. Save the file. The watch process waits briefly for editing to settle, rebuilds the video, and reports when the watched surface is updated. Refresh the player to load that completed build.

Before publishing a recording, check its generated artifacts:

omegaflow recording=test-video action=check

You now have the core loop: author, build, watch, and check. Use Next steps to add browser capture, narration, timing, or guided playback.