CLI reference

---
title: CLI reference
description: The options the illustrative toolbox reads from its configuration file.
updatedAt: '2026-09-17'
---

## Configuration file

The illustrative toolbox reads a single configuration file. Every field is
optional, and an absent field keeps the documented default.

```json
{
  "version": 1,
  "preview": true,
  "include": ["src/**/*.md"],
  "exclude": ["dist/**"]
}
```

## Field notes

- `version` pins the configuration shape, so an older file fails loudly instead
  of being reinterpreted against newer defaults.
- `preview` prints the proposed change without applying it. It defaults to
  `true`, because the reviewable path should be the one an author gets by
  accident.
- `include` and `exclude` are evaluated in that order, so a path matched by both
  is excluded.

This reference is illustrative and documents no released command. The command
these fields configure is the one in
[install the example workflow](../guide/install.md).