kiro-memory 1.1.2 → 1.1.3
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 +22 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -64,11 +64,31 @@ npm install && npm run build
|
|
|
64
64
|
npm run install:kiro
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
### Start Kiro with memory enabled
|
|
68
|
+
|
|
69
|
+
Kiro Memory works as a **custom agent**. You must start Kiro with the `--agent` flag:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
kiro --agent kiro-memory
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
> **Why?** Kiro Memory uses hooks (`agentSpawn`, `postToolUse`, `userPromptSubmit`, `stop`) to capture context automatically. Hooks are defined inside the agent configuration, so they only run when the `kiro-memory` agent is active.
|
|
76
|
+
|
|
77
|
+
To avoid typing the flag every time, add an alias to your shell:
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
# Bash
|
|
81
|
+
echo 'alias kiro="kiro --agent kiro-memory"' >> ~/.bashrc && source ~/.bashrc
|
|
82
|
+
|
|
83
|
+
# Zsh
|
|
84
|
+
echo 'alias kiro="kiro --agent kiro-memory"' >> ~/.zshrc && source ~/.zshrc
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Once running, the worker auto-starts and the web dashboard is available at `http://localhost:3001`.
|
|
68
88
|
|
|
69
89
|
## Kiro Integration
|
|
70
90
|
|
|
71
|
-
Kiro Memory registers **4 hooks** and an **MCP server** with Kiro CLI. The agent configuration is installed to `~/.kiro/agents/kiro-memory.json`:
|
|
91
|
+
Kiro Memory registers **4 hooks** and an **MCP server** with Kiro CLI via a custom agent. The agent configuration is installed to `~/.kiro/agents/kiro-memory.json` and is activated with `kiro --agent kiro-memory`:
|
|
72
92
|
|
|
73
93
|
```json
|
|
74
94
|
{
|
package/package.json
CHANGED