Skip to content

Configuration overview

The config root is a flat .overwire/ directory. Every file is plain YAML or JSON, diffable and scriptable. The desktop app edits these files directly; nothing lives in hidden app state.

PathPurpose
settings.ymlRepository owner and Overwire settings.
variables.ymlRepository variables resolved by ${{ vars.* }}.
secrets.ymlSecret declarations, optionally with local-only values.
rulesets.jsonBranch rulesets in GitHub’s native export format.
github/rulesets/*.jsonAdditional exported rulesets.
modes/<workflow>.ymlWorkflow default mode and per-step overrides.
mocks/**/*.ymlMock contracts for uses: steps.
payloads/<event>.jsonSaved event payload overrides.
dispatch/<workflow>.ymlSaved workflow_dispatch input defaults.
pull-requests.ymlLocal pull request scenarios.
statuses.ymlExternal commit statuses and check runs.
api-mocks.ymlDeclarative GitHub API mock routes.
environments/Per-environment variables, secrets, and protection rules.
instances.ymlWorkspace peer list (workspace roots only).
state/Run-derived state. Local-only.
cache/Local workflow cache. Local-only.
.gitignoreScaffolded by overwire init: ignores secrets.yml, state/, and cache/.

overwire.io

Overwire is not affiliated with, endorsed by, or sponsored by GitHub, Inc., Microsoft Corporation, or Docker, Inc. GitHub and GitHub Actions are trademarks of GitHub, Inc.