# readseek
`readseek` is a structural source reader for scripts, editors, and coding agents.
It emits compact JSON with stable line/hash anchors, structural symbol maps, parse
diagnostics, AST search matches, references, and rename plans.
## Installation
Install the npm wrapper and a prebuilt binary:
```sh
npm install -g @jarkkojs/readseek
```
Prebuilt binaries are available for macOS ARM64; Linux ARM64 and x64; and Windows
x64. The Linux binaries are static glibc PIE executables.
To build and install from source:
```sh
make install
```
Source builds require CMake, Clang/libclang, and a C++ compiler because image
inference uses `llama-cpp-2`.
## Plugins
### Pi extension
The bundled [pi-readseek extension](packages/pi-readseek/README.md) exposes
ReadSeek's anchored file and structural-code tools in Pi:
```sh
pi install npm:pi-readseek
```
### OpenCode plugin
The [opencode-readseek plugin](packages/opencode-readseek/README.md) provides the
same anchored and structural tools in OpenCode.
## Common commands
```sh
readseek detect src/main.rs
readseek read src/main.rs:10 --end 20
readseek map src/main.rs
readseek check src/main.rs
readseek symbol src/main.rs:run --name
readseek identify src/main.rs:42 --column 8
readseek def src run --language rust --format plain
readseek refs src main --language rust --format plain
readseek search src 'fn $NAME() { $$$BODY }' --language rust
readseek rename src/main.rs --line 42 --column 8 --to renamed
```
To write JSON output to a file instead of stdout, place the global option before
the command:
```sh
readseek --output result.json detect src/main.rs
```
Use a `stdin:` target prefix with `detect`, `read`, `map`, `check`, `symbol`,
and `identify` to analyze unsaved editor buffers while still providing a path
for language detection and a cursor address:
```sh
printf '%s\n' 'fn main() {}' | readseek identify stdin:scratch.rs:1 --column 4
```
## Images and PDFs
`detect` reports image metadata and PDF page counts. `read` returns bounded
base64 images by default; use `--image` for a local analysis mode:
```sh
readseek read photo.jpg # default: bounded base64 image
readseek read photo.jpg --image caption # detailed natural-language caption
readseek read photo.jpg --image objects # object labels + bounding boxes
readseek read photo.jpg --image ocr # extracted text
readseek read photo.jpg --image all # caption, objects, and OCR in one pass
```
PDF reads return page-tagged Markdown and page-associated embedded images. The
same mode applies to each embedded image. Line/hash suffixes, `--end`, `--limit`,
and `--language` do not apply to visual files.
The Qwen3-VL GGUF model and multimodal projector download lazily into the user
cache and run through `llama-cpp-2` on the CPU. Captioning can take substantial
time.
## Cache
`readseek init [path]` creates and populates `.readseek/maps/` and
`.readseek/def-index/`. Map-dependent commands update entries on demand and
discover `.readseek/` by walking up from the target path, or use the directory
passed by `--readseek-dir`. Image analysis caches results under the `.readseek/`
found from the current working directory.
## Documentation
The manual page provides the full CLI reference:
```sh
man ./man/man1/readseek.1
```
Pass `--help` to any command for command-specific usage.
## Licensing
The native `readseek` crate is licensed under `LGPL-2.1-or-later`. The
`@jarkkojs/readseek` wrapper and platform packages declare
`Apache-2.0 AND LGPL-2.1-or-later`.
The downloaded `Qwen/Qwen3-VL-2B-Instruct-GGUF` model is licensed under
`Apache-2.0`.