aidimag 1.0.4 → 1.0.6

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.
Files changed (2) hide show
  1. package/README.md +105 -59
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,17 +1,38 @@
1
- # aiDimag
1
+ <div align="center">
2
2
 
3
- > Persistent, verified memory for AI coding agents. CLI: **`dim`**.
3
+ <img src="assets/logo.svg" alt="AI Dimag Logo" width="120" height="120">
4
4
 
5
- aiDimag gives any MCP-compatible agent (Claude Code, Cursor, Copilot, …) a memory of your
6
- codebase that survives across sessions — decisions, conventions, gotchas, failed approaches,
7
- **guardrails**, and reusable **skills** — stored as **falsifiable claims with grounding
8
- evidence** in `.aidimag/` next to your code. It also generates the static context files
9
- (`CLAUDE.md`, `.cursorrules`, …) that *non-MCP* tools read, so every AI tool benefits.
5
+ # AI Dimag — Verified Memory for AI Coding Agents
10
6
 
11
- What makes it different: **memories are verified, not just stored.** Every memory carries
12
- evidence (a shell check, an anchored commit, a test) that `dim verify` re-runs against the
13
- current repo — beliefs that stop being true go **STALE** instead of silently misleading
14
- your AI.
7
+ **Your codebase remembers its decisions, conventions, and rules — and proves they're still true.**
8
+
9
+ [![npm version](https://img.shields.io/npm/v/aidimag?color=blue&logo=npm)](https://www.npmjs.com/package/aidimag)
10
+ [![License](https://img.shields.io/badge/license-Elastic_2.0-blue.svg)](./LICENSE)
11
+ [![Documentation](https://img.shields.io/badge/docs-aidimag.com-blue)](https://aidimag.com)
12
+ [![Node](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org)
13
+
14
+ [**Documentation**](https://aidimag.com) • [**Getting Started**](https://aidimag.com/getting-started) • [**AI Dimag Cloud**](https://cloud.aidimag.com) • [**Pricing**](https://aidimag.com/pricing)
15
+
16
+ </div>
17
+
18
+ ---
19
+
20
+ ## What is AI Dimag?
21
+
22
+ **AI Dimag** gives any MCP-compatible agent (Claude, Cursor, Copilot, Windsurf…) a **persistent memory** of your codebase that survives across sessions — decisions, conventions, gotchas, failed approaches, **guardrails**, and reusable **skills** — stored as **falsifiable claims with grounding evidence** in `.aidimag/` next to your code.
23
+
24
+ ### 🎯 The Difference: Verified, Not Just Stored
25
+
26
+ Every memory carries **evidence** (a shell check, an anchored commit, a test) that `dim verify` re-runs against the current repo. Beliefs that stop being true go **STALE** instead of silently misleading your AI.
27
+
28
+ ### ✨ Works with Every AI Tool
29
+
30
+ - **MCP tools** (Claude, Cursor, etc.) get real-time memory via the MCP server
31
+ - **Non-MCP tools** (Copilot, Windsurf, etc.) get static context files (`.cursorrules`, `CLAUDE.md`, `AGENTS.md`, etc.)
32
+
33
+ <div align="center">
34
+ <img src="assets/hero-illustration.svg" alt="AI Dimag Flow" width="600">
35
+ </div>
15
36
 
16
37
  ## Install
17
38
 
@@ -21,7 +42,7 @@ npm install -g aidimag
21
42
 
22
43
  Requires Node 18+. Ships two equivalent binaries: `dim` (short) and `aidimag`.
23
44
 
24
- ## Quick start
45
+ ## 🚀 Quick Start
25
46
 
26
47
  ```sh
27
48
  cd your-repo
@@ -36,10 +57,10 @@ dim verify # re-run all evidence; stale beliefs get flagged
36
57
  dim brief # session-start briefing: in-scope memory, guardrails, gaps
37
58
 
38
59
  # For non-MCP tools (Copilot, Cursor without MCP, etc.):
39
- dim generate-context --format all --auto # creates .cursorrules, CLAUDE.md, copilot-instructions.md
60
+ dim generate-context --format all --auto # creates .cursorrules, CLAUDE.md, AGENTS.md, etc.
40
61
  ```
41
62
 
42
- ## Hook it up to your AI agent (MCP)
63
+ ## 🔌 Connect to Your AI Agent (MCP)
43
64
 
44
65
  Add to your agent config (e.g. `.mcp.json` for Claude Code):
45
66
 
@@ -55,59 +76,84 @@ Add to your agent config (e.g. `.mcp.json` for Claude Code):
55
76
  }
56
77
  ```
57
78
 
58
- Agents get `memory_search`, `memory_propose`, `context_note` (live in-chat fact capture),
59
- `memory_critique` (a second critic grounded in verified memory), session-start briefings,
60
- session-end extraction, and more. For non-MCP tools, `dim generate-context -f all` renders
61
- verified memory into `CLAUDE.md` / `.cursorrules` / `.github/copilot-instructions.md`
62
- (`--auto` keeps them refreshed).
63
-
64
- ## Highlights
65
-
66
- - **Human-gated capture** — commits, PRs, AI-chat transcripts, and pasted docs are mined
67
- into *proposals*; nothing enters memory until you approve it in `dim review`
68
- (auto-triaged best-first, `approve all --min-score 0.7` for batches).
69
- - **Verification lifecycle** — `STATIC_CHECK` / `COMMIT_REF` / `TEST_RESULT` /
70
- `EXEC_TRACE` / `HUMAN_ATTESTED` evidence; failing evidence flips memories to STALE and
71
- auto-drafts a recovery proposal. Confidence decays without re-confirmation.
72
- - **Evidence trust gate** — shell-command evidence that arrives via team sync is **never
73
- executed** until you inspect and approve it (`dim verify --trust`).
74
- - **Hybrid semantic recall** — FTS5 keyword + vector KNN (OpenAI or local Ollama,
75
- auto-detected; works keyword-only with neither).
76
- - **Guardrails & skills** — behavioral rules (`never` / `ask-first` / `always`) and
77
- step-by-step procedures, enforced by `dim check` (pre-commit) and `memory_critique`.
78
- - **Team mode, self-hosted** — `dim serve` + `dim sync`: local-first replicas, device-code
79
- login, brain-scoped API keys, hashed credentials, cross-machine verification consensus.
80
- - **Knowledgebase inbox** — drop design docs / ADRs / PDFs / DOCX into `knowledge/` and
81
- they're summarized into reviewed, pinned memories.
82
- - **Web dashboard** (`dim ui`) plus [VS Code](https://github.com/anup-khanal/aidimag/tree/main/vscode-extension) and
83
- [IntelliJ](https://github.com/anup-khanal/aidimag/tree/main/intellij-plugin) extensions.
84
-
85
- ## Documentation
86
-
87
- Full documentation available at: **[aidimag.com](https://aidimag.com)**
88
-
89
- - [Getting Started](https://aidimag.com/getting-started)
90
- - [Quick Start](https://aidimag.com/quickstart)
79
+ **MCP Tools** get `memory_search`, `memory_propose`, `context_note` (live in-chat fact capture), `memory_critique` (a second critic grounded in verified memory), session-start briefings, session-end extraction, and more.
80
+
81
+ **Non-MCP Tools**: `dim generate-context -f all` renders verified memory into `.cursorrules`, `CLAUDE.md`, `AGENTS.md`, `.windsurfrules`, and `.github/copilot-instructions.md` (`--auto` keeps them refreshed).
82
+
83
+ ## ✨ Key Features
84
+
85
+ ### 🛡️ Human-Gated Capture
86
+ Commits, PRs, AI-chat transcripts, and pasted docs are mined into *proposals*. Nothing enters memory until you approve it in `dim review` (auto-triaged best-first, `approve all --min-score 0.7` for batches).
87
+
88
+ ### ✅ Verification Lifecycle
89
+ `STATIC_CHECK` / `COMMIT_REF` / `TEST_RESULT` / `EXEC_TRACE` / `HUMAN_ATTESTED` evidence. Failing evidence flips memories to STALE and auto-drafts a recovery proposal. Confidence decays without re-confirmation.
90
+
91
+ ### 🔒 Evidence Trust Gate
92
+ Shell-command evidence that arrives via team sync is **never executed** until you inspect and approve it (`dim verify --trust`).
93
+
94
+ ### 🔍 Hybrid Semantic Recall
95
+ FTS5 keyword + vector KNN (OpenAI or local Ollama, auto-detected; works keyword-only with neither).
96
+
97
+ ### 🚦 Guardrails & Skills
98
+ Behavioral rules (`never` / `ask-first` / `always`) and step-by-step procedures, enforced by `dim check` (pre-commit) and `memory_critique`.
99
+
100
+ ### 👥 Team Mode, Self-Hosted
101
+ `dim serve` + `dim sync`: local-first replicas, device-code login, brain-scoped API keys, hashed credentials, cross-machine verification consensus.
102
+
103
+ ### 📚 Knowledgebase Inbox
104
+ Drop design docs / ADRs / PDFs / DOCX into `knowledge/` and they're summarized into reviewed, pinned memories.
105
+
106
+ ### 🎨 Web Dashboard & Extensions
107
+ `dim ui` plus VS Code and IntelliJ extensions.
108
+
109
+ ## 📖 Documentation
110
+
111
+ <table>
112
+ <tr>
113
+ <td width="33%">
114
+
115
+ **Getting Started**
116
+ - [Installation](https://aidimag.com/getting-started)
117
+ - [Quick Start (5 min)](https://aidimag.com/quickstart)
118
+ - [Cloud Sync](https://aidimag.com/cloud-quickstart)
119
+
120
+ </td>
121
+ <td width="33%">
122
+
123
+ **Reference**
91
124
  - [CLI Reference](https://aidimag.com/cli-reference)
92
125
  - [MCP Integration](https://aidimag.com/mcp)
93
- - [Team Sync Guide](https://aidimag.com/guides/team-sync)
94
126
  - [Configuration](https://aidimag.com/configuration)
95
127
 
96
- ## Development
128
+ </td>
129
+ <td width="33%">
97
130
 
98
- ```sh
99
- npm install
100
- npm run build # tsc → dist/
101
- npm test # node --test (builds first)
102
- ```
131
+ **Guides**
132
+ - [Team Sync](https://aidimag.com/guides/team-sync)
133
+ - [Guardrails](https://aidimag.com/guides/guardrails)
134
+ - [Context Files](https://aidimag.com/guides/generate-context)
135
+
136
+ </td>
137
+ </tr>
138
+ </table>
139
+
140
+ Full documentation: **[aidimag.com](https://aidimag.com)**
141
+
142
+ ---
143
+
144
+ ## 💰 Pricing
145
+
146
+ **Free for teams of 10 or fewer users** under the [Elastic License 2.0](./LICENSE).
147
+
148
+ For larger teams or commercial use beyond this limit, a commercial license is required. See [**Pricing & Licensing**](https://aidimag.com/pricing) for details.
103
149
 
104
- Self-hosted sync deployment (Docker / Fly.io): [deploy/](https://github.com/anup-khanal/aidimag/tree/main/deploy).
150
+ ---
105
151
 
106
- ## Author
152
+ <div align="center">
107
153
 
108
- **Anup Khanal**
154
+ **Built by [Anup Khanal](https://github.com/anupkhanal)**
109
155
 
110
- ## License
156
+ [Website](https://aidimag.com) • [Documentation](https://aidimag.com) • [Cloud](https://cloud.aidimag.com) • [npm](https://www.npmjs.com/package/aidimag) • [License](./LICENSE)
111
157
 
112
- [Elastic License 2.0](./LICENSE) — free for teams of 10 or fewer users. Commercial license required for larger organizations. Cannot be offered as a managed service to third parties. See [pricing & licensing](docs/pricing.md) for details.
158
+ </div>
113
159
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "aidimag",
3
- "version": "1.0.4",
3
+ "version": "1.0.6",
4
4
  "description": "Persistent, verified memory for AI coding agents. CLI: dim.",
5
5
  "type": "module",
6
6
  "license": "SEE LICENSE IN LICENSE",
@@ -9,7 +9,7 @@
9
9
  "type": "git",
10
10
  "url": "git+https://github.com/anup-khanal/aidimag.git"
11
11
  },
12
- "homepage": "https://github.com/anup-khanal/aidimag#readme",
12
+ "homepage": "https://aidimag.com",
13
13
  "bugs": {
14
14
  "url": "https://github.com/anup-khanal/aidimag/issues"
15
15
  },