# `CommitOptions.dryRun`

> Contract 2.0.0 · package sha256 `a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e` · generated from `configurator-runtime.d.ts` by `services/onsite-scripter/scripts/build-contract-docs.mjs`; edit the source, not this file.

Property of [`CommitOptions`](CommitOptions.md) · inherited by [`WriteOptions`](WriteOptions.md), [`TransactionOptions`](TransactionOptions.md) · stable · since 2.0.0

```ts
dryRun?: boolean;
```

Runs and reports, then rolls back by design ('dry-run'). Nothing is shown; seq and revision
stay. It never coalesces in the write queue: it neither supersedes a pending write nor is
superseded (spec section 6.1, O2c), and its [`supersede`](CommitOptions.supersede.md) rolls nothing back (O2d). It runs no
[`beforeCommit`](Session.beforeCommit.md) function and never gates the display: its `patch` is the write's own change,
without what a hook would add to the commit (O11).

**Default:** false

## Generic-API test (spec 3.1)

| Rule | Result |
| --- | --- |
| 1. Neutral name | pass: `dryRun` names no product |
| 2. A precedent | not recorded: no ledger row (coverage.json) names this member or its owner |
| 3. Two apps, or labs | not recorded: no ledger row names this member or its owner |
| 4. The cheaper fix first | not recorded per member (Appendix B decides it per need) |