mirror of
https://github.com/runablehq/memory.git
synced 2026-09-19 03:29:19 +08:00
prepare for skill publishing
- Move SKILL.md to skill/ for skills.sh convention - Update package.json: @runablehq/mem, add description/keywords/files - Add terminal demo gif showing skills add + mem usage - Rewrite README with demo gif, skills.sh and runable.com links - Add VHS tape file for regenerating the gif
This commit is contained in:
@@ -1,6 +1,35 @@
|
||||
# mem
|
||||
# mem · agent memory store
|
||||
|
||||
Agent memory store. Three operators, one tool.
|
||||
Three operators, one tool. Remember, recall, forget — with full-text search backed by SQLite.
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/demo.gif" alt="mem demo — install skill, remember, recall, search" width="860" />
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://skills.sh/runablehq/memory/mem"><img alt="skills.sh" src="https://img.shields.io/badge/skills.sh-install-green"></a>
|
||||
<a href="https://runable.com/npm/@runablehq/mem"><img alt="runable" src="https://img.shields.io/badge/runable.com-try%20it-blue"></a>
|
||||
</p>
|
||||
|
||||
## Setup
|
||||
|
||||
### As an agent skill (recommended)
|
||||
|
||||
```bash
|
||||
npx skills add runablehq/memory --all --global
|
||||
```
|
||||
|
||||
This installs the `mem` skill for all your agents via [skills.sh](https://skills.sh/runablehq/memory/mem). Your agent will automatically know how to store and recall information across sessions.
|
||||
|
||||
### Manual install
|
||||
|
||||
```bash
|
||||
# requires bun
|
||||
bun build --compile src/cli.ts --outfile dist/mem
|
||||
cp dist/mem ~/.local/bin/mem
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
mem [query] recall (search, list, or get by ID)
|
||||
@@ -8,29 +37,46 @@ mem + "content" [--tag a,b] remember
|
||||
mem - <id> forget
|
||||
```
|
||||
|
||||
## Install
|
||||
### Remember
|
||||
|
||||
```bash
|
||||
bun run install:all
|
||||
mem + "chose SQLite for simplicity" --tag architecture
|
||||
mem + "user prefers dark mode" --tag prefs
|
||||
mem + "deploy: bun build --compile" --tag deploy
|
||||
mem + --image ./screenshot.png --title "Current UI" --tag ui
|
||||
echo "long content" | mem + --tag notes
|
||||
```
|
||||
|
||||
## Usage
|
||||
### Recall
|
||||
|
||||
```bash
|
||||
mem # list recent
|
||||
mem "deploy" # search
|
||||
mem 7sjtNVyZrNIa # get by ID
|
||||
mem + "chose Bun" --tag deploy # remember
|
||||
mem - 7sjtNVyZrNIa # forget
|
||||
echo "long" | mem + --tag notes # stdin
|
||||
mem "old" --json | jq . # pipe
|
||||
mem --tag prefs # filter by tag
|
||||
mem "api" --limit 5 --json # limit + JSON output
|
||||
```
|
||||
|
||||
### Forget
|
||||
|
||||
```bash
|
||||
mem - 7sjtNVyZrNIa # forget one
|
||||
mem - id1 id2 id3 # forget many
|
||||
```
|
||||
|
||||
### Piping
|
||||
|
||||
```bash
|
||||
mem "old" --json | jq . # pipe to jq
|
||||
mem "old" --json | jq -r '.[].id' | xargs -I{} mem - {}
|
||||
echo "long content" | mem + --tag notes
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
```
|
||||
--tag a,b filter (read) or apply (write)
|
||||
--json structured output
|
||||
--json structured JSON output
|
||||
--full full content inline
|
||||
--limit n max results (default 20)
|
||||
--image path attach image
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 842 KiB |
@@ -0,0 +1,52 @@
|
||||
# VHS tape for mem demo
|
||||
# https://github.com/charmbracelet/vhs
|
||||
|
||||
Output assets/demo.gif
|
||||
|
||||
Set Shell "bash"
|
||||
Set FontSize 14
|
||||
Set Width 860
|
||||
Set Height 460
|
||||
Set Padding 16
|
||||
Set Theme "GitHub Dark"
|
||||
Set TypingSpeed 30ms
|
||||
Set CursorBlink false
|
||||
|
||||
Sleep 500ms
|
||||
|
||||
# Install the skill
|
||||
Type "npx skills add runablehq/memory --all --global"
|
||||
Enter
|
||||
Sleep 5s
|
||||
|
||||
# Remember something
|
||||
Type `mem + "chose SQLite for simplicity" --tag architecture`
|
||||
Enter
|
||||
Sleep 2s
|
||||
|
||||
# Remember more
|
||||
Type `mem + "user prefers dark mode" --tag prefs`
|
||||
Enter
|
||||
Sleep 2s
|
||||
|
||||
# List recent memories
|
||||
Type "mem"
|
||||
Enter
|
||||
Sleep 2s
|
||||
|
||||
# Search
|
||||
Type `mem "SQLite"`
|
||||
Enter
|
||||
Sleep 2s
|
||||
|
||||
# Search with JSON
|
||||
Type `mem "dark" --json`
|
||||
Enter
|
||||
Sleep 2s
|
||||
|
||||
# List installed skills
|
||||
Type "npx skills ls"
|
||||
Enter
|
||||
Sleep 3s
|
||||
|
||||
Sleep 1s
|
||||
+18
-5
@@ -1,17 +1,30 @@
|
||||
{
|
||||
"name": "mem",
|
||||
"name": "@runablehq/mem",
|
||||
"version": "1.0.0",
|
||||
"type": "module",
|
||||
"description": "Agent memory store — remember, recall, forget with full-text search",
|
||||
"keywords": [
|
||||
"memory",
|
||||
"agent",
|
||||
"cli",
|
||||
"sqlite",
|
||||
"fts",
|
||||
"search",
|
||||
"knowledge-base"
|
||||
],
|
||||
"bin": {
|
||||
"mem": "src/cli.ts"
|
||||
"mem": "dist/mem"
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"skill",
|
||||
"README.md"
|
||||
],
|
||||
"scripts": {
|
||||
"dev": "bun src/cli.ts",
|
||||
"test": "bun test",
|
||||
"build": "bun build --compile src/cli.ts --outfile dist/mem",
|
||||
"install:bin": "bun run build && cp dist/mem ~/.local/bin/mem && echo 'Installed mem to ~/.local/bin/mem'",
|
||||
"install:skill": "mkdir -p ~/.pi/agent/skills/mem && cp SKILL.md ~/.pi/agent/skills/mem/ && echo 'Installed skill to ~/.pi/agent/skills/mem'",
|
||||
"install:all": "bun run install:bin && bun run install:skill"
|
||||
"prepublishOnly": "bun run build"
|
||||
},
|
||||
"dependencies": {
|
||||
"date-fns": "^4.1.0",
|
||||
|
||||
Reference in New Issue
Block a user