overwire schema
Prints the JSON Schema for a .overwire/ config file format — the same schema the loader validates with at run time, so it can never drift from real behavior. Works offline and always matches the installed version.
overwire schema [options] [name]Arguments
Section titled “Arguments”| Argument | Description |
|---|---|
name | Schema id, e.g. modes, mock-contract, chain. Omit (or pass --list) to list every id. |
Options
Section titled “Options”| Option | Description |
|---|---|
--list | List every available schema id with its file location. |
--json | With --list, emit the index as JSON. |
Published copies
Section titled “Published copies”Every schema is also served from this site at /schemas/<id>.schema.json (index at /schemas/index.json). Reference them from YAML for editor validation and autocompletion:
# yaml-language-server: $schema=https://docs.overwire.io/schemas/modes.schema.jsondefaultMode: mockAvailable ids: settings, variables, secrets, modes, mock-contract, payload-override, dispatch-defaults, chain, pull-requests, statuses, api-mocks, environment-protection, custom-properties, instances. Ruleset files (rulesets.json, github/rulesets/, orgs/) use GitHub’s native ruleset export format and are deliberately not republished here.
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.