Skip to content

Directory layout

Overwire separates committable project config from local machine state. This page maps every location it touches.

PathWhat it isCommittable
.github/workflows/*.ymlYour workflow files. Overwire reads them; it never modifies them.Yes (yours)
.overwire/The config root: settings, variables, modes, mocks, payloads, scenario files.Yes
.overwire/secrets.ymlSecret declarations, optionally with local values.No (ignored by the scaffolded .gitignore)
.overwire/state/Run-derived state: API captures, sessions, status checks, suggestions.No (ignored)
.overwire/cache/Local workflow cache entries when configured to use the project cache.No (ignored)
PathWhat it is
~/.cache/overwire/runs/<owner>/<repo>/<run-id>/The run store. Every run persists a self-contained record here.
~/.cache/overwire/actions/Cached action sources fetched for live runs.
~/.cache/overwire/tool-cache/Persisted runner tool cache, mounted as RUNNER_TOOL_CACHE across runs.
~/.cache/overwire/concurrency/Cross-process concurrency lock files.
~/Library/Application Support/Overwire/Desktop app state: window layout, recent projects, theme, runner image settings.
~/.config/overwire/license.jsonThe Pro license state shared by the desktop app and the CLI. Deactivate before deleting — see Uninstall & reset.
PathWhat it is
%USERPROFILE%\.cache\overwire\runs\<owner>\<repo>\<run-id>\The run store. Every run persists a self-contained record here.
%USERPROFILE%\.cache\overwire\actions\Cached action sources fetched for live runs.
%USERPROFILE%\.cache\overwire\tool-cache\Persisted runner tool cache, mounted as RUNNER_TOOL_CACHE across runs.
%USERPROFILE%\.cache\overwire\concurrency\Cross-process concurrency lock files.
C:\Program Files\Overwire\The installed app itself, managed by its installer and uninstaller.
%APPDATA%\Overwire\Desktop app state: window layout, recent projects, theme, runner image settings.
%APPDATA%\overwire\license.jsonThe Pro license state shared by the desktop app and the CLI. Deactivate before deleting — see Uninstall & reset.

Windows folder names are case-insensitive, so %APPDATA%\Overwire (app state) and %APPDATA%\overwire (license) are the same folder: app state and the license file live together.

Everything under ~/.cache/overwire/ (macOS) or %USERPROFILE%\.cache\overwire\ (Windows) is rebuildable: deleting it loses run history and forces action re-fetching and tool re-installation, but breaks nothing. overwire cache inspects and clears the action and tool caches without manual deletion.

Live runs require a Docker-API-compatible container engine (e.g., Docker Desktop, Colima, OrbStack, Rancher Desktop). Overwire connects to the engine’s socket and manages its own runner containers and the overwireio/runner image. It never bundles or installs a container engine.

overwire.io Privacy Terms

Overwire is not affiliated with, endorsed by, or sponsored by GitHub, Inc. “GitHub” and “GitHub Actions” are trademarks of GitHub, Inc.