clonebox 0.1.5__tar.gz → 0.1.7__tar.gz

{clonebox-0.1.5 → clonebox-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clonebox
-Version: 0.1.5
+Version: 0.1.7
 Summary: Clone your workstation environment to an isolated VM with selective apps, paths and services
 Author: CloneBox Team
 License: Apache-2.0
@@ -38,6 +38,7 @@ Requires-Dist: ruff>=0.1.0; extra == "dev"
 Dynamic: license-file
 
 # CloneBox 📦
+![img.png](img.png)
 
 ```commandline
 ╔═══════════════════════════════════════════════════════╗
@@ -62,6 +63,7 @@ CloneBox lets you create isolated virtual machines with only the applications, d
 - ☁️ **Cloud-init** - Automatic package installation and service setup
 - 🖥️ **GUI support** - SPICE graphics with virt-viewer integration
 - ⚡ **Fast creation** - No full disk cloning, VMs are ready in seconds
+- 📥 **Auto-download** - Automatically downloads and caches Ubuntu cloud images (stored in ~/Downloads)
 
 ## Installation
 
@@ -139,6 +141,8 @@ Simply run `clonebox` to start the interactive wizard:
 
 ```bash
 clonebox
+clonebox clone . --user --run --replace --base-image ~/ubuntu-22.04-cloud.qcow2
+
 ```
 
 The wizard will:
@@ -259,6 +263,7 @@ The fastest way to clone your current working directory:
 
 ```bash
 # Clone current directory - generates .clonebox.yaml and asks to create VM
+# Base OS image is automatically downloaded to ~/Downloads on first run
 clonebox clone .
 
 # Clone specific path
@@ -269,6 +274,15 @@ clonebox clone ~/projects/my-app --name my-dev-vm --run
 
 # Clone and edit config before creating
 clonebox clone . --edit
+
+# Replace existing VM (stops, deletes, and recreates)
+clonebox clone . --replace
+
+# Use custom base image instead of auto-download
+clonebox clone . --base-image ~/ubuntu-22.04-cloud.qcow2
+
+# User session mode (no root required)
+clonebox clone . --user
 ```
 
 Later, start the VM from any directory with `.clonebox.yaml`:
@@ -291,6 +305,63 @@ clonebox detect --yaml --dedupe
 clonebox detect --yaml --dedupe -o my-config.yaml
 ```
 
+### Base Images
+
+CloneBox automatically downloads a bootable Ubuntu cloud image on first run:
+
+```bash
+# Auto-download (default) - downloads Ubuntu 22.04 to ~/Downloads on first run
+clonebox clone .
+
+# Use custom base image
+clonebox clone . --base-image ~/my-custom-image.qcow2
+
+# Manual download (optional - clonebox does this automatically)
+wget -O ~/Downloads/clonebox-ubuntu-jammy-amd64.qcow2 \
+  https://cloud-images.ubuntu.com/jammy/current/jammy-server-cloudimg-amd64.img
+```
+
+**Base image behavior:**
+- If no `--base-image` is specified, Ubuntu 22.04 cloud image is auto-downloaded
+- Downloaded images are cached in `~/Downloads/clonebox-ubuntu-jammy-amd64.qcow2`
+- Subsequent VMs reuse the cached image (no re-download)
+- Each VM gets its own disk using the base image as a backing file (copy-on-write)
+
+### VM Login Credentials
+
+VM credentials are managed through `.env` file for security:
+
+**Setup:**
+1. Copy `.env.example` to `.env`:
+   ```bash
+   cp .env.example .env
+   ```
+
+2. Edit `.env` and set your password:
+   ```bash
+   # .env file
+   VM_PASSWORD=your_secure_password
+   VM_USERNAME=ubuntu
+   ```
+
+3. The `.clonebox.yaml` file references the password from `.env`:
+   ```yaml
+   vm:
+     username: ubuntu
+     password: ${VM_PASSWORD}  # Loaded from .env
+   ```
+
+**Default credentials (if .env not configured):**
+- **Username:** `ubuntu`
+- **Password:** `ubuntu`
+
+**Security notes:**
+- `.env` is automatically gitignored (never committed)
+- Username is stored in YAML (not sensitive)
+- Password is stored in `.env` (sensitive, not committed)
+- Change password after first login: `passwd`
+- User has passwordless sudo access
+
 ### User Session & Networking
 
 CloneBox supports creating VMs in user session (no root required) with automatic network fallback:
@@ -322,7 +393,9 @@ clonebox clone . --network auto
 | `clonebox clone <path>` | Generate `.clonebox.yaml` from path + running processes |
 | `clonebox clone . --run` | Clone and immediately start VM |
 | `clonebox clone . --edit` | Clone, edit config, then create |
+| `clonebox clone . --replace` | Replace existing VM (stop, delete, recreate) |
 | `clonebox clone . --user` | Clone in user session (no root) |
+| `clonebox clone . --base-image <path>` | Use custom base image |
 | `clonebox clone . --network user` | Use user-mode networking (slirp) |
 | `clonebox clone . --network auto` | Auto-detect network mode (default) |
 | `clonebox start .` | Start VM from `.clonebox.yaml` in current dir |
@@ -377,18 +450,21 @@ sudo usermod -aG kvm $USER
 
 ### VM Already Exists
 
-If you get "domain already exists" error:
+If you get "VM already exists" error:
 
 ```bash
-# List VMs
-clonebox list
+# Option 1: Use --replace flag to automatically replace it
+clonebox clone . --replace
 
-# Stop and delete the existing VM
+# Option 2: Delete manually first
 clonebox delete <vm-name>
 
-# Or use virsh directly
+# Option 3: Use virsh directly
 virsh --connect qemu:///session destroy <vm-name>
 virsh --connect qemu:///session undefine <vm-name>
+
+# Option 4: Start the existing VM instead
+clonebox start <vm-name>
 ```
 
 ### virt-viewer not found

{clonebox-0.1.5 → clonebox-0.1.7}/README.md

@@ -1,4 +1,5 @@
 # CloneBox 📦
+![img.png](img.png)
 
 ```commandline
 ╔═══════════════════════════════════════════════════════╗
@@ -23,6 +24,7 @@ CloneBox lets you create isolated virtual machines with only the applications, d
 - ☁️ **Cloud-init** - Automatic package installation and service setup
 - 🖥️ **GUI support** - SPICE graphics with virt-viewer integration
 - ⚡ **Fast creation** - No full disk cloning, VMs are ready in seconds
+- 📥 **Auto-download** - Automatically downloads and caches Ubuntu cloud images (stored in ~/Downloads)
 
 ## Installation
 
@@ -100,6 +102,8 @@ Simply run `clonebox` to start the interactive wizard:
 
 ```bash
 clonebox
+clonebox clone . --user --run --replace --base-image ~/ubuntu-22.04-cloud.qcow2
+
 ```
 
 The wizard will:
@@ -220,6 +224,7 @@ The fastest way to clone your current working directory:
 
 ```bash
 # Clone current directory - generates .clonebox.yaml and asks to create VM
+# Base OS image is automatically downloaded to ~/Downloads on first run
 clonebox clone .
 
 # Clone specific path
@@ -230,6 +235,15 @@ clonebox clone ~/projects/my-app --name my-dev-vm --run
 
 # Clone and edit config before creating
 clonebox clone . --edit
+
+# Replace existing VM (stops, deletes, and recreates)
+clonebox clone . --replace
+
+# Use custom base image instead of auto-download
+clonebox clone . --base-image ~/ubuntu-22.04-cloud.qcow2
+
+# User session mode (no root required)
+clonebox clone . --user
 ```
 
 Later, start the VM from any directory with `.clonebox.yaml`:
@@ -252,6 +266,63 @@ clonebox detect --yaml --dedupe
 clonebox detect --yaml --dedupe -o my-config.yaml
 ```
 
+### Base Images
+
+CloneBox automatically downloads a bootable Ubuntu cloud image on first run:
+
+```bash
+# Auto-download (default) - downloads Ubuntu 22.04 to ~/Downloads on first run
+clonebox clone .
+
+# Use custom base image
+clonebox clone . --base-image ~/my-custom-image.qcow2
+
+# Manual download (optional - clonebox does this automatically)
+wget -O ~/Downloads/clonebox-ubuntu-jammy-amd64.qcow2 \
+  https://cloud-images.ubuntu.com/jammy/current/jammy-server-cloudimg-amd64.img
+```
+
+**Base image behavior:**
+- If no `--base-image` is specified, Ubuntu 22.04 cloud image is auto-downloaded
+- Downloaded images are cached in `~/Downloads/clonebox-ubuntu-jammy-amd64.qcow2`
+- Subsequent VMs reuse the cached image (no re-download)
+- Each VM gets its own disk using the base image as a backing file (copy-on-write)
+
+### VM Login Credentials
+
+VM credentials are managed through `.env` file for security:
+
+**Setup:**
+1. Copy `.env.example` to `.env`:
+   ```bash
+   cp .env.example .env
+   ```
+
+2. Edit `.env` and set your password:
+   ```bash
+   # .env file
+   VM_PASSWORD=your_secure_password
+   VM_USERNAME=ubuntu
+   ```
+
+3. The `.clonebox.yaml` file references the password from `.env`:
+   ```yaml
+   vm:
+     username: ubuntu
+     password: ${VM_PASSWORD}  # Loaded from .env
+   ```
+
+**Default credentials (if .env not configured):**
+- **Username:** `ubuntu`
+- **Password:** `ubuntu`
+
+**Security notes:**
+- `.env` is automatically gitignored (never committed)
+- Username is stored in YAML (not sensitive)
+- Password is stored in `.env` (sensitive, not committed)
+- Change password after first login: `passwd`
+- User has passwordless sudo access
+
 ### User Session & Networking
 
 CloneBox supports creating VMs in user session (no root required) with automatic network fallback:
@@ -283,7 +354,9 @@ clonebox clone . --network auto
 | `clonebox clone <path>` | Generate `.clonebox.yaml` from path + running processes |
 | `clonebox clone . --run` | Clone and immediately start VM |
 | `clonebox clone . --edit` | Clone, edit config, then create |
+| `clonebox clone . --replace` | Replace existing VM (stop, delete, recreate) |
 | `clonebox clone . --user` | Clone in user session (no root) |
+| `clonebox clone . --base-image <path>` | Use custom base image |
 | `clonebox clone . --network user` | Use user-mode networking (slirp) |
 | `clonebox clone . --network auto` | Auto-detect network mode (default) |
 | `clonebox start .` | Start VM from `.clonebox.yaml` in current dir |
@@ -338,18 +411,21 @@ sudo usermod -aG kvm $USER
 
 ### VM Already Exists
 
-If you get "domain already exists" error:
+If you get "VM already exists" error:
 
 ```bash
-# List VMs
-clonebox list
+# Option 1: Use --replace flag to automatically replace it
+clonebox clone . --replace
 
-# Stop and delete the existing VM
+# Option 2: Delete manually first
 clonebox delete <vm-name>
 
-# Or use virsh directly
+# Option 3: Use virsh directly
 virsh --connect qemu:///session destroy <vm-name>
 virsh --connect qemu:///session undefine <vm-name>
+
+# Option 4: Start the existing VM instead
+clonebox start <vm-name>
 ```
 
 ### virt-viewer not found

{clonebox-0.1.5 → clonebox-0.1.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "clonebox"
-version = "0.1.5"
+version = "0.1.7"
 description = "Clone your workstation environment to an isolated VM with selective apps, paths and services"
 readme = "README.md"
 license = {text = "Apache-2.0"}

{clonebox-0.1.5 → clonebox-0.1.7}/src/clonebox/cli.py

@@ -6,7 +6,9 @@ CloneBox CLI - Interactive command-line interface for creating VMs.
 import argparse
 import json
 import os
+import re
 import sys
+from typing import Optional
 from datetime import datetime
 from pathlib import Path
 
@@ -487,6 +489,40 @@ def cmd_list(args):
 
 
 CLONEBOX_CONFIG_FILE = ".clonebox.yaml"
+CLONEBOX_ENV_FILE = ".env"
+
+
+def load_env_file(env_path: Path) -> dict:
+    """Load environment variables from .env file."""
+    env_vars = {}
+    if not env_path.exists():
+        return env_vars
+    
+    with open(env_path) as f:
+        for line in f:
+            line = line.strip()
+            if not line or line.startswith('#'):
+                continue
+            if '=' in line:
+                key, value = line.split('=', 1)
+                env_vars[key.strip()] = value.strip()
+    
+    return env_vars
+
+
+def expand_env_vars(value, env_vars: dict):
+    """Expand environment variables in string values like ${VAR_NAME}."""
+    if isinstance(value, str):
+        # Replace ${VAR_NAME} with value from env_vars or os.environ
+        def replacer(match):
+            var_name = match.group(1)
+            return env_vars.get(var_name, os.environ.get(var_name, match.group(0)))
+        return re.sub(r'\$\{([^}]+)\}', replacer, value)
+    elif isinstance(value, dict):
+        return {k: expand_env_vars(v, env_vars) for k, v in value.items()}
+    elif isinstance(value, list):
+        return [expand_env_vars(item, env_vars) for item in value]
+    return value
 
 
 def deduplicate_list(items: list, key=None) -> list:
@@ -508,6 +544,7 @@ def generate_clonebox_yaml(
     target_path: str = None,
     vm_name: str = None,
     network_mode: str = "auto",
+    base_image: Optional[str] = None,
 ) -> str:
     """Generate YAML config from system snapshot."""
     sys_info = detector.get_system_info()
@@ -555,6 +592,16 @@ def generate_clonebox_yaml(
             paths_mapping[host_path] = f"/mnt/workdir{idx}"
             idx += 1
 
+    # Add default user folders (Downloads, Documents)
+    home_dir = Path.home()
+    default_folders = [
+        (home_dir / "Downloads", "/home/ubuntu/Downloads"),
+        (home_dir / "Documents", "/home/ubuntu/Documents"),
+    ]
+    for host_folder, guest_folder in default_folders:
+        if host_folder.exists() and str(host_folder) not in paths_mapping:
+            paths_mapping[str(host_folder)] = guest_folder
+
     # Determine VM name
     if not vm_name:
         if target_path:
@@ -566,6 +613,28 @@ def generate_clonebox_yaml(
     ram_mb = min(4096, int(sys_info["memory_available_gb"] * 1024 * 0.5))
     vcpus = max(2, sys_info["cpu_count"] // 2)
 
+    # Auto-detect packages from running applications and services
+    app_packages = detector.suggest_packages_for_apps(snapshot.applications)
+    service_packages = detector.suggest_packages_for_services(snapshot.running_services)
+    
+    # Combine with base packages (apt only)
+    base_packages = [
+        "build-essential",
+        "git",
+        "curl",
+        "vim",
+    ]
+    
+    # Merge apt packages and deduplicate
+    all_apt_packages = base_packages + app_packages["apt"] + service_packages["apt"]
+    if deduplicate:
+        all_apt_packages = deduplicate_list(all_apt_packages)
+    
+    # Merge snap packages and deduplicate
+    all_snap_packages = app_packages["snap"] + service_packages["snap"]
+    if deduplicate:
+        all_snap_packages = deduplicate_list(all_snap_packages)
+
     # Build config
     config = {
         "version": "1",
@@ -575,18 +644,15 @@ def generate_clonebox_yaml(
             "ram_mb": ram_mb,
             "vcpus": vcpus,
             "gui": True,
-            "base_image": None,
+            "base_image": base_image,
             "network_mode": network_mode,
+            "username": "ubuntu",
+            "password": "${VM_PASSWORD}",
         },
         "services": services,
-        "packages": [
-            "build-essential",
-            "git",
-            "curl",
-            "vim",
-            "python3",
-            "python3-pip",
-        ],
+        "packages": all_apt_packages,
+        "snap_packages": all_snap_packages,
+        "post_commands": [],  # User can add custom commands to run after setup
         "paths": paths_mapping,
         "detected": {
             "running_apps": [
@@ -605,17 +671,115 @@ def generate_clonebox_yaml(
 
 
 def load_clonebox_config(path: Path) -> dict:
-    """Load .clonebox.yaml config file."""
+    """Load .clonebox.yaml config file and expand environment variables from .env."""
     config_file = path / CLONEBOX_CONFIG_FILE if path.is_dir() else path
 
     if not config_file.exists():
         raise FileNotFoundError(f"Config file not found: {config_file}")
 
-    with open(config_file) as f:
-        return yaml.safe_load(f)
-
+    # Load .env file from same directory
+    config_dir = config_file.parent
+    env_file = config_dir / CLONEBOX_ENV_FILE
+    env_vars = load_env_file(env_file)
 
-def create_vm_from_config(config: dict, start: bool = False, user_session: bool = False) -> str:
+    # Load YAML config
+    with open(config_file) as f:
+        config = yaml.safe_load(f)
+    
+    # Expand environment variables in config
+    config = expand_env_vars(config, env_vars)
+    
+    return config
+
+
+def monitor_cloud_init_status(vm_name: str, user_session: bool = False, timeout: int = 600):
+    """Monitor cloud-init status in VM and show progress."""
+    import subprocess
+    import time
+    
+    conn_uri = "qemu:///session" if user_session else "qemu:///system"
+    start_time = time.time()
+    shutdown_count = 0  # Count consecutive shutdown detections
+    restart_detected = False
+    
+    with Progress(
+        SpinnerColumn(),
+        TextColumn("[progress.description]{task.description}"),
+        console=console,
+    ) as progress:
+        task = progress.add_task("[cyan]Starting VM and initializing...", total=None)
+        
+        while time.time() - start_time < timeout:
+            try:
+                elapsed = int(time.time() - start_time)
+                minutes = elapsed // 60
+                seconds = elapsed % 60
+                
+                # Check VM state
+                result = subprocess.run(
+                    ["virsh", "--connect", conn_uri, "domstate", vm_name],
+                    capture_output=True,
+                    text=True,
+                    timeout=5
+                )
+                
+                vm_state = result.stdout.strip().lower()
+                
+                if "shut off" in vm_state or "shutting down" in vm_state:
+                    # VM is shutting down - count consecutive detections
+                    shutdown_count += 1
+                    if shutdown_count >= 3 and not restart_detected:
+                        # Confirmed shutdown after 3 consecutive checks
+                        restart_detected = True
+                        progress.update(task, description="[yellow]⟳ VM restarting after package installation...")
+                    time.sleep(3)
+                    continue
+                else:
+                    # VM is running - reset shutdown counter
+                    if shutdown_count > 0 and shutdown_count < 3:
+                        # Was a brief glitch, not a real shutdown
+                        shutdown_count = 0
+                
+                if restart_detected and "running" in vm_state and shutdown_count >= 3:
+                    # VM restarted successfully - GUI should be ready
+                    progress.update(task, description=f"[green]✓ GUI ready! Total time: {minutes}m {seconds}s")
+                    time.sleep(2)
+                    break
+                
+                # Estimate remaining time
+                if elapsed < 60:
+                    remaining = "~9-10 minutes"
+                elif elapsed < 180:
+                    remaining = f"~{8 - minutes} minutes"
+                elif elapsed < 300:
+                    remaining = f"~{6 - minutes} minutes"
+                else:
+                    remaining = "finishing soon"
+                
+                if restart_detected:
+                    progress.update(task, description=f"[cyan]Starting GUI... ({minutes}m {seconds}s, {remaining})")
+                else:
+                    progress.update(task, description=f"[cyan]Installing desktop packages... ({minutes}m {seconds}s, {remaining})")
+                
+            except (subprocess.TimeoutExpired, Exception) as e:
+                elapsed = int(time.time() - start_time)
+                minutes = elapsed // 60
+                seconds = elapsed % 60
+                progress.update(task, description=f"[cyan]Configuring VM... ({minutes}m {seconds}s)")
+            
+            time.sleep(3)
+        
+        # Final status
+        if time.time() - start_time >= timeout:
+            progress.update(task, description="[yellow]⚠ Monitoring timeout - VM continues in background")
+
+
+def create_vm_from_config(
+    config: dict,
+    start: bool = False,
+    user_session: bool = False,
+    replace: bool = False,
+) -> str:
     """Create VM from YAML config dict."""
     vm_config = VMConfig(
         name=config["vm"]["name"],
@@ -625,9 +789,13 @@ def create_vm_from_config(config: dict, start: bool = False, user_session: bool
         base_image=config["vm"].get("base_image"),
         paths=config.get("paths", {}),
         packages=config.get("packages", []),
+        snap_packages=config.get("snap_packages", []),
         services=config.get("services", []),
+        post_commands=config.get("post_commands", []),
         user_session=user_session,
         network_mode=config["vm"].get("network_mode", "auto"),
+        username=config["vm"].get("username", "ubuntu"),
+        password=config["vm"].get("password", "ubuntu"),
     )
 
     cloner = SelectiveVMCloner(user_session=user_session)
@@ -643,10 +811,20 @@ def create_vm_from_config(config: dict, start: bool = False, user_session: bool
 
     console.print(f"[dim]Session: {checks['session_type']}, Storage: {checks['images_dir']}[/]")
 
-    vm_uuid = cloner.create_vm(vm_config, console=console)
+    vm_uuid = cloner.create_vm(vm_config, console=console, replace=replace)
 
     if start:
         cloner.start_vm(vm_config.name, open_viewer=vm_config.gui, console=console)
+        
+        # Monitor cloud-init progress if GUI is enabled
+        if vm_config.gui:
+            console.print("\n[bold cyan]📊 Monitoring setup progress...[/]")
+            try:
+                monitor_cloud_init_status(vm_config.name, user_session=user_session)
+            except KeyboardInterrupt:
+                console.print("\n[yellow]Monitoring stopped. VM continues setup in background.[/]")
+            except Exception as e:
+                console.print(f"\n[dim]Note: Could not monitor status ({e}). VM continues setup in background.[/]")
 
     return vm_uuid
 
@@ -681,6 +859,7 @@ def cmd_clone(args):
         target_path=str(target_path),
         vm_name=vm_name,
         network_mode=args.network,
+        base_image=getattr(args, "base_image", None),
     )
 
     # Save config file
@@ -712,7 +891,8 @@ def cmd_clone(args):
         ).ask()
 
     if create_now:
-        config = yaml.safe_load(yaml_content)
+        # Load config with environment variable expansion
+        config = load_clonebox_config(config_file.parent)
         user_session = getattr(args, "user", False)
 
         console.print("\n[bold cyan]🔧 Creating VM...[/]\n")
@@ -720,10 +900,26 @@ def cmd_clone(args):
             console.print("[cyan]Using user session (qemu:///session) - no root required[/]")
 
         try:
-            vm_uuid = create_vm_from_config(config, start=True, user_session=user_session)
+            vm_uuid = create_vm_from_config(
+                config,
+                start=True,
+                user_session=user_session,
+                replace=getattr(args, "replace", False),
+            )
             console.print(f"\n[bold green]🎉 VM '{config['vm']['name']}' is running![/]")
             console.print(f"[dim]UUID: {vm_uuid}[/]")
 
+            # Show GUI startup info if GUI is enabled
+            if config.get("vm", {}).get("gui", False):
+                username = config['vm'].get('username', 'ubuntu')
+                password = config['vm'].get('password', 'ubuntu')
+                console.print("\n[bold yellow]⏰ GUI Setup Process:[/]")
+                console.print("  [yellow]•[/] Installing desktop environment (~5-10 minutes)")
+                console.print("  [yellow]•[/] Automatic restart after installation")
+                console.print("  [yellow]•[/] GUI login screen will appear")
+                console.print(f"  [yellow]•[/] Login: [cyan]{username}[/] / [cyan]{'*' * len(password)}[/] (from .env)")
+                console.print("\n[dim]💡 Progress will be monitored automatically below[/]")
+
             # Show mount instructions
             if config.get("paths"):
                 console.print("\n[bold]Inside VM, mount paths with:[/]")
@@ -939,6 +1135,15 @@ def main():
         default="auto",
         help="Network mode: auto (default), default (libvirt network), user (slirp)",
     )
+    clone_parser.add_argument(
+        "--base-image",
+        help="Path to a bootable qcow2 image to use as a base disk",
+    )
+    clone_parser.add_argument(
+        "--replace",
+        action="store_true",
+        help="If VM already exists, stop+undefine it and recreate (also deletes its storage)",
+    )
     clone_parser.set_defaults(func=cmd_clone)
 
     args = parser.parse_args()