@ninjaxtools/slopdex 0.21.0 → 0.23.0

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 CHANGED
@@ -48,8 +48,7 @@ cargo install --path . --locked
48
48
 
49
49
  ## Getting started
50
50
 
51
- Semantic search requires an embedding-provider API key from OpenAI or Jina. `slopdex map` doesn't
52
- use vector search and works locally without a provider or API key.
51
+ Vector search requires an embedding-provider API key from OpenAI or Jina.
53
52
 
54
53
  ```console
55
54
  $ export OPENAI_API_KEY="your-api-key"
@@ -61,6 +60,8 @@ The index tracks the current git commit and is created or updated on every comma
61
60
 
62
61
  ### Code map/skeleton
63
62
 
63
+ `slopdex map` doesn't use vector search and works locally without a provider or API key.
64
+
64
65
  ```console
65
66
  $ slopdex map src docs
66
67
  $ slopdex map src -g '*.rs' -k fns -e 'refresh|search'
@@ -197,7 +198,7 @@ $ slopdex cross-search --cross-file-only --cohesion --threshold 0.8
197
198
  Just put this in your `AGENTS.md` file, no skill required:
198
199
 
199
200
  ```
200
- - use `treesitter-index -g <glob> <files or directories...>` early to obtain a compact structural skeleton before reading the full file, and then perform targeted reads for implementation details. Line numbers are indicated in square brackets (e.g [5] means line 5, and [5-10] means lines 5 to 10). To filter for specific symbols, use `-e`. To only include specific kinds of symbols use `-k` with `imports`, `fns`, `consts`, `types`, or `classes`. For example: `treesitter-index -g "*.ts" -i -e "manager|main" src`.
201
+ - use `slopdex map -g <glob> <files or directories...>` to obtain a compact structural code skeleton, and then perform targeted reads for implementation details. Line numbers are indicated in square brackets (e.g [5] means line 5, and [5-10] means lines 5 to 10). To filter for specific symbols, use `-e`. To only include specific kinds of symbols use `-k` with `imports`, `fns`, `consts`, `types`, or `classes`. For example: `slopdex map -g "*.ts" -i -e "manager|main" src`.
201
202
  - use semantic code search to find code with: `slopdex search "..." --threshold 0.5`
202
203
  - when reviewing uncommitted code avoid introducing duplicates by looking for related matches: `slopdex cross-search --uncommitted --threshold 0.8`
203
204
  - don't use `*` as the glob since that circumvents the default ignore rules.
@@ -19,7 +19,7 @@
19
19
  "hasInstallScript": true,
20
20
  "license": "MIT",
21
21
  "name": "@ninjaxtools/slopdex",
22
- "version": "0.21.0"
22
+ "version": "0.23.0"
23
23
  },
24
24
  "node_modules/detect-libc": {
25
25
  "engines": {
@@ -48,5 +48,5 @@
48
48
  }
49
49
  },
50
50
  "requires": true,
51
- "version": "0.21.0"
51
+ "version": "0.23.0"
52
52
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "artifactDownloadUrls": [
3
- "https://github.com/ninjaxtools/slopdex/releases/download/v0.21.0"
3
+ "https://github.com/ninjaxtools/slopdex/releases/download/v0.23.0"
4
4
  ],
5
5
  "bin": {
6
6
  "slopdex": "run-slopdex.js"
@@ -80,7 +80,7 @@
80
80
  "zipExt": ".tar.xz"
81
81
  }
82
82
  },
83
- "version": "0.21.0",
83
+ "version": "0.23.0",
84
84
  "volta": {
85
85
  "node": "18.14.1",
86
86
  "npm": "9.5.0"