Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.joggr.ai/llms.txt

Use this file to discover all available pages before exploring further.

Configuration controls how Guided Generative Workflows (GG) behaves at every stage of the pipeline — how checkpoints are committed and whether stages run in the foreground or background. Workflows configuration lives in .joggr/.gg/settings.json at the root of your repository. Edit it directly to change settings.

​
Schema

KeyTypeDefaultDescription
checkpoint.auto_commitbooleanfalseCommit changes after every checkpoint
checkpoint.auto_pushbooleanfalsePush to remote after every checkpoint
agents.{stage}.modestringSee belowExecution mode for a specific stage

​
Checkpoint Settings

Workflows automatically creates a checkpoint at the end of each pipeline stage and after each execution wave. Whether changes are committed (and pushed) depends on your checkpoint settings. 
{
  "checkpoint": {
    "auto_commit": true,
    "auto_push": true
  }
}
auto_commit controls whether checkpoints commit at all. When false (the default), Workflows (“GG”) skips all git operations — files are written to disk but left uncommitted so you can review and commit them manually. Set it to true to have Workflows (“GG”) stage and commit changes after every wave. auto_push controls whether committed checkpoints are also pushed to the remote. Only applies when auto_commit is true. Set it to false to commit locally without pushing.
Use settings.local.json to disable auto-commit or auto-push on your machine without affecting teammates.

​
Execution Mode

Do not change execution modes. Each stage is configured to run in the mode that matches its behavior. Changing a mode can cause stages to hang, skip user confirmation, or run out of order. In particular, planner must remain foreground — it uses interactive prompts and will silently skip confirmation steps if set to background.
Execution modes exist for Workflows’ internal orchestration and are documented here for reference only:
ModeBehavior
foregroundRuns inline in your current session. Used for interactive stages that need user input.
backgroundRuns as a background task. Used for long-running stages that do not need interaction.
teamsRuns as a coordinated background task alongside other stages. Used for parallel execution.

​
Local Overrides

For machine-specific settings that should not be committed to the repository, create a settings.local.json file alongside settings.json: 
.joggr/.gg/settings.json        # Committed to repository (shared)
.joggr/.gg/settings.local.json  # Gitignored (machine-specific)
The local file uses the same schema as settings.json. When both files exist, local values take precedence — they are merged on top of the project settings, with local values winning on conflict.
Use settings.local.json to disable auto-push on a shared branch without affecting teammates.