Skip to main content

Command Contract Template

Create one of these for every public command before it is treated as stable.

# [Command Name] Contract

## Purpose

What does this command do?

## Usage

\`\`\`text
tool command [options]
\`\`\`

## Inputs

- Arguments:
- Options:
- Environment:
- Files:

## Outputs

### Human Output

What appears on stdout during normal interactive use?

### Machine Output

Is `--json` or another structured format supported?
If yes, describe the top-level fields and stability expectations.

### Diagnostics

What appears on stderr?

## Exit Codes

| Code | Meaning |
| --- | --- |
| 0 | Success |
| 1 | General failure |
| 2 | Invalid usage or arguments |
| 3 | Missing input or resource |
| 4 | Validation failed |
| 5 | External dependency unavailable |

## Stability

- Command name:
- Flag names:
- Machine-readable fields:
- Breaking-change policy:

## Examples

### Human Use

\`\`\`text
tool command [options]
\`\`\`

### Automation Use

\`\`\`text
tool command --json [options]
\`\`\`