Skip to content

Commit 0aa7bb8

Browse files
committed
docs: explain cloud project data purge
Signed-off-by: phernandez <paul@basicmachines.co>
1 parent bd3a795 commit 0aa7bb8

3 files changed

Lines changed: 30 additions & 3 deletions

File tree

content/03.cloud/01.cloud-guide.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,28 @@ The full command walkthrough — sign-in options, API keys, workspaces, routing,
104104

105105
---
106106

107+
## Remove a Cloud Project and Its Data
108+
109+
Cloud project removal keeps note files by default. Use `--delete-notes` when you also want to purge the project's active cloud storage:
110+
111+
```bash
112+
# Stop tracking the project, but retain its cloud files
113+
bm project remove research --cloud
114+
115+
# Remove the project and purge every object under its cloud storage prefix
116+
bm project remove research --cloud --delete-notes
117+
```
118+
119+
The `--cloud` flag is optional when `research` is already configured as a cloud-routed project. Hosted deletion is asynchronous: the project disappears from normal listings when deletion is accepted, then a background job removes its database rows. With `--delete-notes`, that job also removes indexed and unindexed objects under the project's exact storage prefix.
120+
121+
The MCP `delete_project` tool provides the same behavior with `delete_notes=true`. Its response reports the pending deletion status and background job ID.
122+
123+
::warning
124+
Deleting with `--delete-notes` is irreversible for active project storage. Existing point-in-time snapshots may still contain historical copies until those snapshots are deleted or expire.
125+
::
126+
127+
---
128+
107129
## Upload Files to Cloud
108130

109131
::note{icon="i-lucide-upload"}

content/10.reference/1.cli-reference.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ bm project add research ~/Documents/research --default
244244

245245
### `bm project remove`
246246

247-
Remove a project from configuration.
247+
Remove a project. Files are retained by default; pass `--delete-notes` to remove them too.
248248

249249
```bash
250250
bm project remove research
@@ -253,10 +253,12 @@ bm project remove research --delete-notes
253253

254254
| Flag | Description |
255255
|------|-------------|
256-
| `--delete-notes` | Also delete project files from disk |
256+
| `--delete-notes` | Also delete project files: local files for a local project, or all active objects under the project prefix for a cloud project |
257257
| `--local` | Force local routing |
258258
| `--cloud` | Force cloud routing |
259259

260+
Cloud deletion is accepted asynchronously. Without `--delete-notes`, the project is removed from the hosted database but its cloud files remain. With `--delete-notes`, the background job purges indexed and unindexed objects under the exact project storage prefix before completing the hard delete. Existing cloud snapshots follow their own retention and deletion lifecycle.
261+
260262
### `bm project default`
261263

262264
Set the default project used as fallback when no project is specified.

content/10.reference/2.mcp-tools-reference.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,13 +202,16 @@ Create a project.
202202

203203
### `delete_project`
204204

205-
Remove a project from Basic Memory config.
205+
Remove a project from Basic Memory. Note files are retained by default.
206206

207207
| Parameter | Type | Required | Notes |
208208
|---|---|---|---|
209209
| `project_name` | string | Yes | Name of the project to remove |
210+
| `delete_notes` | boolean | No | Default `false`. Set to `true` to delete local files or purge every active cloud object under the project's storage prefix |
210211
| `workspace` | string | No | Cloud workspace selector when deleting from a specific workspace |
211212

213+
Hosted deletion is asynchronous. The tool response reports the project deletion status and background job ID when the cloud backend queues the work. With `delete_notes=false`, cloud objects are retained even though the project and its indexed database rows are removed. With `delete_notes=true`, the background job removes indexed and unindexed objects under the exact project prefix before completing the hard delete. Existing snapshots follow their separate retention lifecycle.
214+
212215
### `list_directory`
213216

214217
List directory contents with optional depth and glob filter.

0 commit comments

Comments
 (0)