opencode-readseek 0.10.7 → 0.11.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.
- package/README.md +50 -5
- package/dist/index.js +1623 -1437
- package/dist/v2.js +23 -0
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -42,9 +42,51 @@ macOS/Windows supplied by `@jarkkojs/readseek`. Set
|
|
|
42
42
|
|
|
43
43
|
## Tools
|
|
44
44
|
|
|
45
|
-
|
|
46
|
-
`
|
|
47
|
-
`
|
|
45
|
+
- Read without inference: `readseek_show_content`, `readseek_show_structure`,
|
|
46
|
+
`readseek_show_metadata`, `readseek_show_assets`.
|
|
47
|
+
- Check: `readseek_check_syntax`, `readseek_check_rules`.
|
|
48
|
+
- Explicit inference: `readseek_generate_caption`, `readseek_detect_objects`,
|
|
49
|
+
`readseek_recognize_text`.
|
|
50
|
+
- Find: `readseek_find_text`, `readseek_find_nodes`, `readseek_find_definitions`,
|
|
51
|
+
`readseek_find_references`.
|
|
52
|
+
- Mutate: `readseek_edit_text`, `readseek_rename_symbol`, `readseek_write_file`.
|
|
53
|
+
|
|
54
|
+
Tool names mirror native verb-object commands, such as `show content`,
|
|
55
|
+
`find nodes`, and `edit text`. Paths resolve against the project directory.
|
|
56
|
+
Use `at` selectors (`line:N[:COLUMN]`, `hash:H[:COLUMN]`, `symbol:NAME`,
|
|
57
|
+
`page:N`, `node:ID`, or `asset:ID`) where supported. Structure defaults to
|
|
58
|
+
`depth: 1`. Use separate structure, metadata, and syntax tools rather than
|
|
59
|
+
combining facets in a content request.
|
|
60
|
+
|
|
61
|
+
The four `show` tools return readable summaries and grouped text: anchored source
|
|
62
|
+
lines, document sections, structure trees, metadata fields, and asset paths.
|
|
63
|
+
Notices identify omitted ranges and how to continue. The unchanged native result
|
|
64
|
+
is retained separately in `metadata.readseek`; image attachments are unchanged.
|
|
65
|
+
|
|
66
|
+
`readseek_find_nodes` accepts `pattern`, `context` with `selector`, or `rule`.
|
|
67
|
+
`readseek_find_references` requires exactly one of `name` or `at`; binding
|
|
68
|
+
references and renames use line or hash cursors. KDL selection/check rules
|
|
69
|
+
may be inline or `@path`; tool calls cannot supply standard input.
|
|
70
|
+
|
|
71
|
+
`readseek_find_text` accepts exactly one of literal `text` or regex `pattern`.
|
|
72
|
+
The adapter also supports `literal`, `ignoreCase`, `glob`, `context`, `limit`,
|
|
73
|
+
and per-file `summary`. Native `find text --text` searches literally.
|
|
74
|
+
|
|
75
|
+
Read fresh `LINE:HASH` anchors before editing. Each edit item contains exactly
|
|
76
|
+
one nested `set_line`, `replace_lines`, `insert_after`, `replace_symbol`, or
|
|
77
|
+
`replace` object. Edits and renames default to applying after a verified plan
|
|
78
|
+
and edit permission; use `apply: false` to preview and `planHash` to require
|
|
79
|
+
that plan when applying. `write_file` replaces complete text files.
|
|
80
|
+
|
|
81
|
+
Syntax and rule checks treat exit 1 as findings, not transport failure;
|
|
82
|
+
exit 0 is clean and exit 2 is failure. Syntax checks do not typecheck.
|
|
83
|
+
|
|
84
|
+
Assets auto-materialize into the cache. Content and asset tools return usable
|
|
85
|
+
cached paths and attach images according to `imageMode`; there is no extract
|
|
86
|
+
command or asset output-path parameter. Inference is only requested through
|
|
87
|
+
the explicit inference tools (`level: low|medium|high`, default `low`). Caption
|
|
88
|
+
`include` may request `text` and/or `objects`. Models must already be installed;
|
|
89
|
+
reading never silently invokes OCR or downloads a model.
|
|
48
90
|
|
|
49
91
|
To control image handling:
|
|
50
92
|
|
|
@@ -59,12 +101,15 @@ To control image handling:
|
|
|
59
101
|
## Development
|
|
60
102
|
|
|
61
103
|
```sh
|
|
62
|
-
bun install
|
|
63
104
|
bun test
|
|
64
|
-
|
|
105
|
+
npm run build
|
|
106
|
+
npm run typecheck
|
|
65
107
|
```
|
|
66
108
|
|
|
67
109
|
|
|
110
|
+
For real-binary checks, set `READSEEK_BINARY` to the built native executable,
|
|
111
|
+
for example `/absolute/path/to/packages/readseek/build/readseek`.
|
|
112
|
+
|
|
68
113
|
## Licensing
|
|
69
114
|
|
|
70
115
|
`opencode-readseek` is licensed under the Apache 2.0 license. See [LICENSE](LICENSE)
|