@jarkkojs/readseek 0.7.0 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +29 -6
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # readseek
2
2
 
3
- `readseek` is a structural source reader for scripts, editors, and coding agents.
3
+ `readseek` is a structural source and PDF reader for scripts, editors, and coding agents.
4
4
  It emits compact JSON with stable line/hash anchors, structural symbol maps, parse
5
5
  diagnostics, AST search matches, references, and rename plans.
6
6
 
@@ -12,6 +12,12 @@ Install the npm wrapper and a prebuilt binary:
12
12
  npm install -g @jarkkojs/readseek
13
13
  ```
14
14
 
15
+ Install the native program from crates.io:
16
+
17
+ ```sh
18
+ cargo install readseek
19
+ ```
20
+
15
21
  Prebuilt binaries are available for macOS ARM64; Linux ARM64 and x64; and Windows
16
22
  x64. The Linux binaries are static glibc PIE executables.
17
23
 
@@ -24,6 +30,9 @@ make install
24
30
  Source builds require CMake, Clang/libclang, and a C++ compiler because image
25
31
  inference uses `llama-cpp-2`.
26
32
 
33
+ GPU acceleration can be enabled at build time with the `metal`, `opencl`, `rocm`,
34
+ or `vulkan` Cargo feature.
35
+
27
36
  ## Plugins
28
37
 
29
38
  ### Pi extension
@@ -40,11 +49,21 @@ pi install npm:pi-readseek
40
49
  The [opencode-readseek plugin](packages/opencode-readseek/README.md) provides the
41
50
  same anchored and structural tools in OpenCode.
42
51
 
52
+ Add the plugin to `opencode.json`:
53
+
54
+ ```json
55
+ {
56
+ "plugin": ["opencode-readseek"]
57
+ }
58
+ ```
59
+
43
60
  ## Common commands
44
61
 
45
62
  ```sh
46
63
  readseek detect src/main.rs
47
64
  readseek read src/main.rs:10 --end 20
65
+ readseek read report.pdf --page 3
66
+ readseek view report.pdf --page 3
48
67
  readseek map src/main.rs
49
68
  readseek check src/main.rs
50
69
  readseek symbol src/main.rs:run --name
@@ -83,9 +102,12 @@ readseek read photo.jpg --image ocr # extracted text
83
102
  readseek read photo.jpg --image all # caption, objects, and OCR in one pass
84
103
  ```
85
104
 
86
- PDF reads return page-tagged Markdown and page-associated embedded images. The
87
- same mode applies to each embedded image. Line/hash suffixes, `--end`, `--limit`,
88
- and `--language` do not apply to visual files.
105
+ PDF reads return page-tagged Markdown and page-associated embedded images. Use
106
+ `--page` to select one page; the same image mode applies to each embedded image.
107
+ After initializing `.readseek/`, `view` creates or reuses a persistent structural
108
+ PDF index and returns an overview that can be narrowed by page, node, kind, or
109
+ depth. Line/hash suffixes, `--end`, `--limit`, and `--language` do not apply to
110
+ visual files.
89
111
 
90
112
  The Qwen3-VL GGUF model and multimodal projector download lazily into the user
91
113
  cache and run through `llama-cpp-2` on the CPU. Captioning can take substantial
@@ -96,8 +118,9 @@ time.
96
118
  `readseek init [path]` creates and populates `.readseek/maps/` and
97
119
  `.readseek/def-index/`. Map-dependent commands update entries on demand and
98
120
  discover `.readseek/` by walking up from the target path, or use the directory
99
- passed by `--readseek-dir`. Image analysis caches results under the `.readseek/`
100
- found from the current working directory.
121
+ passed by `--readseek-dir`. `view` creates PDF structure indexes and extracted
122
+ assets under `.readseek/documents/` on demand. Image analysis caches results
123
+ under the `.readseek/` found from the current working directory.
101
124
 
102
125
  ## Documentation
103
126
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jarkkojs/readseek",
3
- "version": "0.7.0",
3
+ "version": "0.7.1",
4
4
  "description": "A structural read command",
5
5
  "license": "Apache-2.0 AND LGPL-2.1-or-later",
6
6
  "homepage": "https://github.com/jarkkojs/readseek#readme",
@@ -21,10 +21,10 @@
21
21
  "LICENSE-LGPL-2.1"
22
22
  ],
23
23
  "optionalDependencies": {
24
- "@jarkkojs/readseek-darwin-arm64": "0.7.0",
25
- "@jarkkojs/readseek-linux-arm64": "0.7.0",
26
- "@jarkkojs/readseek-linux-x64": "0.7.0",
27
- "@jarkkojs/readseek-win32-x64": "0.7.0"
24
+ "@jarkkojs/readseek-darwin-arm64": "0.7.1",
25
+ "@jarkkojs/readseek-linux-arm64": "0.7.1",
26
+ "@jarkkojs/readseek-linux-x64": "0.7.1",
27
+ "@jarkkojs/readseek-win32-x64": "0.7.1"
28
28
  },
29
29
  "publishConfig": {
30
30
  "access": "public"