xlflow inspect
Inspect saved workbook state or UserForm state.
Usage
bash
xlflow inspect workbook
xlflow inspect sheets
xlflow inspect range --sheet <sheet> --address <range>
xlflow inspect range --sheet <sheet> --address <range> --session
xlflow inspect form <name> [--runtime|--designer|--both]Options and Arguments
| Option / argument | Description | Default |
|---|---|---|
workbook | Return workbook-level metadata. | - |
sheets | List worksheets. | - |
range | Read a worksheet range. | - |
used-range | Read a worksheet used range. | - |
cell | Read one cell. | - |
form <name> | Inspect UserForm state. | - |
--sheet <name> | Worksheet for sheet-scoped inspection. | - |
--address <range> | A1 address for range or cell inspection. | - |
--max-rows <n> | Limit rows returned by range or used-range inspection. | 100 |
--max-cols <n> | Limit columns returned by range or used-range inspection. | 30 |
--session | Inspect the live workbook in the managed xlflow session. | false |
--keepalive | Emit heartbeat lines while live session inspect runs. | false |
--runtime / --designer / --both | Choose UserForm inspection mode. | runtime |
Examples
bash
xlflow inspect workbook --json
xlflow inspect range --sheet Result --address A1:F20 --json
xlflow inspect range --sheet Result --address A1:F20 --session --include-style --json
xlflow inspect form CalendarForm --both --jsonNotes
WARNING
Most inspect commands read the saved workbook by default. Add --session when you need the live workbook state that is still open and unsaved in Excel.
IMPORTANT
Runtime UserForm inspection may execute initializer code on a temporary workbook copy.
JSON Output Example
Successful --json output uses the xlflow envelope plus command-specific fields.
json
{
"status": "ok",
"command": "inspect range",
"sheet": "Result",
"address": "A1:F20",
"values": [
["Name", "Amount"],
["A", 42]
]
}