Skip to content

CLI overview

The CLI is the scriptable companion to the desktop app. Both run the same engine, share the same .overwire/ config, and write to the same run store.

Terminal window
overwire [options] [command]
CommandPurpose
initScaffold a flat .overwire/ config tree
doctorHealth-check Node, the container engine, and your config
parseParse a workflow YAML file and print its structure
listList workflows with their triggers and jobs
lintLint a workflow file for common issues
explainExplain how Overwire would support a workflow without running it
simulatePrint a simulated event payload
runExecute a workflow locally, mock by default
chainRun or inspect workflow-chain scenario sessions
resolveFetch and parse an action’s action.yml
seed-mocksWrite a mock contract for every uses: in a workflow
statusShow latest workflow and check status for a ref or SHA
historyList recent workflow runs for the current project
cacheInspect or clear the action cache

Most commands accept --config-root <dir> to point at a .overwire/ directory outside the current working directory. When the config root is some/repo/.overwire, the project identity derives from some/repo.

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.