Skip to content

overwire init

Scaffolds the .overwire/ config root: settings.yml, variables.yml, secrets.yml, the modes/, mocks/, and payloads/ directories, and a .gitignore that keeps secret values and local run state out of git.

Terminal window
overwire init [options]
OptionDescription
--owner <owner>Organization or user owning this repo. Inferred from the git remote if omitted; falls back to local when no remote owner is available.
--config-root <dir>Root for the config tree, relative to cwd (default .overwire).
--forceOverwrite existing config files. Without it, re-running init is create-only and leaves your edits alone.
--workspaceCreate a workspace-level .overwire/ with auto-discovered child repos.

init --workspace writes instances.yml at the workspace config root, listing every child directory that contains a .github/ or .overwire/ tree. Entries store relative paths, so the workspace stays portable across machines.

Terminal window
# Single repo, owner from git remote
overwire init
# Explicit owner
overwire init --owner my-org
# Multi-repo workspace at the parent directory
overwire init --workspace

See Initialize a project for the walkthrough.

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.