Skip to content

Commit b0093d9

Browse files
committed
update docs wip
1 parent e086663 commit b0093d9

File tree

7 files changed

+687
-11
lines changed

7 files changed

+687
-11
lines changed

src/config/navigation.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ export const navConfig = {
4444
{ title: 'MCP Tools Reference', href: '/guides/mcp-tools-reference' },
4545
{ title: 'Canvas', href: '/guides/canvas' },
4646
{ title: 'CLI Reference', href: '/guides/cli-reference' },
47+
{ title: 'Cloud CLI', href: '/guides/cloud-cli' },
4748
{ title: 'AI Assistant Guide', href: '/guides/ai-assistant-guide' },
4849
],
4950
},

src/pages/getting-started.mdx

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,16 @@ The fastest way to get started with Basic Memory:
2222

2323
You can install Basic Memory using `uv`, an extremely fast Python package and project manager, written in Rust.
2424

25+
**Requirements**: Python 3.13 or higher
26+
2527
You can install `uv` from [astral's website ↗️](https://docs.astral.sh/uv/getting-started/installation/). After installing `uv` you can install Basic Memory with the command:
2628

2729
```bash
2830
uv tool install basic-memory
2931
```
3032
<Warning>
3133
- **`uv` must be installed and available in your system PATH**. Claude Desktop runs in its own isolated environment and needs `uv` to manage dependencies.
34+
- **Python 3.13+ required**. Check your version with `python --version`.
3235
</Warning>
3336

3437
### Homebrew Installation (macOS)
@@ -71,15 +74,6 @@ Edit your Claude Desktop config, located at:
7174

7275
![tools-menu](/attachments/claude-tools-menu.png)
7376

74-
### Install Basic Memory Pre-releases (For Daring Adventurers)
75-
76-
```bash
77-
# Beta releases (new features, testing)
78-
pip install basic-memory --pre
79-
80-
# Development builds (latest changes)
81-
pip install basic-memory --pre --force-reinstall
82-
```
8377

8478
### Choosing Where Your Notes Are Saved
8579

src/pages/guides/cli-reference.mdx

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,87 @@ import { Card, CardGroup, Info, Warning, Note, Tip, Accordion, AccordionItem, St
88

99
## Core Commands
1010

11+
### cloud
12+
13+
Manage cloud authentication and synchronization. Requires active subscription.
14+
15+
```bash
16+
# Authenticate with cloud service
17+
basic-memory cloud login
18+
19+
# Logout and clear credentials
20+
basic-memory cloud logout
21+
22+
# Bidirectional sync with cloud
23+
basic-memory cloud sync
24+
25+
# Verify cloud storage integrity
26+
basic-memory cloud check
27+
28+
# Mount cloud storage locally
29+
basic-memory cloud mount
30+
31+
# Unmount cloud storage
32+
basic-memory cloud unmount
33+
```
34+
35+
#### Cloud Login
36+
37+
Authenticate with cloud service using JWT tokens:
38+
39+
```bash
40+
basic-memory cloud login
41+
```
42+
43+
Opens browser for authentication. Stores credentials in `~/.basic-memory/cloud_auth.json`.
44+
45+
#### Cloud Sync
46+
47+
Synchronize local files with cloud storage using rclone bisync:
48+
49+
```bash
50+
# Sync current project
51+
basic-memory cloud sync
52+
53+
# Sync specific project
54+
basic-memory --project=work cloud sync
55+
```
56+
57+
Performs bidirectional synchronization with conflict detection.
58+
59+
#### Cloud Mount
60+
61+
Mount cloud storage as local filesystem:
62+
63+
```bash
64+
# Mount with default (balanced) profile
65+
basic-memory cloud mount
66+
67+
# Mount with specific performance profile
68+
basic-memory cloud mount --profile fast
69+
basic-memory cloud mount --profile balanced
70+
basic-memory cloud mount --profile safe
71+
```
72+
73+
Performance profiles:
74+
- `fast`: 5s cache, optimized for speed
75+
- `balanced`: 10-15s cache (default)
76+
- `safe`: 15s+ cache, optimized for data integrity
77+
78+
#### Cloud Check
79+
80+
Verify integrity of cloud storage:
81+
82+
```bash
83+
basic-memory cloud check
84+
```
85+
86+
Validates checksums and file consistency between local and cloud.
87+
88+
<Warning>
89+
Cloud commands require an active subscription. Use `basic-memory cloud login` to authenticate.
90+
</Warning>
91+
1192
### import
1293

1394
Imports external knowledge sources with support for project targeting:

0 commit comments

Comments
 (0)