Skip to content

Commit 782cb2d

Browse files
committed
update README.md and CLAUDE.md docs
Signed-off-by: phernandez <paul@basicmachines.co>
1 parent 56c875f commit 782cb2d

2 files changed

Lines changed: 50 additions & 17 deletions

File tree

CLAUDE.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -97,15 +97,26 @@ See the [README.md](README.md) file for a project overview.
9797

9898
**Content Management:**
9999
- `write_note(title, content, folder, tags)` - Create/update markdown notes with semantic observations and relations
100-
- `read_note(identifier, page, page_size)` - Read notes by title, permalink, or memory:// URL with knowledge graph
101-
awareness
102-
- `read_file(path)` - Read raw file content (text, images, binaries) without knowledge graph processing
100+
- `read_note(identifier, page, page_size)` - Read notes by title, permalink, or memory:// URL with knowledge graph awareness
101+
- `edit_note(identifier, operation, content)` - Edit notes incrementally (append, prepend, find/replace, section replace)
102+
- `move_note(identifier, destination_path)` - Move notes with database consistency and search reindexing
103+
- `view_note(identifier)` - Display notes as formatted artifacts for better readability in Claude Desktop
104+
- `read_content(path)` - Read raw file content (text, images, binaries) without knowledge graph processing
105+
- `delete_note(identifier)` - Delete notes from knowledge base
106+
107+
**Project Management:**
108+
- `list_memory_projects()` - List all available projects with status indicators
109+
- `switch_project(project_name)` - Switch to different project context during conversations
110+
- `get_current_project()` - Show currently active project with statistics
111+
- `create_memory_project(name, path, set_default)` - Create new Basic Memory projects
112+
- `delete_project(name)` - Delete projects from configuration and database
113+
- `set_default_project(name)` - Set default project in config
114+
- `sync_status()` - Check file synchronization status and background operations
103115

104116
**Knowledge Graph Navigation:**
105-
- `build_context(url, depth, timeframe)` - Navigate the knowledge graph via memory:// URLs for conversation
106-
continuity
107-
- `recent_activity(type, depth, timeframe)` - Get recently updated information with specified timeframe (e.g., "
108-
1d", "1 week")
117+
- `build_context(url, depth, timeframe)` - Navigate the knowledge graph via memory:// URLs for conversation continuity
118+
- `recent_activity(type, depth, timeframe)` - Get recently updated information with specified timeframe (e.g., "1d", "1 week")
119+
- `list_directory(dir_name, depth, file_name_glob)` - List directory contents with filtering and depth control
109120

110121
**Search & Discovery:**
111122
- `search_notes(query, page, page_size)` - Full-text search across all content with filtering options
@@ -212,13 +223,21 @@ Basic Memory uses `uv-dynamic-versioning` for automatic version management based
212223
- Users install with: `pip install basic-memory --pre`
213224
- Use for milestone testing before stable release
214225

215-
#### Stable Releases (Manual)
216-
- Create version tag: `git tag v0.13.0 && git push origin v0.13.0`
217-
- Automatically builds, creates GitHub release, and publishes to PyPI
226+
#### Stable Releases (Automated)
227+
- Use the automated release system: `just release v0.13.0`
228+
- Includes comprehensive quality checks (lint, format, type-check, tests)
229+
- Automatically updates version in `__init__.py`
230+
- Creates git tag and pushes to GitHub
231+
- Triggers GitHub Actions workflow for PyPI publication
218232
- Users install with: `pip install basic-memory`
219233

234+
**Manual method (legacy):**
235+
- Create version tag: `git tag v0.13.0 && git push origin v0.13.0`
236+
220237
### For Development
221-
- No manual version bumping required
222-
- Versions automatically derived from git tags
223-
- `pyproject.toml` uses `dynamic = ["version"]`
224-
- `__init__.py` dynamically reads version from package metadata
238+
- **Automated releases**: Use `just release v0.13.x` for stable releases and `just beta v0.13.0b1` for beta releases
239+
- **Quality gates**: All releases require passing lint, format, type-check, and test suites
240+
- **Version management**: Versions automatically derived from git tags via `uv-dynamic-versioning`
241+
- **Configuration**: `pyproject.toml` uses `dynamic = ["version"]`
242+
- **Release automation**: `__init__.py` updated automatically during release process
243+
- **CI/CD**: GitHub Actions handles building and PyPI publication

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,7 @@ Memory for Claude Desktop:
6161
npx -y @smithery/cli install @basicmachines-co/basic-memory --client claude
6262
```
6363

64-
This installs and configures Basic Memory without requiring manual edits to the Claude Desktop configuration file. The
65-
Smithery server hosts the MCP server component, while your data remains stored locally as Markdown files.
64+
This installs and configures Basic Memory without requiring manual edits to the Claude Desktop configuration file. Note: The Smithery installation uses their hosted MCP server, while your data remains stored locally as Markdown files.
6665

6766
### Glama.ai
6867

@@ -153,7 +152,8 @@ The note embeds semantic content and links to other topics via simple Markdown f
153152

154153
3. You see this file on your computer in real time in the current project directory (default `~/$HOME/basic-memory`).
155154

156-
- Realtime sync is enabled by default with the v0.12.0 version
155+
- Realtime sync is enabled by default starting with v0.12.0
156+
- Project switching during conversations is supported starting with v0.13.0
157157

158158
4. In a chat with the LLM, you can reference a topic:
159159

@@ -351,10 +351,20 @@ Basic Memory will sync the files in your project in real time if you make manual
351351
```
352352
write_note(title, content, folder, tags) - Create or update notes
353353
read_note(identifier, page, page_size) - Read notes by title or permalink
354+
edit_note(identifier, operation, content) - Edit notes incrementally (append, prepend, find/replace)
355+
move_note(identifier, destination_path) - Move notes with database consistency
356+
view_note(identifier) - Display notes as formatted artifacts for better readability
354357
build_context(url, depth, timeframe) - Navigate knowledge graph via memory:// URLs
355358
search_notes(query, page, page_size) - Search across your knowledge base
356359
recent_activity(type, depth, timeframe) - Find recently updated information
357360
canvas(nodes, edges, title, folder) - Generate knowledge visualizations
361+
list_memory_projects() - List all available projects with status
362+
switch_project(project_name) - Switch to different project context
363+
get_current_project() - Show current project and statistics
364+
create_memory_project(name, path, set_default) - Create new projects
365+
delete_project(name) - Delete projects from configuration
366+
set_default_project(name) - Set default project
367+
sync_status() - Check file synchronization status
358368
```
359369

360370
5. Example prompts to try:
@@ -365,6 +375,10 @@ canvas(nodes, edges, title, folder) - Generate knowledge visualizations
365375
"Create a canvas visualization of my project components"
366376
"Read my notes on the authentication system"
367377
"What have I been working on in the past week?"
378+
"Switch to my work-notes project"
379+
"List all my available projects"
380+
"Edit my coffee brewing note to add a new technique"
381+
"Move my old meeting notes to the archive folder"
368382
```
369383

370384
## Futher info

0 commit comments

Comments
 (0)