|
| 1 | +# Track Skill |
| 2 | + |
| 3 | +Start `boxel track` to monitor local file changes and create checkpoints automatically. |
| 4 | + |
| 5 | +## When to Use Track |
| 6 | + |
| 7 | +Use **track** when you're editing files locally (in IDE, with AI agent, etc.) and want automatic backups: |
| 8 | +- Working in VS Code, Cursor, or other IDE |
| 9 | +- AI agent is editing files |
| 10 | +- You want checkpoint history of your work |
| 11 | + |
| 12 | +**Track vs Watch:** |
| 13 | +| Command | Symbol | Direction | Purpose | |
| 14 | +|---------|--------|-----------|---------| |
| 15 | +| `track` | ⇆ | Local edits → Checkpoints | Backup your work as you edit | |
| 16 | +| `watch` | ⇅ | Server → Local | Pull external changes from Boxel UI | |
| 17 | + |
| 18 | +## Commands |
| 19 | + |
| 20 | +```bash |
| 21 | +# Start tracking (default: 3s debounce, 10s min interval) |
| 22 | +boxel track . |
| 23 | + |
| 24 | +# Custom timing (5s debounce, 30s between checkpoints) |
| 25 | +boxel track . -d 5 -i 30 |
| 26 | + |
| 27 | +# Quiet mode (only show checkpoints) |
| 28 | +boxel track . -q |
| 29 | + |
| 30 | +# Stop all track/watch processes |
| 31 | +boxel stop |
| 32 | +``` |
| 33 | + |
| 34 | +## The Track → Sync Workflow |
| 35 | + |
| 36 | +**IMPORTANT:** Track only creates local checkpoints. To push changes to the Boxel server: |
| 37 | + |
| 38 | +```bash |
| 39 | +# 1. Track creates checkpoints as you edit |
| 40 | +boxel track . |
| 41 | + |
| 42 | +# 2. When ready to push to server, sync with --prefer-local |
| 43 | +boxel sync . --prefer-local |
| 44 | +``` |
| 45 | + |
| 46 | +Track does NOT automatically sync to the server. This is intentional - it lets you: |
| 47 | +- Work offline with local backups |
| 48 | +- Batch multiple edits before pushing |
| 49 | +- Review changes before they go live |
| 50 | + |
| 51 | +## Context Detection |
| 52 | + |
| 53 | +When invoked, consider: |
| 54 | + |
| 55 | +### Standard Development (3s debounce, 10s interval) |
| 56 | +- Normal editing workflow |
| 57 | +- Balanced between checkpoint frequency and overhead |
| 58 | + |
| 59 | +### Fast Iteration (2s debounce, 5s interval) |
| 60 | +- Rapid prototyping |
| 61 | +- User says "track closely" or "capture everything" |
| 62 | + |
| 63 | +### Background Tracking (5s debounce, 30s interval) |
| 64 | +- Long editing sessions |
| 65 | +- User says "just backup" or "light tracking" |
| 66 | + |
| 67 | +## Response Format |
| 68 | + |
| 69 | +When invoked: |
| 70 | +1. Confirm workspace directory |
| 71 | +2. Start track with appropriate settings |
| 72 | +3. **Remind user to sync when ready to push changes** |
| 73 | + |
| 74 | +Example: |
| 75 | +``` |
| 76 | +Starting track in the current workspace (3s debounce, 10s interval). |
| 77 | +Checkpoints will be created automatically as you save files. |
| 78 | +
|
| 79 | +Remember: Track creates LOCAL checkpoints only. |
| 80 | +When ready to push changes to Boxel server: |
| 81 | + boxel sync . --prefer-local |
| 82 | +
|
| 83 | +Use Ctrl+C to stop tracking, or `boxel stop` from another terminal. |
| 84 | +``` |
0 commit comments