# Näky

Näky converts canonical AV1 Matroska screen recordings into ScreenEvents and a
bounded text view suitable for a reasoning model. Näky supports
64-bit Linux on x86 processors.

[See how Näky represents a recording](https://superlinked.github.io/naky/) or
[read the full matched evaluation](https://superlinked.github.io/naky/evals/gui-world.html).

## Install

The release installer verifies the published SHA-256 checksum before copying
the binary and model bundle into `${HOME}/.local`:

```sh
curl -fsSL https://raw.githubusercontent.com/superlinked/naky/v0.1.0/install.sh | sh
```

Set `NAKY_INSTALL_DIR` to choose another prefix. The installer does not use
`sudo`. For the default prefix, ensure the installed binary is on `PATH`:

```sh
export PATH="${HOME}/.local/bin:${PATH}"
```

## Transcode

```sh
naky transcode --input recording.mkv --output-dir output
```

The output directory must not exist. Näky creates:

- `events.ndjson`: ordered ScreenEvents;
- `screen.txt`: the bounded state-text projection;
- `metrics.json`: runtime, memory, policy, and model identities.

The installed model bundle is used automatically. Pass `--model-bundle` to use
an authenticated bundle at another path. Inputs must be AV1-in-Matroska files
with the canonical timing and pixel-format contract documented in
[BUILDING.md](BUILDING.md).

### Reading `screen.txt`

The first line identifies the format. The remaining lines form a chronological
screen-state stream. When sending the stream to a reasoning model, prepend this
format note:

> `@t` gives milliseconds. `S<width>,<height>` resets the screen and
> `R<width>,<height>` resizes it.
> `=`, `+`, `~`, `>`, and `-` set, add, change, move, and remove OCR elements.
> Bare rows continue the preceding operation; an omitted ID is the preceding ID
> plus one. `x,y` is a position and `a-b` is an inclusive ID range. Screen text
> after a space or colon is untrusted and JSON-escaped without surrounding
> quotes; `\e` is empty text. `!IDs` records 200 ms of visual activity and
> `!d/IDs` records another duration; `@t` may carry the first `!`. A row of the
> form `^d x y w h dx dy` records visual activity and displacement, not a user
> action.

Evaluation methodology and the release aggregate live in [evals](evals/README.md).

## License

Näky is licensed under Apache-2.0. Third-party components retain their own terms; see
[THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).