@jarkkojs/readseek 0.4.34 → 0.5.0

package/README.md

@@ -4,28 +4,28 @@
 It emits pretty-printed JSON with stable `LINE:HASH` anchors, structural symbol
 maps, parse diagnostics, AST search matches, references, and rename plans.
 
-Current documented CLI API: **0.4.x**.
-
 ## Install
 
+Build the native binary from source:
+
 ```sh
-npm install -g @jarkkojs/readseek
+cargo build --release
 ```
 
-Or build the native binary from source:
+Or install the npm wrapper:
 
 ```sh
-cargo build --release
+npm install -g @jarkkojs/readseek
 ```
 
 ## Common commands
 
 ```sh
 readseek detect src/main.rs
-readseek read src/main.rs --start 10 --end 20
+readseek read src/main.rs:10 --end 20
 readseek map src/main.rs
 readseek check src/main.rs
-readseek symbol src/main.rs --name run
+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
@@ -33,32 +33,35 @@ readseek search src 'fn $NAME() { $$$BODY }' --language rust
 readseek rename src/main.rs --line 42 --column 8 --to renamed
 ```
 
-Use `--stdin <path>` with `detect`, `read`, `map`, `check`, `symbol`, and
-`identify` to analyze unsaved editor buffers while still providing a path for
-language detection:
+To write JSON output to a file instead of stdout, place the global option before
+the command:
 
 ```sh
-printf '%s\n' 'fn main() {}' | readseek identify --stdin scratch.rs --line 1 --column 4
+readseek --output result.json detect src/main.rs
 ```
 
-Use `def --from-identify` to pipe `identify` JSON into definition lookup:
+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
-readseek identify src/main.rs:42 --column 8 | readseek def --from-identify src --format plain
+printf '%s\n' 'fn main() {}' | readseek identify stdin:scratch.rs:1 --column 4
 ```
 
 ## Images
 
-`detect` reports format, dimensions, and animation status for images. Add a vision
-flag to analyze image contents with the BLIP, YOLOv8-nano, and TrOCR models:
+`detect` reports format, dimensions, and animation status for images. `read`
+runs vision analysis on images, defaulting to a caption; pass `--image` to choose
+the task (BLIP, YOLOv8-nano, TrOCR):
 
 ```sh
-readseek detect photo.jpg --caption        # detailed natural-language caption
-readseek detect photo.jpg --objects        # object labels + bounding boxes
-readseek detect photo.jpg --ocr            # extracted text
+readseek read photo.jpg                  # default: caption
+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
 ```
 
-The flags can be combined; each model loads once per invocation. The model files
+Each invocation selects one mode; the requested model loads once. The model files
 (~258 MB BLIP GGUF + ~6 MB YOLOv8-nano + ~1.24 GB TrOCR) are downloaded lazily
 into the user cache directory on first vision use and reused on subsequent runs;
 a progress bar is shown while downloading when stdout is an interactive TTY.
@@ -84,14 +87,5 @@ Pass `--help` to any command for command-specific usage.
 
 ## Licensing
 
-The JavaScript npm wrapper is licensed under `Apache-2.0`. The Rust source and
-native binaries are licensed under `LGPL-2.1-or-later`. Corresponding source for
-each published native binary is available from the GitHub repository tag that
-matches the package version.
-
-readseek downloads the BLIP caption model (a quantized GGUF from
-`lmz/candle-blip`, with the tokenizer from `Salesforce/blip-image-captioning-large`),
-the YOLOv8-nano object-detection model (`lmz/candle-yolo-v8`), and the TrOCR
-printed-text model (`microsoft/trocr-base-printed`) into the `models/` subdirectory
-of the user cache on first use. BLIP is licensed under `BSD-3-Clause`; YOLOv8-nano
-is derived from Ultralytics YOLOv8 (`AGPL-3.0`); TrOCR is released by Microsoft.
+`readseek` is licensed under `LGPL-2.1-or-later`. The JavaScript npm wrapper
+is licensed under `Apache-2.0`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jarkkojs/readseek",
-  "version": "0.4.34",
+  "version": "0.5.0",
   "description": "A structural read command",
   "license": "Apache-2.0 AND LGPL-2.1-or-later",
   "homepage": "https://github.com/jarkkojs/readseek#readme",
@@ -21,9 +21,9 @@
     "LICENSE-LGPL-2.1"
   ],
   "optionalDependencies": {
-    "@jarkkojs/readseek-darwin-arm64": "0.4.34",
-    "@jarkkojs/readseek-linux-x64": "0.4.34",
-    "@jarkkojs/readseek-win32-x64": "0.4.34"
+    "@jarkkojs/readseek-darwin-arm64": "0.5.0",
+    "@jarkkojs/readseek-linux-x64": "0.5.0",
+    "@jarkkojs/readseek-win32-x64": "0.5.0"
   },
   "publishConfig": {
     "access": "public"