# allyhub frames web

> A web page's screenshot with its named elements' boxes in the image's pixels, for a screen demo

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

## Usage

```bash
allyhub frames web [url] [options]
```

## Arguments

| Argument | Type | What it is |
| --- | --- | --- |
| `<url>` | string | The page: an address, or an HTML file on this computer |

## Options

| Option | Type | Default | What it does |
| --- | --- | --- | --- |
| `--el` | list of string |  | An element to locate, name=selector (CSS, or text=&lt;words&gt;); [data-el] elements are found too |
| `--click` | list of string |  | Selectors clicked in order before the shot (close a banner, open a dialog) |
| `--full` | boolean | `false` | The whole page, not one viewport |
| `--out` | string |  | Where the picture goes (a WebP), its boxes in &lt;out&gt;.elements.json beside it; default under .allyhub/work/pages/ |
| `--size` | string | `"1440x900"` | The viewport, WIDTHxHEIGHT in CSS pixels |
| `--scale` | number | `1` | Image pixels per CSS pixel; 2 draws a high-density screen, sharp when a camera goes in |
| `--wait` | integer |  | Milliseconds to wait after loading and clicking |

## Global options

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

## Output

With `--json`, the command prints an object with these fields:

| Field | Type | What it is |
| --- | --- | --- |
| `out` | string |  |
| `elementsFile` | string |  |

## Examples

```bash
allyhub frames web https://example.com --el cta=text=Sign\ up --scale 2 --out assets/media/home
allyhub frames web page.html --click '#accept' --full
```

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

**websites**: Making a website: any web project, with its website JSON listed in allyhub.yaml

[`check`](https://allyhub.com/docs/reference/cli/check.md) → [`render`](https://allyhub.com/docs/reference/cli/render.md) → `frames web` → [`frames compare`](https://allyhub.com/docs/reference/cli/frames-compare.md) → [`site deploy`](https://allyhub.com/docs/reference/cli/site-deploy.md) → [`site status`](https://allyhub.com/docs/reference/cli/site-status.md) → [`site live`](https://allyhub.com/docs/reference/cli/site-live.md)

**researching**: Researching a market online: social, ads, seo, web-search, ecommerce, app-stores

`<work>` → `<work> <tool>` → `frames web`
