agentrem 1.0.0
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 +194 -0
- package/dist/core.d.ts +138 -0
- package/dist/core.d.ts.map +1 -0
- package/dist/core.js +816 -0
- package/dist/core.js.map +1 -0
- package/dist/date-parser.d.ts +13 -0
- package/dist/date-parser.d.ts.map +1 -0
- package/dist/date-parser.js +141 -0
- package/dist/date-parser.js.map +1 -0
- package/dist/db.d.ts +8 -0
- package/dist/db.d.ts.map +1 -0
- package/dist/db.js +176 -0
- package/dist/db.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +613 -0
- package/dist/index.js.map +1 -0
- package/dist/mcp/prompts.d.ts +3 -0
- package/dist/mcp/prompts.d.ts.map +1 -0
- package/dist/mcp/prompts.js +60 -0
- package/dist/mcp/prompts.js.map +1 -0
- package/dist/mcp/resources.d.ts +3 -0
- package/dist/mcp/resources.d.ts.map +1 -0
- package/dist/mcp/resources.js +73 -0
- package/dist/mcp/resources.js.map +1 -0
- package/dist/mcp/server.d.ts +4 -0
- package/dist/mcp/server.d.ts.map +1 -0
- package/dist/mcp/server.js +31 -0
- package/dist/mcp/server.js.map +1 -0
- package/dist/mcp/tools.d.ts +3 -0
- package/dist/mcp/tools.d.ts.map +1 -0
- package/dist/mcp/tools.js +500 -0
- package/dist/mcp/tools.js.map +1 -0
- package/dist/types.d.ts +64 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +43 -0
- package/dist/types.js.map +1 -0
- package/llms.txt +127 -0
- package/package.json +45 -0
package/llms.txt
ADDED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
# agentrem
|
|
2
|
+
|
|
3
|
+
> Structured reminders CLI + MCP server for AI agents. Persistent, priority-aware memory with triggers, recurrence, dependencies, and full-text search.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install agentrem
|
|
9
|
+
npm run build
|
|
10
|
+
agentrem init
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Core Concepts
|
|
14
|
+
|
|
15
|
+
- **Reminders** have content, priority (P1-P5), tags, trigger type, and optional due dates
|
|
16
|
+
- **Trigger types**: `time` (due date), `keyword` (text match), `condition` (shell check), `session` (every session), `heartbeat` (every heartbeat), `manual`
|
|
17
|
+
- **Priority levels**: 1=Critical, 2=High, 3=Normal, 4=Low, 5=Someday
|
|
18
|
+
- **Token budget**: `check --budget <n>` limits output to fit context windows
|
|
19
|
+
- **Multi-agent**: `--agent <name>` isolates reminders per agent namespace
|
|
20
|
+
- **Database**: SQLite with FTS5 full-text search at `~/.agentrem/reminders.db`
|
|
21
|
+
|
|
22
|
+
## CLI Quick Reference
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# Create reminders
|
|
26
|
+
agentrem add "Deploy v2.1" --due "+2h" --priority 2 --tags "deploy"
|
|
27
|
+
agentrem add "Review on deploy" --trigger keyword --keywords "deploy,release" --match any
|
|
28
|
+
agentrem add "Check CI" --trigger session
|
|
29
|
+
agentrem add "Weekly sync" --due "monday 9am" --recur 1w
|
|
30
|
+
|
|
31
|
+
# Check what's triggered (the main agent integration point)
|
|
32
|
+
agentrem check # all triggered reminders
|
|
33
|
+
agentrem check --type time,keyword # specific trigger types
|
|
34
|
+
agentrem check --budget 500 # limit output tokens
|
|
35
|
+
agentrem check --escalate # auto-promote overdue (P3→P2 after 48h, P2→P1 after 24h)
|
|
36
|
+
agentrem check --keywords "deploy" # check keyword triggers against text
|
|
37
|
+
|
|
38
|
+
# List and search
|
|
39
|
+
agentrem list # all active
|
|
40
|
+
agentrem list --priority 1,2 # critical + high only
|
|
41
|
+
agentrem list --tag deploy # by tag
|
|
42
|
+
agentrem list --trigger keyword # by trigger type
|
|
43
|
+
agentrem search "deploy staging" # FTS5 search across all fields
|
|
44
|
+
|
|
45
|
+
# Manage
|
|
46
|
+
agentrem complete <id> # mark done (auto-creates next if recurring)
|
|
47
|
+
agentrem snooze <id> --for 2h # snooze for duration
|
|
48
|
+
agentrem snooze <id> --until "tomorrow 9am" # snooze until datetime
|
|
49
|
+
agentrem edit <id> --priority 1 # change fields
|
|
50
|
+
agentrem delete <id> # soft delete
|
|
51
|
+
agentrem delete <id> --permanent # hard delete
|
|
52
|
+
|
|
53
|
+
# Maintenance
|
|
54
|
+
agentrem stats # counts by status, priority, trigger type
|
|
55
|
+
agentrem gc # clean up old completed/deleted
|
|
56
|
+
agentrem history [id] # audit trail
|
|
57
|
+
agentrem undo <history_id> # revert a change
|
|
58
|
+
agentrem export > backup.json # JSON export
|
|
59
|
+
agentrem import backup.json # JSON import (--mode merge|replace)
|
|
60
|
+
agentrem schema # show DB schema
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## MCP Server
|
|
64
|
+
|
|
65
|
+
Run as Model Context Protocol server for direct AI tool integration:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
node dist/mcp/server.js
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### MCP Tools
|
|
72
|
+
- `add_reminder` — create a reminder
|
|
73
|
+
- `check_reminders` — check for triggered reminders
|
|
74
|
+
- `list_reminders` — list with filters
|
|
75
|
+
- `search_reminders` — full-text search
|
|
76
|
+
- `complete_reminder` — mark complete
|
|
77
|
+
- `snooze_reminder` — snooze by duration or datetime
|
|
78
|
+
- `edit_reminder` — modify fields
|
|
79
|
+
- `delete_reminder` — soft or permanent delete
|
|
80
|
+
- `get_stats` — statistics
|
|
81
|
+
- `get_history` — audit trail
|
|
82
|
+
- `undo_change` — revert a change
|
|
83
|
+
- `garbage_collect` — clean up old reminders
|
|
84
|
+
- `export_reminders` — JSON export
|
|
85
|
+
- `import_reminders` — JSON import
|
|
86
|
+
|
|
87
|
+
### MCP Resources
|
|
88
|
+
- `agentrem://reminders/active` — all active reminders
|
|
89
|
+
- `agentrem://reminders/overdue` — overdue reminders
|
|
90
|
+
- `agentrem://stats` — statistics
|
|
91
|
+
- `agentrem://schema` — database schema
|
|
92
|
+
|
|
93
|
+
### MCP Prompts
|
|
94
|
+
- `triage` — review and prioritize active reminders
|
|
95
|
+
- `guided-creation` — interactive reminder creation wizard
|
|
96
|
+
- `session-briefing` — session start briefing with due/overdue items
|
|
97
|
+
|
|
98
|
+
## Agent Integration Patterns
|
|
99
|
+
|
|
100
|
+
### Session start hook
|
|
101
|
+
```bash
|
|
102
|
+
agentrem check --type time,session,heartbeat --budget 800
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Message keyword scanning
|
|
106
|
+
```bash
|
|
107
|
+
agentrem check --type keyword --text "the user message text here"
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Periodic maintenance (cron)
|
|
111
|
+
```bash
|
|
112
|
+
agentrem check --escalate && agentrem gc --days 30
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## Key Features
|
|
116
|
+
|
|
117
|
+
- **Recurrence**: `--recur 1d|2w|1m` auto-creates next instance on completion
|
|
118
|
+
- **Dependencies**: `--depends-on <id>` blocks until dependency is completed
|
|
119
|
+
- **Decay**: `--decay <datetime>` auto-expires after a date
|
|
120
|
+
- **Max fires**: `--max-fires <n>` auto-completes after N triggers
|
|
121
|
+
- **Escalation**: overdue reminders auto-promote priority over time
|
|
122
|
+
- **Undo**: full audit history, revert any change
|
|
123
|
+
- **Export/Import**: JSON backup with merge and replace modes
|
|
124
|
+
|
|
125
|
+
## License
|
|
126
|
+
|
|
127
|
+
MIT
|
package/package.json
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "agentrem",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Structured reminders CLI for AI agents with MCP server",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "dist/index.js",
|
|
7
|
+
"bin": {
|
|
8
|
+
"agentrem": "dist/index.js",
|
|
9
|
+
"agentrem-mcp": "dist/mcp/server.js"
|
|
10
|
+
},
|
|
11
|
+
"files": [
|
|
12
|
+
"dist",
|
|
13
|
+
"llms.txt",
|
|
14
|
+
"README.md",
|
|
15
|
+
"LICENSE"
|
|
16
|
+
],
|
|
17
|
+
"scripts": {
|
|
18
|
+
"build": "tsc",
|
|
19
|
+
"dev": "tsc --watch",
|
|
20
|
+
"test": "vitest run",
|
|
21
|
+
"test:watch": "vitest",
|
|
22
|
+
"start": "node dist/index.js",
|
|
23
|
+
"mcp": "node dist/mcp/server.js",
|
|
24
|
+
"prepublishOnly": "npm run build && npm test"
|
|
25
|
+
},
|
|
26
|
+
"keywords": ["reminders", "ai-agent", "cli", "mcp", "sqlite", "llm", "agent-tools", "model-context-protocol"],
|
|
27
|
+
"author": "Dushyant Garg",
|
|
28
|
+
"repository": {
|
|
29
|
+
"type": "git",
|
|
30
|
+
"url": "https://github.com/fraction12/agentrem.git"
|
|
31
|
+
},
|
|
32
|
+
"homepage": "https://github.com/fraction12/agentrem",
|
|
33
|
+
"license": "MIT",
|
|
34
|
+
"dependencies": {
|
|
35
|
+
"@modelcontextprotocol/sdk": "^1.12.1",
|
|
36
|
+
"better-sqlite3": "^11.8.2",
|
|
37
|
+
"commander": "^13.1.0"
|
|
38
|
+
},
|
|
39
|
+
"devDependencies": {
|
|
40
|
+
"@types/better-sqlite3": "^7.6.13",
|
|
41
|
+
"@types/node": "^22.13.4",
|
|
42
|
+
"typescript": "^5.7.3",
|
|
43
|
+
"vitest": "^3.0.6"
|
|
44
|
+
}
|
|
45
|
+
}
|