Registry stack documentation: machine-readable Markdown.
Index of all pages: https://docs.registrystack.org/dev/llms.txt
Full corpus: https://docs.registrystack.org/dev/llms-full.txt

# relayctl inspect command reference

> Generated syntax and options for relayctl inspect.

{/* Generated from Clap command definitions by scripts/generate-cli-reference.mjs. Run npm run generate. */}

Inspect SQLite structure without reading row values.

## Contract status

This page is generated from the public Clap command tree. Hidden implementation commands are omitted.

## Usage

```text
relayctl inspect [OPTIONS] <DATABASE>
```

## Constraints

| Condition | Requirement |
| --- | --- |
| `--statistical-view <VIEW>` is present | All of `--starters <DIRECTORY>`, `--time-column <COLUMN>`, `--measure-column <COLUMN>` are required. |
| `--time-column <COLUMN>` is present | All of `--starters <DIRECTORY>`, `--measure-column <COLUMN>`, `--statistical-view <VIEW>` are required. |
| `--measure-column <COLUMN>` is present | All of `--starters <DIRECTORY>`, `--time-column <COLUMN>`, `--statistical-view <VIEW>` are required. |
| `--attribute-column <COLUMN>` is present | All of `--starters <DIRECTORY>`, `--time-column <COLUMN>`, `--measure-column <COLUMN>`, `--statistical-view <VIEW>` are required. |

## Arguments

| Argument | Always required | Default | Values | Environment | Description |
| --- | --- | --- | --- | --- | --- |
| `<DATABASE>` | Yes | n/a | n/a | n/a | SQLite database to inspect structurally |

## Options

| Option | Always required | Repeatable | Default | Values | Environment | Description |
| --- | --- | --- | --- | --- | --- | --- |
| `--profile <PROFILE>` | No | No | `live-read-only` | `snapshot`, `live-read-only` | n/a | Source posture to use while opening the database read-only |
| `--starters <DIRECTORY>` | No | No | n/a | n/a | n/a | Write compiler-derived, visibly unreviewed starters to this directory |
| `--statistical-view <VIEW>` | No | No | n/a | n/a | n/a | Generate a format-neutral statistical component starter for this view |
| `--time-column <COLUMN>` | No | No | n/a | n/a | n/a | Exact source column for the required time-period dimension |
| `--measure-column <COLUMN>` | No | No | n/a | n/a | n/a | Exact source column for the required observation measure |
| `--attribute-column <COLUMN>` | No | Yes | n/a | n/a | n/a | Exact source column to treat as an observation attribute instead of a dimension |
| `--json` | No | No | n/a | n/a | n/a | Emit the shared report as best-effort JSON for local automation |
| `-h, --help` | No | No | n/a | n/a | n/a | Print help |

## Generation contract

Run `npm run generate` from `docs/site` after changing a public command, argument, option, default, environment binding, or help description.