|
1 | 1 | # CHANGELOG |
2 | 2 |
|
| 3 | +## v0.15.1 (2025-10-13) |
| 4 | + |
| 5 | +### Performance Improvements |
| 6 | + |
| 7 | +- **#352**: Optimize sync/indexing for 43% faster performance |
| 8 | + ([`c0538ad`](https://github.com/basicmachines-co/basic-memory/commit/c0538ad2perf0d68a2a3604e255c3f2c42c5ed)) |
| 9 | + - Significant performance improvements to file synchronization and indexing operations |
| 10 | + - 43% reduction in sync time for large knowledge bases |
| 11 | + - Optimized database queries and file processing |
| 12 | + |
| 13 | +- **#350**: Optimize directory operations for 10-100x performance improvement |
| 14 | + ([`00b73b0`](https://github.com/basicmachines-co/basic-memory/commit/00b73b0d)) |
| 15 | + - Dramatic performance improvements for directory listing operations |
| 16 | + - 10-100x faster directory traversal depending on knowledge base size |
| 17 | + - Reduced memory footprint for large directory structures |
| 18 | + - Exclude null fields from directory endpoint responses for smaller payloads |
| 19 | + |
| 20 | +### Bug Fixes |
| 21 | + |
| 22 | +- **#355**: Update view_note and ChatGPT tools for Claude Desktop compatibility |
| 23 | + ([`2b7008d`](https://github.com/basicmachines-co/basic-memory/commit/2b7008d9)) |
| 24 | + - Fix view_note tool formatting for better Claude Desktop rendering |
| 25 | + - Update ChatGPT tool integration for improved compatibility |
| 26 | + - Enhanced artifact display in Claude Desktop interface |
| 27 | + |
| 28 | +- **#348**: Add permalink normalization to project lookups in deps.py |
| 29 | + ([`a09066e`](https://github.com/basicmachines-co/basic-memory/commit/a09066e0)) |
| 30 | + - Fix project lookup failures due to case sensitivity |
| 31 | + - Normalize permalinks consistently across project operations |
| 32 | + - Improve project switching reliability |
| 33 | + |
| 34 | +- **#345**: Project deletion failing with permalink normalization |
| 35 | + ([`be352ab`](https://github.com/basicmachines-co/basic-memory/commit/be352ab4)) |
| 36 | + - Fix project deletion errors related to permalink handling |
| 37 | + - Ensure proper cleanup of project resources |
| 38 | + - Improve error messages for deletion failures |
| 39 | + |
| 40 | +- **#341**: Correct ProjectItem.home property to return path instead of name |
| 41 | + ([`3e876a7`](https://github.com/basicmachines-co/basic-memory/commit/3e876a75)) |
| 42 | + - Fix ProjectItem.home to return correct project path |
| 43 | + - Resolve configuration issues with project paths |
| 44 | + - Improve project path resolution consistency |
| 45 | + |
| 46 | +- **#339**: Prevent nested project paths to avoid data conflicts |
| 47 | + ([`795e339`](https://github.com/basicmachines-co/basic-memory/commit/795e3393)) |
| 48 | + - Block creation of nested project paths that could cause data conflicts |
| 49 | + - Add validation to prevent project path hierarchy issues |
| 50 | + - Improve error messages for invalid project configurations |
| 51 | + |
| 52 | +- **#338**: Normalize paths to lowercase in cloud mode to prevent case collisions |
| 53 | + ([`07e304c`](https://github.com/basicmachines-co/basic-memory/commit/07e304ce)) |
| 54 | + - Fix path case sensitivity issues in cloud deployments |
| 55 | + - Normalize paths consistently across cloud operations |
| 56 | + - Prevent data loss from case-insensitive filesystem collisions |
| 57 | + |
| 58 | +- **#336**: Cloud mode path validation and sanitization (bmc-issue-103) |
| 59 | + ([`2a1c06d`](https://github.com/basicmachines-co/basic-memory/commit/2a1c06d9)) |
| 60 | + - Enhanced path validation for cloud deployments |
| 61 | + - Improved path sanitization to prevent security issues |
| 62 | + - Better error handling for invalid paths in cloud mode |
| 63 | + |
| 64 | +- **#332**: Cloud mode path validation and sanitization |
| 65 | + ([`7616b2b`](https://github.com/basicmachines-co/basic-memory/commit/7616b2bb)) |
| 66 | + - Additional cloud mode path fixes and improvements |
| 67 | + - Comprehensive path validation for cloud environments |
| 68 | + - Security enhancements for path handling |
| 69 | + |
| 70 | +### Features |
| 71 | + |
| 72 | +- **#344**: Async client context manager pattern for cloud consolidation (SPEC-16) |
| 73 | + ([`8d2e70c`](https://github.com/basicmachines-co/basic-memory/commit/8d2e70cf)) |
| 74 | + - Refactor async client to use context manager pattern |
| 75 | + - Improve resource management and cleanup |
| 76 | + - Enable better dependency injection for cloud deployments |
| 77 | + - Foundation for cloud platform consolidation |
| 78 | + |
| 79 | +- **#343**: Add SPEC-15 for configuration persistence via Tigris |
| 80 | + ([`53438d1`](https://github.com/basicmachines-co/basic-memory/commit/53438d1e)) |
| 81 | + - Design specification for persistent configuration storage |
| 82 | + - Foundation for cloud configuration management |
| 83 | + - Tigris S3-compatible storage integration planning |
| 84 | + |
| 85 | +- **#334**: Introduce BASIC_MEMORY_PROJECT_ROOT for path constraints |
| 86 | + ([`ccc4386`](https://github.com/basicmachines-co/basic-memory/commit/ccc43866)) |
| 87 | + - Add environment variable for constraining project paths |
| 88 | + - Improve security by limiting project creation locations |
| 89 | + - Better control over project directory structure |
| 90 | + |
| 91 | +### Documentation |
| 92 | + |
| 93 | +- **#335**: v0.15.0 assistant guide updates |
| 94 | + ([`c6f93a0`](https://github.com/basicmachines-co/basic-memory/commit/c6f93a02)) |
| 95 | + - Update AI assistant guide for v0.15.0 features |
| 96 | + - Improve documentation for new MCP tools |
| 97 | + - Better examples and usage patterns |
| 98 | + |
| 99 | +- **#339**: Add tool use documentation to write_note for root folder usage |
| 100 | + ([`73202d1`](https://github.com/basicmachines-co/basic-memory/commit/73202d1a)) |
| 101 | + - Document how to use empty string for root folder in write_note |
| 102 | + - Clarify folder parameter usage |
| 103 | + - Improve tool documentation clarity |
| 104 | + |
| 105 | +- Fix link in ai_assistant_guide resource |
| 106 | + ([`2a1c06d`](https://github.com/basicmachines-co/basic-memory/commit/2a1c06d9)) |
| 107 | + - Correct broken documentation links |
| 108 | + - Improve resource accessibility |
| 109 | + |
| 110 | +### Refactoring |
| 111 | + |
| 112 | +- Add SPEC-17 and SPEC-18 documentation |
| 113 | + ([`962d88e`](https://github.com/basicmachines-co/basic-memory/commit/962d88ea)) |
| 114 | + - New specification documents for future features |
| 115 | + - Architecture planning and design documentation |
| 116 | + |
| 117 | +### Breaking Changes |
| 118 | + |
| 119 | +**None** - This release maintains full backward compatibility with v0.15.0 |
| 120 | + |
| 121 | +### Migration Guide |
| 122 | + |
| 123 | +No manual migration required. Upgrade with: |
| 124 | + |
| 125 | +```bash |
| 126 | +# Update via uv |
| 127 | +uv tool upgrade basic-memory |
| 128 | + |
| 129 | +# Or install fresh |
| 130 | +uv tool install basic-memory |
| 131 | +``` |
| 132 | + |
| 133 | +**What's Fixed:** |
| 134 | +- Significant performance improvements (43% faster sync, 10-100x faster directory operations) |
| 135 | +- Multiple cloud deployment stability fixes |
| 136 | +- Project path validation and normalization issues resolved |
| 137 | +- Better Claude Desktop and ChatGPT integration |
| 138 | + |
| 139 | +**What's New:** |
| 140 | +- Context manager pattern for async clients (foundation for cloud consolidation) |
| 141 | +- BASIC_MEMORY_PROJECT_ROOT environment variable for path constraints |
| 142 | +- Enhanced cloud mode path handling and security |
| 143 | +- SPEC-15 and SPEC-16 architecture documentation |
| 144 | + |
| 145 | +### Installation |
| 146 | + |
| 147 | +```bash |
| 148 | +# Latest stable release |
| 149 | +uv tool install basic-memory |
| 150 | + |
| 151 | +# Update existing installation |
| 152 | +uv tool upgrade basic-memory |
| 153 | + |
| 154 | +# Docker |
| 155 | +docker pull ghcr.io/basicmachines-co/basic-memory:v0.15.1 |
| 156 | +``` |
| 157 | + |
3 | 158 | ## v0.15.0 (2025-10-04) |
4 | 159 |
|
5 | 160 | ### Critical Bug Fixes |
|
0 commit comments