@jarkkojs/readseek 0.6.11 → 0.6.12
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.
- package/README.md +29 -20
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -1,30 +1,32 @@
|
|
|
1
1
|
# readseek
|
|
2
2
|
|
|
3
3
|
`readseek` is a structural source reader for scripts, editors, and coding agents.
|
|
4
|
-
It emits
|
|
5
|
-
|
|
4
|
+
It emits compact JSON with stable line/hash anchors, structural symbol maps, parse
|
|
5
|
+
diagnostics, AST search matches, references, and rename plans.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Installation
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Install the npm wrapper and a prebuilt binary:
|
|
10
10
|
|
|
11
11
|
```sh
|
|
12
|
-
|
|
12
|
+
npm install -g @jarkkojs/readseek
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Prebuilt binaries are available for macOS ARM64; Linux ARM64 and x64; and Windows
|
|
16
|
+
x64. The Linux binaries are static glibc PIE executables.
|
|
17
|
+
|
|
18
|
+
To build and install from source:
|
|
16
19
|
|
|
17
20
|
```sh
|
|
18
|
-
|
|
21
|
+
make install
|
|
19
22
|
```
|
|
20
23
|
|
|
21
|
-
|
|
22
|
-
Windows x64. The Linux binaries are static glibc PIE executables.
|
|
23
|
-
|
|
24
|
-
Local builds require CMake, Clang/libclang, and a C++ compiler because image
|
|
24
|
+
Source builds require CMake, Clang/libclang, and a C++ compiler because image
|
|
25
25
|
inference uses `llama-cpp-2`.
|
|
26
26
|
|
|
27
|
-
##
|
|
27
|
+
## Plugins
|
|
28
|
+
|
|
29
|
+
### Pi extension
|
|
28
30
|
|
|
29
31
|
The bundled [pi-readseek extension](packages/pi-readseek/README.md) exposes
|
|
30
32
|
ReadSeek's anchored file and structural-code tools in Pi:
|
|
@@ -33,6 +35,11 @@ ReadSeek's anchored file and structural-code tools in Pi:
|
|
|
33
35
|
pi install npm:pi-readseek
|
|
34
36
|
```
|
|
35
37
|
|
|
38
|
+
### OpenCode plugin
|
|
39
|
+
|
|
40
|
+
The [opencode-readseek plugin](packages/opencode-readseek/README.md) provides the
|
|
41
|
+
same anchored and structural tools in OpenCode.
|
|
42
|
+
|
|
36
43
|
## Common commands
|
|
37
44
|
|
|
38
45
|
```sh
|
|
@@ -86,25 +93,27 @@ time.
|
|
|
86
93
|
|
|
87
94
|
## Cache
|
|
88
95
|
|
|
89
|
-
`readseek init [path]` creates
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
`--readseek-dir`.
|
|
96
|
+
`readseek init [path]` creates and populates `.readseek/maps/` and
|
|
97
|
+
`.readseek/def-index/`. Map-dependent commands update entries on demand and
|
|
98
|
+
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.
|
|
93
101
|
|
|
94
102
|
## Documentation
|
|
95
103
|
|
|
96
|
-
The manual page
|
|
104
|
+
The manual page provides the full CLI reference:
|
|
97
105
|
|
|
98
106
|
```sh
|
|
99
|
-
man man/man1/readseek.1
|
|
107
|
+
man ./man/man1/readseek.1
|
|
100
108
|
```
|
|
101
109
|
|
|
102
110
|
Pass `--help` to any command for command-specific usage.
|
|
103
111
|
|
|
104
112
|
## Licensing
|
|
105
113
|
|
|
106
|
-
`readseek` is licensed under `LGPL-2.1-or-later`. The
|
|
107
|
-
|
|
114
|
+
The native `readseek` crate is licensed under `LGPL-2.1-or-later`. The
|
|
115
|
+
`@jarkkojs/readseek` wrapper and platform packages declare
|
|
116
|
+
`Apache-2.0 AND LGPL-2.1-or-later`.
|
|
108
117
|
|
|
109
118
|
The downloaded `Qwen/Qwen3-VL-2B-Instruct-GGUF` model is licensed under
|
|
110
119
|
`Apache-2.0`.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jarkkojs/readseek",
|
|
3
|
-
"version": "0.6.
|
|
3
|
+
"version": "0.6.12",
|
|
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.6.
|
|
25
|
-
"@jarkkojs/readseek-linux-arm64": "0.6.
|
|
26
|
-
"@jarkkojs/readseek-linux-x64": "0.6.
|
|
27
|
-
"@jarkkojs/readseek-win32-x64": "0.6.
|
|
24
|
+
"@jarkkojs/readseek-darwin-arm64": "0.6.12",
|
|
25
|
+
"@jarkkojs/readseek-linux-arm64": "0.6.12",
|
|
26
|
+
"@jarkkojs/readseek-linux-x64": "0.6.12",
|
|
27
|
+
"@jarkkojs/readseek-win32-x64": "0.6.12"
|
|
28
28
|
},
|
|
29
29
|
"publishConfig": {
|
|
30
30
|
"access": "public"
|