Skip to content

Run

Run is the workflow. It runs agent roles, opens worktrees, displays data in the terminal and more. Each workflow builds from a single instance of Run.

How it works

AGL hands the top-level Run a branch, agl/<label>. All agents work on it, or on branches of their own, which start from it by default.

  • Run.step() - Run an agent on Run's branch.
  • Run.worktree() - Create a worktree whose base points to Run's branch. Returns a new instance of Run. Chain with Run.step() to work in parallel.
  • Run.integrate() - Merge changes from a worktree to its parent.
  • Run.verify() - Run a command and return a VerifierOutcome.
  • Run.terminal - Display data in the terminal and ask questions in it.
  • Run.config - Read your repository's settings for the workflow, like its build command.
  • Run.params - The parameters the workflow was run with.
  • Run.label - The label given to this run with -n.
  • Run.namespaces - The names of the worktrees from the top-level Run down to this one.

See also

Reference

agl.sdk.Run dataclass

What a workflow receives to read its parameters, run steps and open worktrees.