You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: Add comprehensive cloud mount CLI commands and documentation
This commit implements SPEC-7 Phase 4 by adding local file access capabilities
to the Basic Memory Cloud CLI, enabling users to mount their cloud files locally
for real-time editing.
New features:
- Cloud mount setup with automatic rclone installation
- Mount/unmount/status commands with three performance profiles
- Cross-platform rclone installer with package manager fallbacks
- Mount configuration management with tenant-specific credentials
- Comprehensive documentation with examples and troubleshooting
Mount profiles:
- fast: 5s sync for active development
- balanced: 10-15s sync (recommended)
- safe: 15s+ sync with conflict detection
Technical implementation:
- Uses rclone NFS mount (no FUSE dependencies)
- Tigris object storage with scoped credentials
- Bidirectional sync with configurable cache settings
- Process management and cleanup
Fixes Python module conflict by moving cloud.py commands to cloud/core_commands.py
to resolve typer CLI loading issues with cloud.py file vs cloud/ directory.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
Signed-off-by: phernandez <[email protected]>
Copy file name to clipboardExpand all lines: docs/cloud-cli.md
+166-3Lines changed: 166 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,14 @@
1
1
# Basic Memory Cloud CLI Guide
2
2
3
-
The Basic Memory Cloud CLI provides commands for interacting with Basic Memory Cloud instances, including authentication, project management, and file synchronization. This guide covers installation, configuration, and usage of the cloud features.
3
+
The Basic Memory Cloud CLI provides commands for interacting with Basic Memory Cloud instances, including authentication, project management, file synchronization, and local file access. This guide covers installation, configuration, and usage of the cloud features.
4
4
5
5
## Overview
6
6
7
7
The cloud CLI enables you to:
8
8
- Authenticate with Basic Memory Cloud using OAuth
9
9
- List and create projects on cloud instances
10
10
- Upload local files and directories to cloud projects via WebDAV
11
+
- Mount cloud files locally for real-time editing with rclone
11
12
- Check the health status of cloud instances
12
13
- Automatically filter uploads using gitignore patterns
13
14
@@ -141,6 +142,136 @@ Uploading 23 file(s) to project 'my-project' on https://cloud.basicmemory.com...
141
142
Successfully uploaded 23 file(s)!
142
143
```
143
144
145
+
## Local File Access
146
+
147
+
Basic Memory Cloud supports mounting your cloud files locally using rclone, enabling real-time editing with your favorite text editor or IDE. Changes made locally are automatically synchronized to the cloud.
148
+
149
+
### Setup
150
+
151
+
Before mounting files, you need to set up the local access system:
152
+
153
+
```bash
154
+
bm cloud setup
155
+
```
156
+
157
+
This command will:
158
+
1. Check if rclone is installed (and install it if needed)
159
+
2. Retrieve your tenant information from the cloud
160
+
3. Generate secure, scoped credentials for your tenant
161
+
4. Configure rclone with your tenant's storage settings
162
+
5. Display instructions for mounting your files
163
+
164
+
### Mounting Files
165
+
166
+
Mount your cloud files to a local directory:
167
+
168
+
```bash
169
+
# Mount with default (balanced) profile
170
+
bm cloud mount
171
+
172
+
# Mount with specific profile
173
+
bm cloud mount --profile fast
174
+
bm cloud mount --profile balanced
175
+
bm cloud mount --profile safe
176
+
```
177
+
178
+
#### Mount Profiles
179
+
180
+
Different profiles optimize for different use cases:
181
+
182
+
-**fast**: Ultra-fast development (5s sync, higher bandwidth)
183
+
- Cache time: 5s, Poll interval: 3s
184
+
- Best for: Active development, frequent file changes
185
+
186
+
-**balanced**: Fast development (10-15s sync, recommended)
187
+
- Cache time: 10s, Poll interval: 5s
188
+
- Best for: General use, good balance of speed and reliability
189
+
190
+
-**safe**: Conflict-aware mount with backup (15s+ sync)
191
+
- Cache time: 15s, Poll interval: 10s
192
+
- Includes conflict detection and backup functionality
193
+
- Best for: Collaborative editing, important documents
0 commit comments