Ironflow is pre-1.0: APIs can change between releases. Pin a version. What is ready →
- CLI Reference
- Commands
- ironflow conformance
ironflow conformance
Check your own handler against an Ironflow wire contract. This command contacts no Ironflow server.
ironflow conformance <subcommand> [flags]ironflow conformance push
Section titled “ironflow conformance push”Send the requests the engine sends to a push endpoint, and check each answer against the push protocol. The endpoint must host the four fixture functions on the push conformance page.
ironflow conformance push --url http://localhost:8080/ironflow --signing-key $KEYFlags:
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--url | string | Push endpoint to check. Required. | ||
--signing-key | string | $IRONFLOW_SIGNING_KEY | Key the endpoint verifies X-Ironflow-Signature with. Without it, the signature checks are skipped. | |
--level | int | 3 | Run checks up to this level: 1 transport, 2 steps, 3 sleep yield. | |
--timeout | duration | 10s | Timeout for each request. | |
--json | bool | false | Print the report as JSON. |
Exit codes:
| Code | Meaning |
|---|---|
| 0 | No check failed. |
| 1 | One or more checks failed. |
| 3 | The endpoint did not answer. |
| 4 | A flag is not valid. |
Output:
PASS L1 transport.method-not-allowedFAIL L2 steps.full-replay delta step IDs want: (none) got: run_conf_x:plain:0 run_conf_x:plain:1 contract: https://docs.ironflow.run/reference/api/push-protocol/#memoization-rulesSKIP L1 signature.valid (no --signing-key)
12 passed, 1 failed, 8 skipped