Skip to content

Commit 120cbd0

Browse files
authored
Merge pull request #33 from chrisribe/copilot/add-cli-shortcuts-implementation
Add human-friendly CLI shortcuts that generate GraphQL queries
2 parents 925258e + 3e30ac6 commit 120cbd0

File tree

4 files changed

+376
-48
lines changed

4 files changed

+376
-48
lines changed

README.md

Lines changed: 44 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -134,33 +134,59 @@ The assistant stores memories silently and retrieves them when relevant, creatin
134134

135135
### Command Line Interface
136136

137-
The CLI uses GraphQL for all operations:
137+
#### Quick Commands
138+
139+
For common operations, use simple shortcuts:
138140

139141
```bash
142+
# Search memories
143+
simple-memory search --query "typescript" --limit 5
144+
simple-memory search --tags "project,work" --limit 20
145+
simple-memory search --query "bug" --daysAgo 7
146+
simple-memory search --query "api" --verbose # Shows generated GraphQL
147+
140148
# Store a memory
141-
simple-memory memory-graphql --query 'mutation { store(content: "Your content", tags: ["tag1", "tag2"]) { hash } }'
149+
simple-memory store --content "Remember this note"
150+
simple-memory store --content "API key: xyz" --tags "credentials,api"
142151

143-
# Search by content
144-
simple-memory memory-graphql --query '{ memories(query: "search term", limit: 5) { hash title tags } }'
152+
# Update a memory
153+
simple-memory update --hash "abc123..." --content "Updated content"
145154

146-
# Search by tags
147-
simple-memory memory-graphql --query '{ memories(tags: ["tag1"], limit: 10) { hash title content } }'
155+
# Get specific memory
156+
simple-memory get --hash "abc123..."
148157

149-
# Get full content by hash
150-
simple-memory memory-graphql --query '{ memory(hash: "abc123...") { content tags createdAt } }'
158+
# Find related memories
159+
simple-memory related --hash "abc123..." --limit 10
151160

152-
# View statistics
153-
simple-memory memory-graphql --query '{ stats { totalMemories totalRelationships dbSize } }'
161+
# Delete memories
162+
simple-memory delete --hash "abc123..."
163+
simple-memory delete --tag "temporary"
154164

155-
# Update a memory
156-
simple-memory memory-graphql --query 'mutation { update(hash: "abc123...", content: "New content", tags: ["new"]) { hash } }'
165+
# Get database stats
166+
simple-memory stats
167+
168+
# Export/import
169+
simple-memory export-memory --output backup.json
170+
simple-memory import-memory --input backup.json
171+
```
172+
173+
Run `simple-memory <command> --help` for command-specific options.
174+
175+
> 💡 **Learning GraphQL?** Use `--verbose` with any shortcut command to see the generated GraphQL query. Great for learning the syntax!
176+
177+
#### Advanced: Raw GraphQL
178+
179+
Power users can execute raw GraphQL queries:
180+
181+
```bash
182+
# Raw GraphQL query
183+
simple-memory graphql --query '{ memories(query: "search term") { hash title tags } }'
157184

158-
# Delete by hash or tag
159-
simple-memory memory-graphql --query 'mutation { delete(hash: "abc123...") { deletedCount } }'
160-
simple-memory memory-graphql --query 'mutation { delete(tag: "old-notes") { deletedCount } }'
185+
# GraphQL mutation
186+
simple-memory graphql --query 'mutation { store(content: "Your content") { hash } }'
161187

162188
# Batch multiple operations in one call
163-
simple-memory memory-graphql --query '{
189+
simple-memory graphql --query '{
164190
recent: memories(limit: 5) { hash title }
165191
tagged: memories(tags: ["important"]) { hash title }
166192
stats { totalMemories }
@@ -286,7 +312,8 @@ Just add to your MCP config and start using it:
286312
| `MEMORY_BACKUP_INTERVAL` | Minutes between backups | `0` (disabled) | `180` |
287313
| `MEMORY_BACKUP_KEEP` | Number of backups to keep | `10` | `24` |
288314
| `MEMORY_CLOUD_SAFE` | Cloud storage safe mode | `false` | `true` |
289-
| `DEBUG` | Enable debug logging | `false` | `true` |
315+
| `MEMORY_DEBUG` | Enable debug logging in CLI mode | `false` | `true` |
316+
| `DEBUG` | Enable debug logging (MCP server) | `false` | `true` |
290317

291318
### Custom Database Location
292319

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)