@@ -24,6 +24,8 @@ See the [README.md](README.md) file for a project overview.
2424- Create db migration: ` make migration m="Your migration message" `
2525- Run development MCP Inspector: ` make run-inspector `
2626
27+ ** Note:** Project supports Python 3.10+
28+
2729### Code Style Guidelines
2830
2931- Line length: 100 characters max
@@ -80,6 +82,7 @@ See the [README.md](README.md) file for a project overview.
8082
8183### Basic Memory Commands
8284
85+ ** Local Commands:**
8386- Sync knowledge: ` basic-memory sync ` or ` basic-memory sync --watch `
8487- Import from Claude: ` basic-memory import claude conversations `
8588- Import from ChatGPT: ` basic-memory import chatgpt `
@@ -89,24 +92,41 @@ See the [README.md](README.md) file for a project overview.
8992 - Guide: ` basic-memory tools basic-memory-guide `
9093 - Continue: ` basic-memory tools continue-conversation --topic="search" `
9194
95+ ** Cloud Commands (requires subscription):**
96+ - Authenticate: ` basic-memory cloud login `
97+ - Logout: ` basic-memory cloud logout `
98+ - Bidirectional sync: ` basic-memory cloud sync `
99+ - Integrity check: ` basic-memory cloud check `
100+ - Mount cloud storage: ` basic-memory cloud mount `
101+ - Unmount cloud storage: ` basic-memory cloud unmount `
102+
92103### MCP Capabilities
93104
94105- Basic Memory exposes these MCP tools to LLMs:
95106
96107 ** Content Management:**
97108 - ` write_note(title, content, folder, tags) ` - Create/update markdown notes with semantic observations and relations
98- - ` read_note(identifier, page, page_size) ` - Read notes by title, permalink, or memory:// URL with knowledge graph
99- awareness
100- - ` read_file(path) ` - Read raw file content (text, images, binaries) without knowledge graph processing
109+ - ` read_note(identifier, page, page_size) ` - Read notes by title, permalink, or memory:// URL with knowledge graph awareness
110+ - ` read_content(path) ` - Read raw file content (text, images, binaries) without knowledge graph processing
111+ - ` view_note(identifier, page, page_size) ` - View notes as formatted artifacts for better readability
112+ - ` edit_note(identifier, operation, content) ` - Edit notes incrementally (append, prepend, find/replace, replace_section)
113+ - ` move_note(identifier, destination_path) ` - Move notes to new locations, updating database and maintaining links
114+ - ` delete_note(identifier) ` - Delete notes from the knowledge base
101115
102116 ** Knowledge Graph Navigation:**
103- - ` build_context(url, depth, timeframe) ` - Navigate the knowledge graph via memory:// URLs for conversation
104- continuity
105- - ` recent_activity(type, depth, timeframe) ` - Get recently updated information with specified timeframe (e.g., "
106- 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) ` - Browse directory contents with filtering and depth control
107120
108121 ** Search & Discovery:**
109- - ` search(query, page, page_size) ` - Full-text search across all content with filtering options
122+ - ` search_notes(query, page, page_size, search_type, types, entity_types, after_date) ` - Full-text search across all content with advanced filtering options
123+
124+ ** Project Management:**
125+ - ` list_memory_projects() ` - List all available projects with their status
126+ - ` create_memory_project(project_name, project_path, set_default) ` - Create new Basic Memory projects
127+ - ` delete_project(project_name) ` - Delete a project from configuration
128+ - ` get_current_project() ` - Get current project information and stats
129+ - ` sync_status() ` - Check file synchronization and background operation status
110130
111131 ** Visualization:**
112132 - ` canvas(nodes, edges, title, folder) ` - Generate Obsidian canvas files for knowledge graph visualization
@@ -118,6 +138,34 @@ See the [README.md](README.md) file for a project overview.
118138 - ` recent_activity(timeframe) ` - View recently changed items with formatted output
119139 - ` json_canvas_spec() ` - Full JSON Canvas specification for Obsidian visualization
120140
141+ ### Cloud Features (v0.15.0+)
142+
143+ Basic Memory now supports cloud synchronization and storage (requires active subscription):
144+
145+ ** Authentication:**
146+ - JWT-based authentication with subscription validation
147+ - Secure session management with token refresh
148+ - Support for multiple cloud projects
149+
150+ ** Bidirectional Sync:**
151+ - rclone bisync integration for two-way synchronization
152+ - Conflict resolution and integrity verification
153+ - Real-time sync with change detection
154+ - Mount/unmount cloud storage for direct file access
155+
156+ ** Cloud Project Management:**
157+ - Create and manage projects in the cloud
158+ - Toggle between local and cloud modes
159+ - Per-project sync configuration
160+ - Subscription-based access control
161+
162+ ** Security & Performance:**
163+ - Removed .env file loading for improved security
164+ - .gitignore integration (respects gitignored files)
165+ - WAL mode for SQLite performance
166+ - Background relation resolution (non-blocking startup)
167+ - API performance optimizations (SPEC-11)
168+
121169## AI-Human Collaborative Development
122170
123171Basic Memory emerged from and enables a new kind of development process that combines human and AI capabilities. Instead
@@ -168,4 +216,4 @@ With GitHub integration, the development workflow includes:
1682163 . ** Branch management** - Claude can create feature branches for implementations
1692174 . ** Documentation maintenance** - Claude can keep documentation updated as the code evolves
170218
171- This level of integration represents a new paradigm in AI-human collaboration, where the AI assistant becomes a full-fledged team member rather than just a tool for generating code snippets.
219+ This level of integration represents a new paradigm in AI-human collaboration, where the AI assistant becomes a full-fledged team member rather than just a tool for generating code snippets.
0 commit comments