@justestif/pk 0.3.2 → 0.4.0

package/package.json

@@ -1,7 +1,7 @@
 {
    "name": "@justestif/pk",
    "type": "module",
-   "version": "0.3.2",
+   "version": "0.4.0",
    "description": "Project knowledge — structured intake, search, and recall",
    "bin": {
       "pk": "dist/index.js"
@@ -15,21 +15,41 @@
       "build": "bun build src/index.ts --outfile dist/index.js --target bun && printf '#!/usr/bin/env bun\n' | cat - dist/index.js > dist/tmp.js && mv dist/tmp.js dist/index.js && chmod +x dist/index.js",
       "check": "bun run typecheck && bun run lint && bun test",
       "typecheck": "bunx tsc --noEmit",
-      "lint": "xo",
+      "lint": "xo src",
       "test": "bun test",
       "prepublishOnly": "bun run build"
    },
    "dependencies": {
       "@clack/prompts": "^1.3.0",
+      "ai": "^6.0.177",
       "commander": "^14.0.0",
       "gray-matter": "^4.0.3",
       "markdownlint": "^0.40.0",
+      "ollama-ai-provider-v2": "^3.5.0",
       "zod": "^4"
    },
    "repository": {
       "type": "git",
       "url": "git+https://github.com/justEstif/pk.git"
    },
+   "xo": {
+      "ignores": [
+         "site/**",
+         "docs/**"
+      ],
+      "rules": {
+         "@stylistic/curly-newline": "off",
+         "@typescript-eslint/naming-convention": "off",
+         "@typescript-eslint/no-restricted-types": "off",
+         "@typescript-eslint/no-unsafe-type-assertion": "off",
+         "n/prefer-global/process": "off",
+         "unicorn/no-array-callback-reference": "off",
+         "unicorn/no-array-reduce": "off",
+         "unicorn/no-null": "off",
+         "unicorn/no-process-exit": "off",
+         "unicorn/prevent-abbreviations": "off"
+      }
+   },
    "devDependencies": {
       "@types/bun": "latest",
       "fallow": "^2.67.0",

package/skill/SKILL.md

@@ -7,7 +7,7 @@ description: "Load when maintaining project knowledge, capturing decisions or qu
 
 Structured project knowledge — intake, search, recall, and audit.
 
-Use the `pk` CLI for all knowledge operations. Every command supports `--json` for machine-readable output. Never read or write knowledge files directly — always go through `pk`.
+Use the `pk` CLI for all knowledge operations. Every command outputs JSON by default. Use `--pretty` for human-readable output. Never read or write knowledge files directly — always go through `pk`.
 
 ## Commands
 
@@ -27,10 +27,13 @@ Returns formatted markdown with title, type, status, tags, and an excerpt per no
 pk search "database schema"
 pk search "api" --type question --status open
 pk search "deploy" --tag infra --limit 5
+pk search "slow queries" --semantic   # vector similarity (requires embeddings)
 ```
 
 Returns path, type, status, title, tags, and snippet per match. Always search before creating — duplicates erode trust faster than gaps do.
 
+Use `--semantic` when keyword search misses the intent — e.g. searching "latency issues" should find a note titled "slow database queries". Requires Ollama configured via `pk config --embedding <model>`.
+
 ### `pk read` — full note body
 
 ```bash
@@ -51,6 +54,7 @@ pk new source "Meeting notes 2024-06-01"
 Prints the absolute path. Frontmatter (id, dates, status, tags) is generated automatically — don't edit frontmatter after creation. After receiving the path: `pk read` to see the skeleton, then edit the file to fill in the required sections.
 
 **Required sections by type:**
+
 - `note` → `## Summary`, `## Details`, `## Evidence`, `## Related`
 - `decision` → `## Decision`, `## Context`, `## Rationale`, `## Consequences`, `## Related`
 - `question` → `## Question`, `## Why It Matters`, `## Current Understanding`, `## Resolution`
@@ -80,10 +84,10 @@ pk history --filter-operation update           # only updates
 ### `pk delete` — delete a note
 
 ```bash
-pk delete /abs/path/to/note.md --yes
+pk delete /abs/path/to/note.md
 ```
 
-Deletes and commits. `--yes` skips confirmation (required in non-interactive mode).
+Deletes and commits. The command is non-interactive and outputs JSON by default.
 
 ### `pk vocab` — list tags by frequency
 
@@ -91,15 +95,26 @@ Deletes and commits. `--yes` skips confirmation (required in non-interactive mod
 pk vocab
 ```
 
-Useful for orienting before searching.
+Useful for orienting before searching. Requires the search index.
+
+### `pk index` — rebuild search indexes
+
+```bash
+pk index
+```
+
+Run after creating or editing notes. Rebuilds `~/.pk/<name>/.index.db` and `~/.pk/<name>/indexes/`. If embeddings are configured (`pk config --embedding <model>`), also generates vectors for semantic search.
 
-### `pk edit` — edit a note in $EDITOR
+### `pk config` — show or update configuration
 
 ```bash
-pk edit /abs/path/to/note.md
+pk config                                    # show current config
+pk config --embedding nomic-embed-text       # enable Ollama embeddings
+pk config --no-embedding                     # disable embeddings
+pk config --base-url http://my-ollama:11434  # custom Ollama endpoint
 ```
 
-Opens the note in `$EDITOR`, validates after save, commits changes. For agents: use `pk read` + file edit + `pk lint` instead.
+Config lives at `~/.pk/config.json`.
 
 ### Status transitions