npm.io
0.12.6 • Published 1 week ago

pi-readseek

Licence
Apache-2.0
Version
0.12.6
Deps
0
Vulns
0
Weekly
3.7K

pi-readseek

Pi extension for anchored file operations, structural search, symbol navigation, and document inspection.

Install

pi install npm:pi-readseek

The extension uses the AppImage on Linux (without FUSE) and native executables on macOS/Windows supplied by @jarkkojs/readseek. Set READSEEK_BINARY to an absolute executable path to override it.

Tools

readSeek_show, readSeek_tree, readSeek_meta, readSeek_assets, readSeek_grep, readSeek_search, readSeek_def, readSeek_refs, readSeek_syntax, readSeek_check, readSeek_caption, readSeek_objects, readSeek_ocr, readSeek_edit, readSeek_rename, and readSeek_write.

Document content includes cached image paths; capable host models receive image attachments without a separate extraction call. Reading never runs local inference; captioning, detection, and OCR require their explicit tools. Legacy tool names and selectable inspection facets are removed.

Image attachments share a 32 MiB base64-data budget per tool result. Images that would exceed the remaining budget are omitted with a notice and their file path; smaller images later in the result can still be attached.

The four show tools display readable summaries and grouped details rather than JSON dumps. Expand with Ctrl+O to reveal content; long lines wrap on resize. Source anchors, selected document nodes, asset paths, and continuation notices remain visible. Native results are retained in tool-result details.

Settings

Add readseek to ~/.pi/agent/settings.json or .pi/settings.json:

{
  "readseek": {
    "overrideTools": [],
    "imageMode": "auto",
    "syntaxValidation": "warn",
    "timeoutMs": 120000,
    "grep": { "maxLines": 2000, "maxBytes": 51200 },
    "display": {
      "grep": "compact",
      "edit": "expanded",
      "write": "expanded"
    }
  }
}

overrideTools accepts read, edit, write, and grep. imageMode is auto, on, or off; off disables image attachments, while auto and on attach images only when the host supports them. None enables automatic inference. syntaxValidation is warn, block, or off.

Development

npm install
npm test
npm run typecheck

Licensing

pi-readseek is licensed under the Apache 2.0 license. See LICENSE for more information.

Keywords