@mathew-cf/opencode-memory 0.2.0 → 0.2.1

package/README.md

@@ -23,10 +23,18 @@ LLM agents forget everything between sessions. That means rediscovering the same
 ```jsonc
 // opencode.jsonc
 {
-  "plugin": ["@mathew-cf/opencode-memory@0.2.0"]
+  "plugin": ["@mathew-cf/opencode-memory@0.2.1"]
 }
 ```
 
+Then bootstrap the memory directory + embedding model:
+
+```bash
+bunx @mathew-cf/opencode-memory init
+```
+
+This creates `~/opencode-memory/` (git repo, 7 category subdirs) and downloads the ~90MB embedding model. Idempotent — safe to re-run. Pass `--skip-model` to defer the download.
+
 The plugin auto-registers:
 
 - its bundled skill under `config.skills.paths`
@@ -56,12 +64,19 @@ If either dependency fails to install (unusual — usually indicates an unsuppor
 
 ### First-time setup
 
+```bash
+bunx @mathew-cf/opencode-memory init
 ```
-mkdir -p ~/opencode-memory
-cd ~/opencode-memory && git init
-```
 
-Categories are conventional directories under the root — `preferences/`, `repos/`, `technical/`, `people/`, `workflows/`, `snippets/`, `notes/`. They're advisory, not enforced.
+Creates `~/opencode-memory/` (or `$MEMORY_DIR`), runs `git init`, scaffolds the 7 advisory category subdirs (`preferences/`, `repos/`, `technical/`, `people/`, `workflows/`, `snippets/`, `notes/`), and pre-caches the embedding model for semantic search.
+
+Subcommands:
+
+| Command                                         | Purpose                                                |
+| ----------------------------------------------- | ------------------------------------------------------ |
+| `bunx @mathew-cf/opencode-memory init`          | Create + git-init memory dir, download embedding model |
+| `bunx @mathew-cf/opencode-memory init --skip-model` | Same, but skip the ~90MB download                  |
+| `bunx @mathew-cf/opencode-memory status`        | Report which search backends are resolvable           |
 
 ### Writing memory
 

package/dist/cli.d.ts

@@ -0,0 +1,78 @@
+#!/usr/bin/env bun
+/**
+ * opencode-memory CLI entry point.
+ *
+ * Runs under Bun (matching the runtime opencode itself uses). Required
+ * because the shared lib/* helpers use `Bun.$` for shell calls and
+ * `Bun.spawn`/`Bun.file` for filesystem work; rather than maintaining
+ * two implementations we standardize on bun. `bunx` always uses the
+ * bun runtime regardless of shebang, so the canonical
+ *   `bunx @mathew-cf/opencode-memory init`
+ * just works. Direct invocations (`opencode-memory init` after
+ * `npm install -g`) require bun to be on PATH.
+ *
+ * Distributed via the `bin` field in package.json so users can run
+ *   `bunx @mathew-cf/opencode-memory init`
+ * from a fresh machine to fully bootstrap the memory system: mkdir,
+ * git init, create category subdirs, pre-cache the embedding model,
+ * and report status.
+ *
+ * Subcommands (lazy-resolved so tests can call them with plain args
+ * without spawning a subprocess):
+ *
+ *   init [--skip-model] [--quiet]
+ *     Initialize the memory directory and download the embedding model.
+ *     Idempotent — safe to run multiple times.
+ *
+ *   status
+ *     Report which search backends (ripgrep, rag-cli) are resolvable.
+ *     Same output as the `memory_setup` tool.
+ *
+ *   help
+ *     Print usage.
+ *
+ * The CLI is intentionally tiny: the heavy lifting (rag download, ripgrep
+ * resolution) lives in src/lib/ and is shared with the plugin tools so
+ * a single bug fix benefits both surfaces.
+ */
+interface InitOptions {
+    /** Skip the rag download step. Useful in CI or for offline first-runs. */
+    skipModel?: boolean;
+    /** Suppress success lines (errors still print). For embedding in scripts. */
+    quiet?: boolean;
+}
+/**
+ * Result of `init`. Returned (rather than just printed) so tests can
+ * assert exactly what happened on disk.
+ */
+export interface InitResult {
+    memoryDir: string;
+    /** True if `git init` actually ran (vs. the dir already being a repo). */
+    gitInitialized: boolean;
+    /** Categories that were created in this run. Skipped categories aren't listed. */
+    createdCategories: string[];
+    /** True if the rag download step ran. */
+    modelDownloadAttempted: boolean;
+    /** Whatever rag download printed, if it ran. */
+    modelDownloadOutput?: string;
+}
+/**
+ * Pure-ish init: takes an explicit memoryDir so tests can target a temp
+ * path. The CLI wrapper passes `resolveMemoryDir()`.
+ */
+export declare function initMemory(memoryDir: string, options?: InitOptions, log?: (msg: string) => void): Promise<InitResult>;
+/**
+ * Print usage to stdout. Exported so tests can compare against it.
+ */
+export declare function usage(): string;
+/**
+ * Parse argv tail into a simple options bag. Exported for tests.
+ * Recognised flags:
+ *   --skip-model | -s    InitOptions.skipModel = true
+ *   --quiet | -q         InitOptions.quiet = true
+ */
+export declare function parseInitFlags(argv: string[]): InitOptions;
+/** CLI dispatcher. Exported so tests can drive it without exec(). */
+export declare function dispatch(argv: string[]): Promise<number>;
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAUH,UAAU,WAAW;IACnB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,6EAA6E;IAC7E,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,0EAA0E;IAC1E,cAAc,EAAE,OAAO,CAAC;IACxB,kFAAkF;IAClF,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,yCAAyC;IACzC,sBAAsB,EAAE,OAAO,CAAC;IAChC,gDAAgD;IAChD,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAC9B,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,WAAgB,EACzB,GAAG,GAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAgD,GACrE,OAAO,CAAC,UAAU,CAAC,CAuDrB;AAED;;GAEG;AACH,wBAAgB,KAAK,IAAI,MAAM,CAiB9B;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,WAAW,CAO1D;AAED,qEAAqE;AACrE,wBAAsB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAiC9D"}