Skip to content
This repository was archived by the owner on Jun 4, 2026. It is now read-only.

Commit d059764

Browse files
christseclaude
andcommitted
Update README with multi-realm watch, milestone, and share/gather docs
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent c8074ef commit d059764

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,34 @@ boxel sync . --prefer-remote # Keep remote on conflicts
8585
```bash
8686
boxel watch . # Monitor server, auto-checkpoint
8787
boxel watch . -i 5 # Check every 5 seconds
88+
boxel watch # Watch all configured realms
89+
boxel watch . ./other-realm # Watch multiple realms simultaneously
8890
```
8991

92+
### Multi-Realm Configuration
93+
When working with multiple realms (e.g., code in one, data in another):
94+
95+
```bash
96+
boxel realms # List configured realms
97+
boxel realms --init # Create .boxel-workspaces.json
98+
boxel realms --add ./code --purpose "Card definitions" --patterns "*.gts" --default
99+
boxel realms --add ./data --purpose "Content instances" --card-types "BlogPost,Product"
100+
boxel realms --llm # Output guidance for file placement
101+
```
102+
103+
Then `boxel watch` monitors all configured realms with independent checkpointing.
104+
90105
### View & Restore History
91106
```bash
92107
boxel history . # View checkpoints
93108
boxel history . -r 3 # Restore to checkpoint #3
109+
boxel milestone . 1 -n "Before refactor" # Mark important checkpoint
110+
```
111+
112+
### Share & Gather (GitHub Workflow)
113+
```bash
114+
boxel share . -t /path/to/repo -b branch-name # Share to GitHub repo
115+
boxel gather . -s /path/to/repo # Pull from GitHub repo
94116
```
95117

96118
### Manage Skills

0 commit comments

Comments
 (0)