OmegaFlow

	Description
Project
Code quality
Docs and support

Website and docs: omegaflow.dev

OmegaFlow turns scripted terminal workflows into rebuildable videos for docs, tutorials, release notes, and technical demos.

Instead of recording a one-off screen capture, you write a versioned Markdown recording script. The script contains prose for readers, YAML directives for OmegaFlow, terminal commands to run, expected output checks, optional generated voiceover, and publish targets. OmegaFlow records the terminal session, lines it up with the script and narration, and writes website-ready assets.

Use it when a demo should live with the code it explains:

• rebuild videos when commands, docs, or setup steps change
• keep terminal demos reviewable in source control
• generate optional voiceover from the same recording script
• publish videos as plain HTML or embedded Docusaurus pages

OmegaFlow is currently supported on Linux, macOS, and WSL on Windows.

Quick Start

Install OmegaFlow in your project's Python environment:

python -m pip install omegaflow

Create the initial recording workspace:

omegaflow action=bootstrap

Build the generated quickstart recording:

omegaflow recording=quickstart

Watch the result locally:

omegaflow recording=quickstart action=watch

The full guide and reference docs are at omegaflow.dev.

Repository

This repository contains:

• the omegaflow Python package and command line tool
• the Docusaurus website for omegaflow.dev
• the homepage quickstart demo recording
• tutorial recording scaffolding under recordings/

Development

nox -s tests
nox -s schema_docs
nox -s package
pnpm --dir website build
omegaflow recording=quickstart-demo

The current repository also preserves older OmegaFlow design work under docs/future/.

Deployment

The website is configured for https://omegaflow.dev and includes a GitHub Pages workflow at .github/workflows/deploy-website.yml. The workflow builds website/ with pnpm and deploys website/build; website/static/CNAME contains the custom domain.