@fingerskier/augment 0.1.0 → 0.1.3

package/README.md

@@ -1,130 +1,198 @@
-# augment
-
-Local RAG memory for coding agents.
-
-Augment stores durable memories as markdown files, maintains a local rebuildable index, and exposes the memory system through an MCP server.
-The MCP server connects to a shared local daemon, so multiple coding agents can use the same memory folder without each running its own watcher/indexer.
-
-Feature details live in [docs/FEATURES.md](docs/FEATURES.md).
-The implementation plan lives in [PLAN.md](PLAN.md).
-
-----
-
-## Install
-
-From this repo:
-
-```powershell
-npm install
-npm run build
-npm run check
-```
-
----
-
-## Configure Memory
-
-For quick local testing, set the memory root with an environment variable:
-
-```powershell
-$env:AUGMENT_MEMORY_ROOT = "C:\Users\you\Dropbox\augment-memories"
-```
-
-Or create `~/.augment/config.json`:
-
-```json
-{
-  "memoryRoot": "C:\\Users\\you\\Dropbox\\augment-memories",
-  "stateDir": "C:\\Users\\you\\.augment\\state"
-}
-```
-
-Defaults:
-
-- Memory root: `~/.augment/memories`
-- State directory: `~/.augment/state`
-
-## Run Locally
-
-Run diagnostics:
-
-```powershell
-node .\dist\bin\augment.js status
-```
-
-Start the daemon manually:
-
-```powershell
-node .\dist\bin\augment-daemon.js
-```
-
-Normally you do not need to start the daemon yourself. `augment-mcp` starts or
-connects to the shared daemon automatically.
-
-Run the MCP server manually:
-
-```powershell
-node .\dist\bin\augment-mcp.js
-```
-
-It will appear idle in a terminal because it speaks MCP over stdio.
-
-## Local MCP Config
-
-Use the compiled local MCP bin while dogfooding:
-
-```json
-{
-  "mcpServers": {
-    "augment": {
-      "command": "node",
-      "args": ["C:\\dev\\fingerskier\\agent\\augment\\dist\\bin\\augment-mcp.js"],
-      "env": {
-        "AUGMENT_MEMORY_ROOT": "C:\\Users\\you\\Dropbox\\augment-memories"
-      }
-    }
-  }
-}
-```
-
-Alternative using npm from another working directory:
-
-```json
-{
-  "mcpServers": {
-    "augment": {
-      "command": "npm",
-      "args": [
-        "exec",
-        "--prefix",
-        "C:\\dev\\fingerskier\\agent\\augment",
-        "--",
-        "augment-mcp"
-      ],
-      "env": {
-        "AUGMENT_MEMORY_ROOT": "C:\\Users\\you\\Dropbox\\augment-memories"
-      }
-    }
-  }
-}
-```
-
-Dogfooding instructions:
-
-- Codex: [integrations/codex/SKILL.md](integrations/codex/SKILL.md)
-- Claude: [integrations/claude/CLAUDE.md](integrations/claude/CLAUDE.md)
-
-## Package Check
-
-Before publishing:
-
-```powershell
-npm run check
-npm pack --dry-run
-```
-
-The package exposes these bins:
-
-- `augment`
-- `augment-daemon`
-- `augment-mcp`
+# augment
+
+Local RAG memory for coding agents.
+
+Augment stores durable memories as markdown files, maintains a local rebuildable index, and exposes the memory system through an MCP server.
+The MCP server connects to a shared local daemon, so multiple coding agents can use the same memory folder without each running its own watcher/indexer.
+
+Feature details live in [docs/FEATURES.md](docs/FEATURES.md).
+The implementation plan lives in [PLAN.md](PLAN.md).
+
+----
+
+## Install
+
+From this repo:
+
+```powershell
+npm install
+npm run build
+npm run check
+```
+
+---
+
+## Configure Memory
+
+For quick local testing, set the memory root with an environment variable:
+
+```powershell
+$env:AUGMENT_MEMORY_ROOT = "C:\Users\you\Dropbox\augment-memories"
+```
+
+Or create `~/.augment/config.json`:
+
+```json
+{
+  "memoryRoot": "C:\\Users\\you\\Dropbox\\augment-memories",
+  "stateDir": "C:\\Users\\you\\.augment\\state"
+}
+```
+
+Defaults:
+
+- Memory root: `~/.augment/memories`
+- State directory: `~/.augment/state`
+
+## Run Locally
+
+Run diagnostics:
+
+```powershell
+node .\dist\bin\augment.js status
+```
+
+Start the daemon manually:
+
+```powershell
+node .\dist\bin\augment-daemon.js
+```
+
+Normally you do not need to start the daemon yourself. `augment-mcp` starts or
+connects to the shared daemon automatically.
+
+Run the MCP server manually:
+
+```powershell
+node .\dist\bin\augment-mcp.js
+```
+
+It will appear idle in a terminal because it speaks MCP over stdio.
+
+Do not use `npx @fingerskier/augment` from inside this repository. npm resolves
+the current package first, but a package's own bins are not linked into its local
+`node_modules/.bin`, so Windows reports `augment` as not recognized. Use the
+compiled `node .\dist\bin\...` commands above while working in this repo.
+
+From another directory, the published package works:
+
+```powershell
+npx @fingerskier/augment
+npm exec --yes --package @fingerskier/augment -- augment status
+```
+
+## Local MCP Config
+
+Use the compiled local MCP bin while dogfooding:
+
+```json
+{
+  "mcpServers": {
+    "augment": {
+      "command": "node",
+      "args": ["C:\\dev\\fingerskier\\agent\\augment\\dist\\bin\\augment-mcp.js"],
+      "env": {
+        "AUGMENT_MEMORY_ROOT": "C:\\Users\\you\\Dropbox\\augment-memories"
+      }
+    }
+  }
+}
+```
+
+Alternative using npm from another working directory:
+
+```json
+{
+  "mcpServers": {
+    "augment": {
+      "command": "npm",
+      "args": [
+        "exec",
+        "--prefix",
+        "C:\\dev\\fingerskier\\agent\\augment",
+        "--",
+        "augment-mcp"
+      ],
+      "env": {
+        "AUGMENT_MEMORY_ROOT": "C:\\Users\\you\\Dropbox\\augment-memories"
+      }
+    }
+  }
+}
+```
+
+Dogfooding instructions:
+
+- Codex: [integrations/codex/SKILL.md](integrations/codex/SKILL.md)
+- Claude: [integrations/claude/CLAUDE.md](integrations/claude/CLAUDE.md)
+
+## Install Agent Integrations
+
+Install the Codex plugin and marketplace entry:
+
+```powershell
+npm exec --yes --package @fingerskier/augment -- augment install codex --scope user --memory-root "C:\Users\you\Dropbox\augment-memories"
+```
+
+Install the Claude plugin:
+
+```powershell
+npm exec --yes --package @fingerskier/augment -- augment install claude --scope repo --memory-root "C:\Users\you\Dropbox\augment-memories"
+```
+
+`install claude` does four things:
+
+- Scaffolds a real Claude Code plugin at `<root>/plugins/augment/`
+  (`.claude-plugin/plugin.json`, an auto-discovered `augment-context` skill, and a
+  bundled `.mcp.json`).
+- Adds a marketplace entry at `<root>/.claude-plugin/marketplace.json`.
+- **Registers the MCP server directly** so it is active without the marketplace
+  step: repo scope writes `<repo>/.mcp.json`; user scope merges into
+  `~/.claude.json` (`mcpServers.augment`), preserving every other key.
+- Upserts the always-on memory-workflow guidance into `CLAUDE.md`.
+
+`<root>` is the repo (`--scope repo`) or your home directory (`--scope user`).
+The direct registration is enough on its own — restart Claude Code and the
+`augment` tools appear. To use the packaged plugin instead, install it from the
+marketplace (the installer prints the exact commands), e.g.:
+
+```text
+/plugin marketplace add .
+/plugin install augment@fingerskier-local
+```
+
+Pick one activation path; both register a server named `augment`, and Claude's
+scope precedence resolves the duplicate to the higher-precedence one.
+
+Install both:
+
+```powershell
+npm exec --yes --package @fingerskier/augment -- augment install all --scope user --memory-root "C:\Users\you\Dropbox\augment-memories"
+```
+
+Preview writes before changing files:
+
+```powershell
+npm exec --yes --package @fingerskier/augment -- augment install codex --scope user --dry-run
+```
+
+The installer configures MCP commands with an isolated npm `--prefix` directory
+under `~/.augment/npm-exec` so they work even when launched from this repository.
+
+Run these package commands from outside this repository. When developing inside
+this repo, use `node .\dist\bin\augment.js install ...` after `npm run build`.
+
+## Package Check
+
+Before publishing:
+
+```powershell
+npm run check
+npm pack --dry-run
+```
+
+The package exposes these bins:
+
+- `augment`
+- `augment-daemon`
+- `augment-mcp`

