# allyhub inspect pages

> A doc's pages as render prints them, measured from the PDF: the space at each page's foot, blocks broken over pages with their lines on each, headings near a foot, short last lines, content past the column; and a picture of the pages, each block outlined and labelled by its line in the doc's file

Source: https://allyhub.com/docs/reference/cli/inspect-pages · AllyHub 0.10.0
Index of all docs: https://allyhub.com/llms.txt

## Usage

```bash
allyhub inspect pages [doc] [options]
```

## Arguments

| Argument | Type | What it is |
| --- | --- | --- |
| `<doc>` | string | The doc, by its file or its id in allyhub.yaml |

## Options

| Option | Type | Default | What it does |
| --- | --- | --- | --- |
| `--kind` | list of string |  | Only facts of these kinds: page-fill, page-split, page-heading, page-short-line, page-overflow, page-kinsoku, page-figure, page-picture, page-grid, page-contents |
| `--heading-lines` | integer | `3` | A heading is listed when fewer lines than this follow it on its page |
| `--short-line` | integer | `2` | A paragraph's last line is listed when it holds this many letters or fewer (punctuation not counted) |
| `--all` | boolean | `false` | Every finding on a line of its own, and every heading and every paragraph's last line |
| `--page` | string |  | Draw only these pages, large: 2, 2-4, 1,5 |
| `--out` | string |  | Where the picture goes; default .allyhub/work/inspect/&lt;doc&gt;/pages.webp |

## Global options

`--dir <value>`: the project's folder; default the one around where it is run. `--json`: print the result as JSON.

## Examples

```bash
allyhub inspect pages launch/plan
allyhub inspect pages launch/plan --kind page-split,page-heading
allyhub inspect pages launch/plan --page 3-4 --all
```

## Exit codes

`0` when it succeeds; the others are listed in [Exit codes](https://allyhub.com/docs/reference/cli/exit-codes.md).

## In the work

**docs**: Writing a doc

[`doc cover list`](https://allyhub.com/docs/reference/cli/doc-cover-list.md) → [`doc cover set`](https://allyhub.com/docs/reference/cli/doc-cover-set.md) → [`check`](https://allyhub.com/docs/reference/cli/check.md) → [`frames`](https://allyhub.com/docs/reference/cli/frames.md) → `inspect pages` → [`dev`](https://allyhub.com/docs/reference/cli/dev.md) → [`render`](https://allyhub.com/docs/reference/cli/render.md)
