BranchPy
Log in

How BranchPy Works

This page gives you the mental model first, so feature pages make sense faster.

BranchPy analysis pipeline

  1. Analyze Full project analysis that builds the core data model.
  2. Flowchart Interactive story-structure visualization based on Analyze output.
  3. Doctor Environment and configuration diagnostics.
  4. Media Validation Missing and unreferenced asset checks.
  5. Compare Diff two runs/reports to spot regressions.

Advanced / experimental: Pilot (faster structural scan for iteration) and Omega (state-space bounds derived from Pilot output). Both require a prior Analyze run and are not needed for a first-time pass.

Practical order for first-time users

  1. Run Analyze.
  2. Open Flowchart.
  3. Check Doctor if setup/runtime feels off.
  4. Run Media Validation before release.
  5. Use Compare when reviewing changes between builds.

Command map (quick)

branchpy --project <path> analyze --open
branchpy --project <path> flowchart --open
branchpy --project <path> doctor --json
branchpy --project <path> media --open
branchpy compare --old <src> --new <src> --json

What is optional vs core

  • Core for most teams: Analyze, Flowchart, Media Validation, Compare.
  • Optional advanced workflows: Pilot and experimental layers.