Skip to content

fix: allow minimal scope in CLI commands #24

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 28, 2026
Merged

fix: allow minimal scope in CLI commands #24

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
78a0864
fix: add 'minimal' scope to CLI options
Mar 27, 2026
a9a742c
fix: add SCOPE_CHOICES constant, guard minimal+native combo, fail fas…
Mar 28, 2026
e4b0bc6
chore: trigger re-review after fixes
Mar 28, 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
25 changes: 21 additions & 4 deletions src/ocbs/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
from .core import BackupSource, BackupScope, OCBSCore
from .serve import format_restore_message, start_restore_server

# Shared scope choices to prevent drift
SCOPE_CHOICES = ['minimal', 'config', 'config+session', 'config+session+workspace']


@click.group()
@click.option('--state-dir', type=click.Path(exists=False, file_okay=False, dir_okay=True),
Expand All @@ -23,7 +26,7 @@ def main(ctx, state_dir):


@main.command()
@click.option('--scope', type=click.Choice(['config', 'config+session', 'config+session+workspace']),
@click.option('--scope', type=click.Choice(SCOPE_CHOICES),
default='config', help='Backup scope')
@click.option(
'--source',
Expand All @@ -39,6 +42,13 @@ def backup(ctx, scope, source, reason):
scope_enum = BackupScope(scope)
source_enum = BackupSource(source) if source else None

# Guard: prevent minimal scope with native source until implemented
if scope == "minimal" and source == "native":
raise click.ClickException(
"Native backup does not yet support 'minimal' scope. "
"Use --source direct or choose a different scope."
)

try:
manifest = core.backup(scope_enum, reason, source=source_enum)
click.echo(f"Backup created: {manifest.backup_id}")
Expand Down Expand Up @@ -104,7 +114,7 @@ def status(ctx):


@main.command()
@click.option('--scope', type=click.Choice(['config', 'config+session', 'config+session+workspace']),
@click.option('--scope', type=click.Choice(SCOPE_CHOICES),
help='Filter by scope')
@click.pass_context
def list(ctx, scope):
Expand All @@ -124,7 +134,7 @@ def list(ctx, scope):


@main.command()
@click.option('--scope', type=click.Choice(['config', 'config+session', 'config+session+workspace']),
@click.option('--scope', type=click.Choice(SCOPE_CHOICES),
help='Cleanup specific scope')
@click.pass_context
def clean(ctx, scope):
Expand Down Expand Up @@ -161,7 +171,7 @@ def checkpoint(ctx, reason, serve):


@main.command()
@click.option('--scope', type=click.Choice(['config', 'config+session', 'config+session+workspace']),
@click.option('--scope', type=click.Choice(SCOPE_CHOICES),
default='config', help='Backup scope')
@click.option('--verify', is_flag=True, help='Verify archive after creation')
@click.option('--output', '-o', type=click.Path(exists=False, file_okay=False, dir_okay=True),
Expand All @@ -170,6 +180,13 @@ def native_backup(scope, verify, output):
"""Run OpenClaw native backup to create a tar.gz archive."""
import subprocess

# Fail fast until minimal scope semantics are implemented for native backup
if scope == "minimal":
raise click.ClickException(
"Native backup does not yet support 'minimal' scope. "
"Use 'config', 'config+session', or 'config+session+workspace'."
)

args = ["openclaw", "backup", "create"]

if scope == "config":
Expand Down