memoclaw 1.7.0 → 1.8.4

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 (3) hide show
  1. package/README.md +100 -26
  2. package/dist/cli.mjs +28228 -2912
  3. package/package.json +2 -1
package/README.md CHANGED
@@ -14,46 +14,119 @@ npm install -g memoclaw
14
14
  export MEMOCLAW_PRIVATE_KEY=0x... # Your wallet private key
15
15
  ```
16
16
 
17
- ## Usage
17
+ ## Quick Start
18
18
 
19
19
  ```bash
20
20
  # Store a memory
21
21
  memoclaw store "learned that user prefers dark mode" --importance 0.8 --tags ui,preferences
22
22
 
23
- # Recall memories
23
+ # Recall memories by similarity
24
24
  memoclaw recall "user preferences" --limit 5
25
25
 
26
- # List all memories
27
- memoclaw list --limit 20
26
+ # List all memories (pretty table)
27
+ memoclaw list
28
28
 
29
- # Update a memory
30
- memoclaw update <id> --importance 0.9 --pinned true
29
+ # Interactive browser
30
+ memoclaw browse
31
+ ```
32
+
33
+ ## Commands
31
34
 
32
- # Delete a memory
33
- memoclaw delete <id>
35
+ ### Core
36
+
37
+ ```bash
38
+ memoclaw store "content" # Store a memory (also accepts stdin)
39
+ memoclaw recall "query" # Search by semantic similarity
40
+ memoclaw list # List memories in a table
41
+ memoclaw get <id> # Get a single memory
42
+ memoclaw update <id> --importance 0.9 # Update a memory
43
+ memoclaw delete <id> # Delete a memory
44
+ memoclaw count # Quick count (pipe-friendly)
45
+ ```
34
46
 
35
- # Ingest raw text (auto-extracts memories)
36
- memoclaw ingest --text "Meeting notes: decided to use Rust for the backend..."
37
- cat transcript.txt | memoclaw ingest
47
+ ### AI Features
38
48
 
39
- # Extract memories from text
40
- memoclaw extract "The project deadline is March 15th and we need 3 engineers"
49
+ ```bash
50
+ memoclaw ingest --text "Meeting notes..." # Auto-extract memories from text
51
+ cat transcript.txt | memoclaw ingest # Pipe text to ingest
52
+ memoclaw extract "The deadline is March 15th"
53
+ memoclaw consolidate --dry-run # Merge similar memories
54
+ memoclaw suggested --category stale # Review suggested memories
55
+ ```
41
56
 
42
- # Consolidate duplicate memories
43
- memoclaw consolidate --dry-run
44
- memoclaw consolidate --min-similarity 0.85
57
+ ### Relations
45
58
 
46
- # Manage relations between memories
59
+ ```bash
47
60
  memoclaw relations list <memory-id>
48
61
  memoclaw relations create <memory-id> <target-id> related_to
49
62
  memoclaw relations delete <memory-id> <relation-id>
63
+ memoclaw graph <id> # ASCII tree visualization
64
+ ```
65
+
66
+ Valid relation types: `related_to`, `derived_from`, `contradicts`, `supersedes`, `supports`
67
+
68
+ ### Bulk Operations
69
+
70
+ ```bash
71
+ memoclaw export > backup.json # Export all memories
72
+ memoclaw export --namespace project1 > p1.json
73
+ memoclaw import --file backup.json # Import from file
74
+ cat backup.json | memoclaw import # Import from stdin
75
+ memoclaw purge --force # Delete ALL memories
76
+ memoclaw purge --namespace old --force # Delete namespace
77
+ ```
50
78
 
51
- # Review suggested memories (stale, decaying, etc.)
52
- memoclaw suggested --category stale
53
- memoclaw suggested --raw
79
+ ### Account & Config
54
80
 
55
- # Check free tier status
56
- memoclaw status
81
+ ```bash
82
+ memoclaw status # Free tier remaining
83
+ memoclaw stats # Memory statistics
84
+ memoclaw config show # Show configuration
85
+ memoclaw config check # Validate setup
86
+ ```
87
+
88
+ ### Interactive Browser
89
+
90
+ ```bash
91
+ memoclaw browse # REPL for exploring memories
92
+ memoclaw browse --namespace project1
93
+ ```
94
+
95
+ Inside the browser: `list`, `get <id>`, `recall <query>`, `store <text>`, `delete <id>`, `stats`, `next`, `prev`, `quit`
96
+
97
+ ### Shell Completions
98
+
99
+ ```bash
100
+ eval "$(memoclaw completions bash)"
101
+ eval "$(memoclaw completions zsh)"
102
+ memoclaw completions fish > ~/.config/fish/completions/memoclaw.fish
103
+ ```
104
+
105
+ ## Global Options
106
+
107
+ | Flag | Short | Description |
108
+ |------|-------|-------------|
109
+ | `--json` | `-j` | Machine-readable JSON output |
110
+ | `--quiet` | `-q` | Suppress non-essential output |
111
+ | `--namespace <name>` | `-n` | Filter/set namespace |
112
+ | `--limit <n>` | `-l` | Limit results |
113
+ | `--tags <a,b>` | `-t` | Comma-separated tags |
114
+ | `--raw` | | Content only (for piping) |
115
+ | `--force` | | Skip confirmation prompts |
116
+ | `--timeout <sec>` | | Request timeout (default: 30) |
117
+ | `--help` | `-h` | Show help |
118
+ | `--version` | `-v` | Show version |
119
+
120
+ Flags can be combined: `memoclaw list -jq -n myns -l 5`
121
+
122
+ ## Piping
123
+
124
+ ```bash
125
+ echo "meeting notes" | memoclaw store
126
+ echo "long text" | memoclaw ingest
127
+ memoclaw recall "query" --raw | head -1
128
+ memoclaw export | jq '.memories | length'
129
+ memoclaw count # outputs just the number
57
130
  ```
58
131
 
59
132
  ## Environment Variables
@@ -62,17 +135,18 @@ memoclaw status
62
135
  |----------|----------|-------------|
63
136
  | `MEMOCLAW_PRIVATE_KEY` | Yes | Wallet private key for auth + payments |
64
137
  | `MEMOCLAW_URL` | No | API endpoint (default: `https://api.memoclaw.com`) |
138
+ | `NO_COLOR` | No | Disable colored output |
65
139
  | `DEBUG` | No | Enable debug logging |
66
140
 
67
141
  ## Free Tier
68
142
 
69
143
  Every wallet gets **1000 free API calls**. After that, x402 micropayments kick in automatically — $0.001/call in USDC on Base. No signup, no API keys, just your wallet.
70
144
 
71
- ## API
145
+ ## Links
72
146
 
73
- - Dashboard: [https://memoclaw.com](https://memoclaw.com)
74
- - API: [https://api.memoclaw.com](https://api.memoclaw.com)
75
- - Docs: [https://docs.memoclaw.com](https://docs.memoclaw.com)
147
+ - Dashboard: [memoclaw.com](https://memoclaw.com)
148
+ - API: [api.memoclaw.com](https://api.memoclaw.com)
149
+ - Docs: [docs.memoclaw.com](https://docs.memoclaw.com)
76
150
 
77
151
  ## License
78
152