CLI and GitHub Action

Contents

The CLI and the GitHub Action are open source and free. They check the services listed in .interfacedelta/dependencies.json, the same file that carries your decision rules, owners and acceptances.

Commands

interfacedelta inspect <url> [--mcp-endpoint <url>] [--token <binding>] [--json] [--output <file>]
interfacedelta baseline <url> --output <file> [--mcp-endpoint <url>] [--token <binding>] [--force]
interfacedelta check <url> --baseline <file> [--mcp-endpoint <url>] [options]
interfacedelta check [--dependencies <file>] [options]
interfacedelta accept <dependency> <change-id> --reason <text> (--days <n> | --expires <YYYY-MM-DD>) [--by <who>] [--dependencies <file>]
interfacedelta watch [--dependencies <file>] [--repository <owner/name>] [--ref <branch>] [--force] [--json]

baseline writes the missing baselines the file names; commit them. check inspects every dependency, classifies each change deterministically, decides it with the file's rules and acceptances, and fails the run when a decision blocks. accept records an expiring acceptance for one exact blocked change; check prints the command for it.

Watching from CI (Pro and Team)

export INTERFACEDELTA_API_TOKEN=...   # a watch token from Routing → Watch tokens, with lockfiles:write
interfacedelta watch

watch hands the same dependencies file to InterfaceDelta, which checks every dependency continuously, decides each change with the file's own rules, and delivers the decision before the next build breaks. Run it on the default branch after the file changes, or use the Action with watch: true.

GitHub Action inputs

check
Run the compatibility check (default true).
- uses: arto-a/interfacedelta-action@c06ddb383cbd5d4b4fe487e9af7906f155d72257 # v0.4.0
  with:
    fail-on: breaking,metadata
    on-error: warn
watch
Sync the dependencies file to InterfaceDelta, which checks it continuously and delivers each decision (default false).
- uses: arto-a/interfacedelta-action@c06ddb383cbd5d4b4fe487e9af7906f155d72257 # v0.4.0
  with:
    watch: true
    api-token: ${{ secrets.INTERFACEDELTA_WATCH_TOKEN }}
issues
Open one GitHub issue per decision with the workflow's own GITHUB_TOKEN, then acknowledge it (default false).
- uses: arto-a/interfacedelta-action@c06ddb383cbd5d4b4fe487e9af7906f155d72257 # v0.4.0
  with:
    check: false
    issues: true
    api-token: ${{ secrets.INTERFACEDELTA_DECISIONS_TOKEN }}

Where decisions land

Each block or warn decision goes to its owner by Slack, a signed webhook, email, or a GitHub issue your own workflow opens. Delivery documents the destinations, and Webhooks the signed-webhook contract and the exact decision payload.

Back to contents

Next: Delivery