ragtime-cli 0.2.17__tar.gz → 0.3.0__tar.gz
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.
- {ragtime_cli-0.2.17/ragtime_cli.egg-info → ragtime_cli-0.3.0}/PKG-INFO +79 -28
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/README.md +78 -27
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/pyproject.toml +1 -4
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0/ragtime_cli.egg-info}/PKG-INFO +79 -28
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/ragtime_cli.egg-info/SOURCES.txt +0 -10
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/src/cli.py +1021 -111
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/src/config.py +17 -1
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/src/indexers/docs.py +86 -8
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/src/mcp_server.py +26 -3
- ragtime_cli-0.2.17/src/commands/audit.md +0 -151
- ragtime_cli-0.2.17/src/commands/create-pr.md +0 -389
- ragtime_cli-0.2.17/src/commands/generate-docs.md +0 -325
- ragtime_cli-0.2.17/src/commands/handoff.md +0 -176
- ragtime_cli-0.2.17/src/commands/import-docs.md +0 -259
- ragtime_cli-0.2.17/src/commands/pr-graduate.md +0 -192
- ragtime_cli-0.2.17/src/commands/recall.md +0 -175
- ragtime_cli-0.2.17/src/commands/remember.md +0 -168
- ragtime_cli-0.2.17/src/commands/save.md +0 -10
- ragtime_cli-0.2.17/src/commands/start.md +0 -206
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/LICENSE +0 -0
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/ragtime_cli.egg-info/dependency_links.txt +0 -0
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/ragtime_cli.egg-info/entry_points.txt +0 -0
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/ragtime_cli.egg-info/requires.txt +0 -0
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/ragtime_cli.egg-info/top_level.txt +0 -0
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/setup.cfg +0 -0
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/src/__init__.py +0 -0
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/src/db.py +0 -0
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/src/feedback.py +0 -0
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/src/indexers/__init__.py +0 -0
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/src/indexers/code.py +0 -0
- {ragtime_cli-0.2.17 → ragtime_cli-0.3.0}/src/memory.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: ragtime-cli
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.3.0
|
|
4
4
|
Summary: Local-first memory and RAG system for Claude Code - semantic search over code, docs, and team knowledge
|
|
5
5
|
Author-email: Bret Martineau <bretwardjames@gmail.com>
|
|
6
6
|
License-Expression: MIT
|
|
@@ -32,6 +32,10 @@ Dynamic: license-file
|
|
|
32
32
|
|
|
33
33
|
Local-first memory and RAG system for Claude Code. Semantic search over code, docs, and team knowledge.
|
|
34
34
|
|
|
35
|
+
**Two interfaces, same data:**
|
|
36
|
+
- **CLI** for humans - formatted output, interactive workflows
|
|
37
|
+
- **MCP** for agents - structured data, tool integration
|
|
38
|
+
|
|
35
39
|
## Features
|
|
36
40
|
|
|
37
41
|
- **Memory Storage**: Store structured knowledge with namespaces, types, and metadata
|
|
@@ -42,8 +46,8 @@ Local-first memory and RAG system for Claude Code. Semantic search over code, do
|
|
|
42
46
|
- **Doc Generation**: Generate documentation from code (stubs or AI-powered)
|
|
43
47
|
- **Debug Tools**: Verify index integrity, inspect similarity scores
|
|
44
48
|
- **MCP Server**: Native Claude Code integration
|
|
45
|
-
- **
|
|
46
|
-
- **ghp-cli Integration**: Auto-context when starting issues
|
|
49
|
+
- **Usage Documentation**: Guidance for integrating ragtime into AI workflows
|
|
50
|
+
- **ghp-cli Integration**: Auto-context when starting issues via hooks
|
|
47
51
|
|
|
48
52
|
## Installation
|
|
49
53
|
|
|
@@ -54,9 +58,15 @@ pip install ragtime-cli
|
|
|
54
58
|
## Quick Start
|
|
55
59
|
|
|
56
60
|
```bash
|
|
57
|
-
# Initialize in your project
|
|
61
|
+
# Initialize in your project (prompts to set up MCP server)
|
|
58
62
|
ragtime init
|
|
59
63
|
|
|
64
|
+
# Or skip prompts with -y
|
|
65
|
+
ragtime -y init
|
|
66
|
+
|
|
67
|
+
# Or just enable MCP globally (works in any project)
|
|
68
|
+
ragtime init -G
|
|
69
|
+
|
|
60
70
|
# Index your docs
|
|
61
71
|
ragtime index
|
|
62
72
|
|
|
@@ -69,8 +79,8 @@ ragtime remember "Auth uses JWT with 15-min expiry" \
|
|
|
69
79
|
# Search memories
|
|
70
80
|
ragtime search "authentication" --namespace app
|
|
71
81
|
|
|
72
|
-
#
|
|
73
|
-
ragtime
|
|
82
|
+
# View usage documentation for AI integration
|
|
83
|
+
ragtime usage
|
|
74
84
|
|
|
75
85
|
# Check for updates
|
|
76
86
|
ragtime update --check
|
|
@@ -196,17 +206,17 @@ ragtime daemon status
|
|
|
196
206
|
ragtime daemon stop
|
|
197
207
|
```
|
|
198
208
|
|
|
199
|
-
###
|
|
209
|
+
### Usage Documentation
|
|
200
210
|
|
|
201
211
|
```bash
|
|
202
|
-
#
|
|
203
|
-
ragtime
|
|
204
|
-
|
|
205
|
-
# Install globally
|
|
206
|
-
ragtime install --global
|
|
212
|
+
# View all usage documentation
|
|
213
|
+
ragtime usage
|
|
207
214
|
|
|
208
|
-
#
|
|
209
|
-
ragtime
|
|
215
|
+
# View specific sections
|
|
216
|
+
ragtime usage --section mcp # MCP server integration
|
|
217
|
+
ragtime usage --section cli # CLI workflow examples
|
|
218
|
+
ragtime usage --section workflows # Common AI workflow patterns
|
|
219
|
+
ragtime usage --section conventions # Convention checking
|
|
210
220
|
|
|
211
221
|
# Set up ghp-cli hooks
|
|
212
222
|
ragtime setup-ghp
|
|
@@ -249,6 +259,10 @@ code:
|
|
|
249
259
|
conventions:
|
|
250
260
|
files: [".ragtime/CONVENTIONS.md"]
|
|
251
261
|
also_search_memories: true
|
|
262
|
+
storage: auto # auto | file | memory | ask
|
|
263
|
+
default_file: ".ragtime/CONVENTIONS.md"
|
|
264
|
+
folder: ".ragtime/conventions/"
|
|
265
|
+
scan_docs_for_sections: ["docs/"]
|
|
252
266
|
```
|
|
253
267
|
|
|
254
268
|
## How Search Works
|
|
@@ -398,25 +412,60 @@ Sessions are stored in Redis, not cookies.
|
|
|
398
412
|
| `integration` | External service connections |
|
|
399
413
|
| `context` | Session handoff |
|
|
400
414
|
|
|
401
|
-
##
|
|
415
|
+
## AI Integration
|
|
402
416
|
|
|
403
|
-
|
|
417
|
+
Ragtime is designed to work seamlessly with AI agents via MCP tools. Run `ragtime usage` for comprehensive documentation on integration patterns.
|
|
404
418
|
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
419
|
+
### Key Patterns
|
|
420
|
+
|
|
421
|
+
**Memory Storage**: Use `remember` to capture architectural decisions, patterns, and context:
|
|
422
|
+
```
|
|
423
|
+
remember("Auth uses JWT with 15-min expiry", namespace="app", type="architecture", component="auth")
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
**Semantic Search**: Use `search` for finding relevant code and documentation:
|
|
427
|
+
```
|
|
428
|
+
search("how does authentication work", tiered=True) # Prioritizes curated knowledge
|
|
429
|
+
search("error handling", require_terms=["mobile", "dart"]) # Hybrid filtering
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
**Convention Checking**: Before PRs, verify code follows team standards:
|
|
433
|
+
```bash
|
|
434
|
+
ragtime check-conventions # Filtered to changed files
|
|
435
|
+
ragtime check-conventions --all # All conventions (for AI analysis)
|
|
436
|
+
```
|
|
437
|
+
|
|
438
|
+
**Handoff Context**: Save session state for continuity:
|
|
439
|
+
```
|
|
440
|
+
store_doc(content="Session summary...", namespace="branch-feature-123", doc_type="handoff")
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
### Building Custom Commands
|
|
444
|
+
|
|
445
|
+
Create project-specific slash commands in `.claude/commands/` that orchestrate ragtime tools:
|
|
446
|
+
|
|
447
|
+
```markdown
|
|
448
|
+
# .claude/commands/my-workflow.md
|
|
449
|
+
1. Search for relevant context: search("$ARGUMENTS", tiered=True)
|
|
450
|
+
2. Store any new insights: remember(...)
|
|
451
|
+
3. Check conventions before suggesting changes
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
The **real value is in the MCP tools** - combine them however fits your workflow.
|
|
416
455
|
|
|
417
456
|
## MCP Server
|
|
418
457
|
|
|
419
|
-
|
|
458
|
+
The MCP server is automatically configured during `ragtime init`. You can also set it up manually:
|
|
459
|
+
|
|
460
|
+
```bash
|
|
461
|
+
# Project-level: creates .mcp.json in current project
|
|
462
|
+
ragtime init
|
|
463
|
+
|
|
464
|
+
# Global: adds to ~/.claude/settings.json (works in any project)
|
|
465
|
+
ragtime init -G
|
|
466
|
+
```
|
|
467
|
+
|
|
468
|
+
Or add manually to `.mcp.json`:
|
|
420
469
|
|
|
421
470
|
```json
|
|
422
471
|
{
|
|
@@ -429,6 +478,8 @@ Add to your Claude config (`.mcp.json`):
|
|
|
429
478
|
}
|
|
430
479
|
```
|
|
431
480
|
|
|
481
|
+
The MCP server automatically finds the project root (`.ragtime` directory) even when Claude is started from a subdirectory.
|
|
482
|
+
|
|
432
483
|
Available tools:
|
|
433
484
|
- `remember` - Store a memory
|
|
434
485
|
- `search` - Semantic search (supports tiered mode and auto-extraction)
|
|
@@ -2,6 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
Local-first memory and RAG system for Claude Code. Semantic search over code, docs, and team knowledge.
|
|
4
4
|
|
|
5
|
+
**Two interfaces, same data:**
|
|
6
|
+
- **CLI** for humans - formatted output, interactive workflows
|
|
7
|
+
- **MCP** for agents - structured data, tool integration
|
|
8
|
+
|
|
5
9
|
## Features
|
|
6
10
|
|
|
7
11
|
- **Memory Storage**: Store structured knowledge with namespaces, types, and metadata
|
|
@@ -12,8 +16,8 @@ Local-first memory and RAG system for Claude Code. Semantic search over code, do
|
|
|
12
16
|
- **Doc Generation**: Generate documentation from code (stubs or AI-powered)
|
|
13
17
|
- **Debug Tools**: Verify index integrity, inspect similarity scores
|
|
14
18
|
- **MCP Server**: Native Claude Code integration
|
|
15
|
-
- **
|
|
16
|
-
- **ghp-cli Integration**: Auto-context when starting issues
|
|
19
|
+
- **Usage Documentation**: Guidance for integrating ragtime into AI workflows
|
|
20
|
+
- **ghp-cli Integration**: Auto-context when starting issues via hooks
|
|
17
21
|
|
|
18
22
|
## Installation
|
|
19
23
|
|
|
@@ -24,9 +28,15 @@ pip install ragtime-cli
|
|
|
24
28
|
## Quick Start
|
|
25
29
|
|
|
26
30
|
```bash
|
|
27
|
-
# Initialize in your project
|
|
31
|
+
# Initialize in your project (prompts to set up MCP server)
|
|
28
32
|
ragtime init
|
|
29
33
|
|
|
34
|
+
# Or skip prompts with -y
|
|
35
|
+
ragtime -y init
|
|
36
|
+
|
|
37
|
+
# Or just enable MCP globally (works in any project)
|
|
38
|
+
ragtime init -G
|
|
39
|
+
|
|
30
40
|
# Index your docs
|
|
31
41
|
ragtime index
|
|
32
42
|
|
|
@@ -39,8 +49,8 @@ ragtime remember "Auth uses JWT with 15-min expiry" \
|
|
|
39
49
|
# Search memories
|
|
40
50
|
ragtime search "authentication" --namespace app
|
|
41
51
|
|
|
42
|
-
#
|
|
43
|
-
ragtime
|
|
52
|
+
# View usage documentation for AI integration
|
|
53
|
+
ragtime usage
|
|
44
54
|
|
|
45
55
|
# Check for updates
|
|
46
56
|
ragtime update --check
|
|
@@ -166,17 +176,17 @@ ragtime daemon status
|
|
|
166
176
|
ragtime daemon stop
|
|
167
177
|
```
|
|
168
178
|
|
|
169
|
-
###
|
|
179
|
+
### Usage Documentation
|
|
170
180
|
|
|
171
181
|
```bash
|
|
172
|
-
#
|
|
173
|
-
ragtime
|
|
174
|
-
|
|
175
|
-
# Install globally
|
|
176
|
-
ragtime install --global
|
|
182
|
+
# View all usage documentation
|
|
183
|
+
ragtime usage
|
|
177
184
|
|
|
178
|
-
#
|
|
179
|
-
ragtime
|
|
185
|
+
# View specific sections
|
|
186
|
+
ragtime usage --section mcp # MCP server integration
|
|
187
|
+
ragtime usage --section cli # CLI workflow examples
|
|
188
|
+
ragtime usage --section workflows # Common AI workflow patterns
|
|
189
|
+
ragtime usage --section conventions # Convention checking
|
|
180
190
|
|
|
181
191
|
# Set up ghp-cli hooks
|
|
182
192
|
ragtime setup-ghp
|
|
@@ -219,6 +229,10 @@ code:
|
|
|
219
229
|
conventions:
|
|
220
230
|
files: [".ragtime/CONVENTIONS.md"]
|
|
221
231
|
also_search_memories: true
|
|
232
|
+
storage: auto # auto | file | memory | ask
|
|
233
|
+
default_file: ".ragtime/CONVENTIONS.md"
|
|
234
|
+
folder: ".ragtime/conventions/"
|
|
235
|
+
scan_docs_for_sections: ["docs/"]
|
|
222
236
|
```
|
|
223
237
|
|
|
224
238
|
## How Search Works
|
|
@@ -368,25 +382,60 @@ Sessions are stored in Redis, not cookies.
|
|
|
368
382
|
| `integration` | External service connections |
|
|
369
383
|
| `context` | Session handoff |
|
|
370
384
|
|
|
371
|
-
##
|
|
385
|
+
## AI Integration
|
|
372
386
|
|
|
373
|
-
|
|
387
|
+
Ragtime is designed to work seamlessly with AI agents via MCP tools. Run `ragtime usage` for comprehensive documentation on integration patterns.
|
|
374
388
|
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
389
|
+
### Key Patterns
|
|
390
|
+
|
|
391
|
+
**Memory Storage**: Use `remember` to capture architectural decisions, patterns, and context:
|
|
392
|
+
```
|
|
393
|
+
remember("Auth uses JWT with 15-min expiry", namespace="app", type="architecture", component="auth")
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
**Semantic Search**: Use `search` for finding relevant code and documentation:
|
|
397
|
+
```
|
|
398
|
+
search("how does authentication work", tiered=True) # Prioritizes curated knowledge
|
|
399
|
+
search("error handling", require_terms=["mobile", "dart"]) # Hybrid filtering
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
**Convention Checking**: Before PRs, verify code follows team standards:
|
|
403
|
+
```bash
|
|
404
|
+
ragtime check-conventions # Filtered to changed files
|
|
405
|
+
ragtime check-conventions --all # All conventions (for AI analysis)
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
**Handoff Context**: Save session state for continuity:
|
|
409
|
+
```
|
|
410
|
+
store_doc(content="Session summary...", namespace="branch-feature-123", doc_type="handoff")
|
|
411
|
+
```
|
|
412
|
+
|
|
413
|
+
### Building Custom Commands
|
|
414
|
+
|
|
415
|
+
Create project-specific slash commands in `.claude/commands/` that orchestrate ragtime tools:
|
|
416
|
+
|
|
417
|
+
```markdown
|
|
418
|
+
# .claude/commands/my-workflow.md
|
|
419
|
+
1. Search for relevant context: search("$ARGUMENTS", tiered=True)
|
|
420
|
+
2. Store any new insights: remember(...)
|
|
421
|
+
3. Check conventions before suggesting changes
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
The **real value is in the MCP tools** - combine them however fits your workflow.
|
|
386
425
|
|
|
387
426
|
## MCP Server
|
|
388
427
|
|
|
389
|
-
|
|
428
|
+
The MCP server is automatically configured during `ragtime init`. You can also set it up manually:
|
|
429
|
+
|
|
430
|
+
```bash
|
|
431
|
+
# Project-level: creates .mcp.json in current project
|
|
432
|
+
ragtime init
|
|
433
|
+
|
|
434
|
+
# Global: adds to ~/.claude/settings.json (works in any project)
|
|
435
|
+
ragtime init -G
|
|
436
|
+
```
|
|
437
|
+
|
|
438
|
+
Or add manually to `.mcp.json`:
|
|
390
439
|
|
|
391
440
|
```json
|
|
392
441
|
{
|
|
@@ -399,6 +448,8 @@ Add to your Claude config (`.mcp.json`):
|
|
|
399
448
|
}
|
|
400
449
|
```
|
|
401
450
|
|
|
451
|
+
The MCP server automatically finds the project root (`.ragtime` directory) even when Claude is started from a subdirectory.
|
|
452
|
+
|
|
402
453
|
Available tools:
|
|
403
454
|
- `remember` - Store a memory
|
|
404
455
|
- `search` - Semantic search (supports tiered mode and auto-extraction)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "ragtime-cli"
|
|
3
|
-
version = "0.
|
|
3
|
+
version = "0.3.0"
|
|
4
4
|
description = "Local-first memory and RAG system for Claude Code - semantic search over code, docs, and team knowledge"
|
|
5
5
|
readme = "README.md"
|
|
6
6
|
license = "MIT"
|
|
@@ -49,8 +49,5 @@ build-backend = "setuptools.build_meta"
|
|
|
49
49
|
where = ["."]
|
|
50
50
|
include = ["src*"]
|
|
51
51
|
|
|
52
|
-
[tool.setuptools.package-data]
|
|
53
|
-
"src.commands" = ["*.md"]
|
|
54
|
-
|
|
55
52
|
[tool.ruff]
|
|
56
53
|
line-length = 100
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: ragtime-cli
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.3.0
|
|
4
4
|
Summary: Local-first memory and RAG system for Claude Code - semantic search over code, docs, and team knowledge
|
|
5
5
|
Author-email: Bret Martineau <bretwardjames@gmail.com>
|
|
6
6
|
License-Expression: MIT
|
|
@@ -32,6 +32,10 @@ Dynamic: license-file
|
|
|
32
32
|
|
|
33
33
|
Local-first memory and RAG system for Claude Code. Semantic search over code, docs, and team knowledge.
|
|
34
34
|
|
|
35
|
+
**Two interfaces, same data:**
|
|
36
|
+
- **CLI** for humans - formatted output, interactive workflows
|
|
37
|
+
- **MCP** for agents - structured data, tool integration
|
|
38
|
+
|
|
35
39
|
## Features
|
|
36
40
|
|
|
37
41
|
- **Memory Storage**: Store structured knowledge with namespaces, types, and metadata
|
|
@@ -42,8 +46,8 @@ Local-first memory and RAG system for Claude Code. Semantic search over code, do
|
|
|
42
46
|
- **Doc Generation**: Generate documentation from code (stubs or AI-powered)
|
|
43
47
|
- **Debug Tools**: Verify index integrity, inspect similarity scores
|
|
44
48
|
- **MCP Server**: Native Claude Code integration
|
|
45
|
-
- **
|
|
46
|
-
- **ghp-cli Integration**: Auto-context when starting issues
|
|
49
|
+
- **Usage Documentation**: Guidance for integrating ragtime into AI workflows
|
|
50
|
+
- **ghp-cli Integration**: Auto-context when starting issues via hooks
|
|
47
51
|
|
|
48
52
|
## Installation
|
|
49
53
|
|
|
@@ -54,9 +58,15 @@ pip install ragtime-cli
|
|
|
54
58
|
## Quick Start
|
|
55
59
|
|
|
56
60
|
```bash
|
|
57
|
-
# Initialize in your project
|
|
61
|
+
# Initialize in your project (prompts to set up MCP server)
|
|
58
62
|
ragtime init
|
|
59
63
|
|
|
64
|
+
# Or skip prompts with -y
|
|
65
|
+
ragtime -y init
|
|
66
|
+
|
|
67
|
+
# Or just enable MCP globally (works in any project)
|
|
68
|
+
ragtime init -G
|
|
69
|
+
|
|
60
70
|
# Index your docs
|
|
61
71
|
ragtime index
|
|
62
72
|
|
|
@@ -69,8 +79,8 @@ ragtime remember "Auth uses JWT with 15-min expiry" \
|
|
|
69
79
|
# Search memories
|
|
70
80
|
ragtime search "authentication" --namespace app
|
|
71
81
|
|
|
72
|
-
#
|
|
73
|
-
ragtime
|
|
82
|
+
# View usage documentation for AI integration
|
|
83
|
+
ragtime usage
|
|
74
84
|
|
|
75
85
|
# Check for updates
|
|
76
86
|
ragtime update --check
|
|
@@ -196,17 +206,17 @@ ragtime daemon status
|
|
|
196
206
|
ragtime daemon stop
|
|
197
207
|
```
|
|
198
208
|
|
|
199
|
-
###
|
|
209
|
+
### Usage Documentation
|
|
200
210
|
|
|
201
211
|
```bash
|
|
202
|
-
#
|
|
203
|
-
ragtime
|
|
204
|
-
|
|
205
|
-
# Install globally
|
|
206
|
-
ragtime install --global
|
|
212
|
+
# View all usage documentation
|
|
213
|
+
ragtime usage
|
|
207
214
|
|
|
208
|
-
#
|
|
209
|
-
ragtime
|
|
215
|
+
# View specific sections
|
|
216
|
+
ragtime usage --section mcp # MCP server integration
|
|
217
|
+
ragtime usage --section cli # CLI workflow examples
|
|
218
|
+
ragtime usage --section workflows # Common AI workflow patterns
|
|
219
|
+
ragtime usage --section conventions # Convention checking
|
|
210
220
|
|
|
211
221
|
# Set up ghp-cli hooks
|
|
212
222
|
ragtime setup-ghp
|
|
@@ -249,6 +259,10 @@ code:
|
|
|
249
259
|
conventions:
|
|
250
260
|
files: [".ragtime/CONVENTIONS.md"]
|
|
251
261
|
also_search_memories: true
|
|
262
|
+
storage: auto # auto | file | memory | ask
|
|
263
|
+
default_file: ".ragtime/CONVENTIONS.md"
|
|
264
|
+
folder: ".ragtime/conventions/"
|
|
265
|
+
scan_docs_for_sections: ["docs/"]
|
|
252
266
|
```
|
|
253
267
|
|
|
254
268
|
## How Search Works
|
|
@@ -398,25 +412,60 @@ Sessions are stored in Redis, not cookies.
|
|
|
398
412
|
| `integration` | External service connections |
|
|
399
413
|
| `context` | Session handoff |
|
|
400
414
|
|
|
401
|
-
##
|
|
415
|
+
## AI Integration
|
|
402
416
|
|
|
403
|
-
|
|
417
|
+
Ragtime is designed to work seamlessly with AI agents via MCP tools. Run `ragtime usage` for comprehensive documentation on integration patterns.
|
|
404
418
|
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
419
|
+
### Key Patterns
|
|
420
|
+
|
|
421
|
+
**Memory Storage**: Use `remember` to capture architectural decisions, patterns, and context:
|
|
422
|
+
```
|
|
423
|
+
remember("Auth uses JWT with 15-min expiry", namespace="app", type="architecture", component="auth")
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
**Semantic Search**: Use `search` for finding relevant code and documentation:
|
|
427
|
+
```
|
|
428
|
+
search("how does authentication work", tiered=True) # Prioritizes curated knowledge
|
|
429
|
+
search("error handling", require_terms=["mobile", "dart"]) # Hybrid filtering
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
**Convention Checking**: Before PRs, verify code follows team standards:
|
|
433
|
+
```bash
|
|
434
|
+
ragtime check-conventions # Filtered to changed files
|
|
435
|
+
ragtime check-conventions --all # All conventions (for AI analysis)
|
|
436
|
+
```
|
|
437
|
+
|
|
438
|
+
**Handoff Context**: Save session state for continuity:
|
|
439
|
+
```
|
|
440
|
+
store_doc(content="Session summary...", namespace="branch-feature-123", doc_type="handoff")
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
### Building Custom Commands
|
|
444
|
+
|
|
445
|
+
Create project-specific slash commands in `.claude/commands/` that orchestrate ragtime tools:
|
|
446
|
+
|
|
447
|
+
```markdown
|
|
448
|
+
# .claude/commands/my-workflow.md
|
|
449
|
+
1. Search for relevant context: search("$ARGUMENTS", tiered=True)
|
|
450
|
+
2. Store any new insights: remember(...)
|
|
451
|
+
3. Check conventions before suggesting changes
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
The **real value is in the MCP tools** - combine them however fits your workflow.
|
|
416
455
|
|
|
417
456
|
## MCP Server
|
|
418
457
|
|
|
419
|
-
|
|
458
|
+
The MCP server is automatically configured during `ragtime init`. You can also set it up manually:
|
|
459
|
+
|
|
460
|
+
```bash
|
|
461
|
+
# Project-level: creates .mcp.json in current project
|
|
462
|
+
ragtime init
|
|
463
|
+
|
|
464
|
+
# Global: adds to ~/.claude/settings.json (works in any project)
|
|
465
|
+
ragtime init -G
|
|
466
|
+
```
|
|
467
|
+
|
|
468
|
+
Or add manually to `.mcp.json`:
|
|
420
469
|
|
|
421
470
|
```json
|
|
422
471
|
{
|
|
@@ -429,6 +478,8 @@ Add to your Claude config (`.mcp.json`):
|
|
|
429
478
|
}
|
|
430
479
|
```
|
|
431
480
|
|
|
481
|
+
The MCP server automatically finds the project root (`.ragtime` directory) even when Claude is started from a subdirectory.
|
|
482
|
+
|
|
432
483
|
Available tools:
|
|
433
484
|
- `remember` - Store a memory
|
|
434
485
|
- `search` - Semantic search (supports tiered mode and auto-extraction)
|
|
@@ -14,16 +14,6 @@ src/db.py
|
|
|
14
14
|
src/feedback.py
|
|
15
15
|
src/mcp_server.py
|
|
16
16
|
src/memory.py
|
|
17
|
-
src/commands/audit.md
|
|
18
|
-
src/commands/create-pr.md
|
|
19
|
-
src/commands/generate-docs.md
|
|
20
|
-
src/commands/handoff.md
|
|
21
|
-
src/commands/import-docs.md
|
|
22
|
-
src/commands/pr-graduate.md
|
|
23
|
-
src/commands/recall.md
|
|
24
|
-
src/commands/remember.md
|
|
25
|
-
src/commands/save.md
|
|
26
|
-
src/commands/start.md
|
|
27
17
|
src/indexers/__init__.py
|
|
28
18
|
src/indexers/code.py
|
|
29
19
|
src/indexers/docs.py
|