# allyhub inspect canvas

> A canvas's nodes and edges as its file has them: each node's box, colour and what it holds or points at (an item by its kind), what each group holds by place, each edge's ends, sides and label

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

## Usage

```bash
allyhub inspect canvas [file]
```

## Arguments

| Argument | Type | What it is |
| --- | --- | --- |
| `<file>` | string | The canvas: its path (a .canvas file) |

## 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 canvas launch.canvas
allyhub inspect canvas boards/cuts.canvas --json
```

## 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

**canvases**: Laying a project's work out on a canvas, with notes and edges

`inspect canvas` → [`check`](https://allyhub.com/docs/reference/cli/check.md) → [`dev`](https://allyhub.com/docs/reference/cli/dev.md)
