---
url: /glimpse/config/cli/glimpse-shot.md
---
# glimpse-shot

Examples:
glimpse-shot                                       open the screenshot app
glimpse-shot --screen                              freeze the screen and mark it up
glimpse-shot --window                              pick a window, then mark it up
glimpse-shot --screen --json                       ask a human to mark something; read the marks
glimpse-shot capture --copy --no-save              copy the focused output, no file, no UI
glimpse-shot capture --window -o shot.png          the focused window, to a file
glimpse-shot capture --region "$(slurp)" -o -      a selected rectangle, PNG on stdout
glimpse-shot list --json                           outputs and windows with geometry

Take a screenshot, mark it up, save or copy it.

```text
Usage: glimpse-shot [OPTIONS] [FILE.png] [COMMAND]

Commands:
  capture   Take a screenshot without any window or overlay
  annotate  Annotate an existing image
  prime     Print the complete agent guide
  list      List outputs and windows with their geometry
  help      Print this message or the help of the given subcommand(s)

Arguments:
  [FILE.png]  Open this image on the Result page.

Options:
      --screen [<NAME>]      The current output, or the one named.
      --window [<ID>]        A window: picked by hand, the focused one, or the one with this id.
      --region [<GEOMETRY>]  A rectangle as "X,Y WxH" in the compositor's logical layout, or dragged by hand.
      --editor <WHERE>       overlay or window [default: from [screenshot] editor]
  -o, --output <FILE>        Where Ctrl+S saves.
      --tool <TOOL>          Start with this tool instead of the arrow. [possible values: crop, arrow, line, freehand, highlighter, rect, filled-rect, oval, number, text, blur]
  -a, --annotate <FILE>      Draw these annotations (JSON file or -); see --help for the format.
  -d, --delay <SECONDS>      Count down this long before freezing the screen, 0 to 60.
      --cursor               Include the pointer.
      --no-cursor            Leave the pointer out.
      --flash                Flash the screen on capture.
      --no-flash             Do not flash the screen.
      --notify               Post a notification when saved or copied.
      --no-notify            Post no notification.
      --scale <SCALE>        Save at buffer size, or downscale to logical size. [default: buffer] [possible values: buffer, logical]
      --json                 Print the result object when the human finishes.
      --prompt <TEXT>        A banner saying what is being asked for, plain text.
      --timeout <SECONDS>    Close the editor unanswered after this long, exit 7.
      --config-dir <DIR>     Directory stacked above the user configuration. [env: GLIMPSE_CONFIG_DIR=]
      --log-format <FORMAT>  Select the log output format (plain text or JSON). [default: plain] [possible values: plain, json]
      --log <LEVEL>          Set the logging filter (for example, info, debug, or trace). [env: RUST_LOG=] [default: info]
      --color <WHEN>         Controls when to use color [default: auto] [possible values: auto, always, never]
  -h, --help                 Print help (see more with '--help')
  -V, --version              Print version

Agents: run `glimpse-shot prime` for the full contract.
```

The options above work with every command and are not repeated below.

## `glimpse-shot capture`

Take a screenshot without any window or overlay

```text
Usage: glimpse-shot capture [OPTIONS]

Options:
      --copy                 Put the PNG on the clipboard.
      --no-save              Write no file; needs --copy.
  -h, --help                 Print help (see more with '--help')

Agents: run `glimpse-shot prime` for the full contract.
```

## `glimpse-shot annotate`

Annotate an existing image

```text
Usage: glimpse-shot annotate [OPTIONS] [IMAGE]

Arguments:
  [IMAGE]  Image to edit (PNG, JPEG, WebP, …).

Options:
      --pick                 Choose an image when IMAGE is omitted.
      --headless             Export without opening an editor; needs --annotate.
      --copy                 Put the PNG on the clipboard.
      --no-save              Write no file; needs --copy.
  -h, --help                 Print help (see more with '--help')

Agents: run `glimpse-shot prime` for the full contract.
```

## `glimpse-shot prime`

Print the complete agent guide

```text
Usage: glimpse-shot prime [OPTIONS]

Options:
  -h, --help                 Print help
```

## `glimpse-shot list`

List outputs and windows with their geometry

```text
Usage: glimpse-shot list [OPTIONS]

Options:
  -h, --help                 Print help
```