Skip to content

docs: Add 'minimal' scope to backup command documentation #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KHAEntertainment merged 3 commits into from
Mar 26, 2026
Merged

docs: Add 'minimal' scope to backup command documentation #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
47d007b
docs: Add 'minimal' scope to backup command documentation
KHAEntertainment Mar 22, 2026
961d949
fix: apply CodeRabbit auto-fixes
coderabbitai[bot] Mar 26, 2026
71bbbb4
Update pyproject.toml
KHAEntertainment Mar 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,24 @@ Create a backup of OpenClaw configuration.
```

**Parameters:**
- `--scope <scope>` - Backup scope: `config`, `config+session`, `config+session+workspace`
- `--scope <scope>` - Backup scope: `config`, `config+session`, `config+session+workspace`, `minimal`
- `--source <source>` - Backup source: `direct` or `native`
- `--reason <reason>` - Optional reason for the backup

**Scope behavior:**

| Scope | Description |
|-------|-------------|
| `config` | Configuration only (openclaw.json, credentials) |
| `config+session` | Configuration + sessions directory |
| `config+session+workspace` | Full backup including workspace |
| `minimal` | Metadata-only checkpoint (stores backup ID, timestamp, scope, reason in SQLite; no file contents) — intended as a lightweight marker for tracking operations rather than a restorable backup |

**Source behavior:**
- `direct` reads OpenClaw files directly into OCBS chunk storage
- `native` runs `openclaw backup create`, extracts the archive, then imports it into OCBS chunk storage
- If the native CLI is unavailable, OCBS falls back to the direct source

**Scope notes:**
- `config` backs up OpenClaw configuration and credentials.
- `config+session` adds OpenClaw session state.
- `config+session+workspace` includes the full workspace.

### restore
Restore from a backup or checkpoint.

Expand Down Expand Up @@ -223,4 +227,4 @@ ocbs integration setup-heartbeat --enabled --timeout 30
This was fixed in v0.1.0 with batch processing. Restore now handles large backups (13,000+ files) without hitting file descriptor limits.

### Schema mismatch
The `serve_records` table uses `checkpoint_id` (not `backup_id`) to match checkpoint table schema.
The `serve_records` table uses `checkpoint_id` (not `backup_id`) to match checkpoint table schema.
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ dependencies = [
]

[project.optional-dependencies]
clawhub = "clawhub>=0.1.0"
clawhub = ["clawhub>=0.1.0"]

[project.scripts]
ocbs = "ocbs.cli:main"
Expand Down