package/dist/cli.js

@@ -1,4 +1,5 @@
 import { loadConfig } from "./config.js";
+import { installIntegration } from "./install.js";
 export async function runCli(args) {
     const command = args[0] ?? "status";
     if (command === "config" || command === "status") {
@@ -6,8 +7,56 @@ export async function runCli(args) {
         console.log(JSON.stringify(config, null, 2));
         return;
     }
+    if (command === "install") {
+        const parsed = parseInstallArgs(args.slice(1));
+        const plan = await installIntegration(parsed);
+        for (const line of plan.summary) {
+            console.log(line);
+        }
+        for (const file of plan.files) {
+            console.log(`- ${file}`);
+        }
+        return;
+    }
     console.error(`Unknown command: ${command}`);
-    console.error("Usage: augment [status|config]");
+    console.error("Usage: augment [status|config|install <codex|claude|all>]");
     process.exitCode = 1;
 }
+function parseInstallArgs(args) {
+    const target = args[0];
+    if (!target || !["codex", "claude", "all"].includes(target)) {
+        throw new Error("Usage: augment install <codex|claude|all> [--scope user|repo] [--memory-root PATH] [--dry-run]");
+    }
+    let scope = "user";
+    let memoryRoot;
+    let dryRun = false;
+    for (let index = 1; index < args.length; index += 1) {
+        const arg = args[index];
+        if (arg === "--scope") {
+            const value = args[++index];
+            if (value !== "user" && value !== "repo") {
+                throw new Error("--scope must be user or repo");
+            }
+            scope = value;
+        }
+        else if (arg === "--memory-root") {
+            memoryRoot = args[++index];
+            if (!memoryRoot) {
+                throw new Error("--memory-root requires a path");
+            }
+        }
+        else if (arg === "--dry-run") {
+            dryRun = true;
+        }
+        else {
+            throw new Error(`Unknown install option: ${arg}`);
+        }
+    }
+    return {
+        target,
+        scope,
+        memoryRoot,
+        dryRun,
+    };
+}
 //# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,IAAc;IACzC,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC;IAEpC,IAAI,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;QACjD,MAAM,MAAM,GAAG,MAAM,UAAU,EAAE,CAAC;QAClC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAC7C,OAAO;IACT,CAAC;IAED,OAAO,CAAC,KAAK,CAAC,oBAAoB,OAAO,EAAE,CAAC,CAAC;IAC7C,OAAO,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAChD,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAyC,MAAM,cAAc,CAAC;AAEzF,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,IAAc;IACzC,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC;IAEpC,IAAI,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;QACjD,MAAM,MAAM,GAAG,MAAM,UAAU,EAAE,CAAC;QAClC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAC7C,OAAO;IACT,CAAC;IAED,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,IAAI,GAAG,MAAM,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC9C,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAChC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;QAC3B,CAAC;QACD,OAAO;IACT,CAAC;IAED,OAAO,CAAC,KAAK,CAAC,oBAAoB,OAAO,EAAE,CAAC,CAAC;IAC7C,OAAO,CAAC,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAC3E,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAc;IAMtC,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAA8B,CAAC;IACpD,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5D,MAAM,IAAI,KAAK,CAAC,gGAAgG,CAAC,CAAC;IACpH,CAAC;IAED,IAAI,KAAK,GAAiB,MAAM,CAAC;IACjC,IAAI,UAA8B,CAAC;IACnC,IAAI,MAAM,GAAG,KAAK,CAAC;IAEnB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACpD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,MAAM,KAAK,GAAG,IAAI,CAAC,EAAE,KAAK,CAA6B,CAAC;YACxD,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;YAClD,CAAC;YACD,KAAK,GAAG,KAAK,CAAC;QAChB,CAAC;aAAM,IAAI,GAAG,KAAK,eAAe,EAAE,CAAC;YACnC,UAAU,GAAG,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;aAAM,IAAI,GAAG,KAAK,WAAW,EAAE,CAAC;YAC/B,MAAM,GAAG,IAAI,CAAC;QAChB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,GAAG,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAED,OAAO;QACL,MAAM;QACN,KAAK;QACL,UAAU;QACV,MAAM;KACP,CAAC;AACJ,CAAC"}

package/dist/install.d.ts

@@ -0,0 +1,15 @@
+export type InstallTarget = "codex" | "claude" | "all";
+export type InstallScope = "user" | "repo";
+export interface InstallOptions {
+    target: InstallTarget;
+    scope: InstallScope;
+    memoryRoot?: string;
+    dryRun?: boolean;
+    cwd?: string;
+    home?: string;
+}
+export interface InstallPlan {
+    summary: string[];
+    files: string[];
+}
+export declare function installIntegration(options: InstallOptions): Promise<InstallPlan>;