Skip to content

A desktop coding agent with free access to frontier models.

TypeScript
11.6 KB
Raw Blame
{
  "version": 1,
  "about": "The mandatory sandbox ('required' level of GET /collect/capabilities local_box) for the CLI (src/box/required.js) and the desktop app (apps/server/src/box/required.ts): what a client told required:true does, the setup it runs per OS, the build-artefact shadows on macOS/Windows hosts and the projects that stay on the host. Shared byte for byte (src/box/PARITY.sha256 and apps/server/src/box/PARITY.sha256).",
  "capability": {
    "required_key": "required",
    "fallback_key": "required_fallback",
    "fallbacks": ["native", "native_uncounted"],
    "default_fallback": "native"
  },
  "launch_record": {
    "about": "What client.launch `box` says under required: {required: true, reason, fallback, capable}. In the box: capable true, no fallback. cannot_run: this machine can't run the box (no virtualization, setup not possible or not done yet, a box that failed to start): capable false, fallback native (counted in full). opted_out: it could, but the box was turned off (--no-sandbox / OMNIRUSH_BOX=0) or the setup declined: capable true, fallback = the server's required_fallback. kept: an old chat or a host-only project, on this machine as before: fallback native, capable not checked (absent). Any other reason on this machine reads as cannot_run.",
    "cannot_run": ["cannot_run", "box_failed", "setup_needed"],
    "opted_out": ["env_off", "setup_declined"],
    "kept": ["kept_old_chat", "host_only", "native_model"]
  },
  "reasons": {
    "required": "box",
    "kept_old_chat": "kept_old_chat",
    "host_only": "host_only",
    "native_model": "native_model",
    "env_off": "env_off",
    "setup_needed": "setup_needed",
    "cannot_run": "cannot_run",
    "setup_declined": "setup_declined"
  },
  "host_only": {
    "about": "Projects that only build and run on their own OS: their new chats stay on the machine and count as today (launch reason host_only). Markers are matched in the project root and one level down.",
    "darwin": {
      "dirs_suffix": [".xcodeproj", ".xcworkspace"],
      "files": [],
      "file_patterns": [{ "name": "Package.swift", "contains": "\\.(?:iOS|macOS|tvOS|watchOS|visionOS)\\(" }]
    },
    "win32": {
      "dirs_suffix": [],
      "files": [],
      "file_patterns": [
        { "suffix": ".csproj", "contains": "<(?:UseWPF|UseWindowsForms|UseMaui)>\\s*true|net\\d+\\.\\d+-windows" },
        { "suffix": ".vcxproj", "contains": "." }
      ]
    }
  },
  "shadows": {
    "about": "On macOS/Windows hosts the box keeps its own Linux copy of each build-artefact folder, so the host's builds are never written and the host's Mac/Windows builds never run in the box. Tools that can be pointed elsewhere get an environment variable (no folder appears on the host); node_modules (harmless when empty) and folders that already exist on the host are bind-mounted from the box's own disk (boxrun init Binds). Shadows are never in the box snapshots: a rebuild recreates them from the manifests and the recorded installs. Linux hosts: none.",
    "hosts": ["darwin", "win32"],
    "store": "/var/lib/omnirush/shadows",
    "limits": { "entries": 4000, "ms": 150, "depth": 4, "max": 64 },
    "skip_dirs": [".git", "node_modules", ".venv", "venv", "target", ".hg", ".svn"],
    "env": [
      { "id": "uv", "when_any": ["pyproject.toml", "uv.lock"], "root_only": true, "set": { "UV_PROJECT_ENVIRONMENT": "{store}/venv" } },
      { "id": "poetry", "when_any": ["poetry.lock"], "root_only": true, "set": { "POETRY_VIRTUALENVS_IN_PROJECT": "false", "POETRY_VIRTUALENVS_PATH": "{store}/poetry" } },
      { "id": "cargo", "when_any": ["Cargo.toml"], "root_only": true, "set": { "CARGO_TARGET_DIR": "{store}/cargo-target" } }
    ],
    "binds": [
      { "dir": "node_modules", "when_any": ["package.json"], "even_if_absent": true },
      { "dir": ".venv", "when_any": ["pyvenv.cfg@dir", "pyproject.toml", "requirements.txt"], "even_if_absent": false },
      { "dir": "venv", "when_any": ["pyvenv.cfg@dir"], "even_if_absent": false },
      { "dir": "target", "when_any": ["Cargo.toml", "pom.xml"], "even_if_absent": false },
      { "dir": "build", "when_any": ["build.gradle", "build.gradle.kts", "CMakeLists.txt"], "even_if_absent": false },
      { "dir": ".gradle", "when_any": ["build.gradle", "build.gradle.kts", "settings.gradle", "settings.gradle.kts"], "even_if_absent": false },
      { "dir": ".next", "when_any": ["package.json"], "even_if_absent": false },
      { "dir": ".nuxt", "when_any": ["package.json"], "even_if_absent": false },
      { "dir": ".svelte-kit", "when_any": ["package.json"], "even_if_absent": false },
      { "dir": ".turbo", "when_any": ["package.json"], "even_if_absent": false },
      { "dir": ".parcel-cache", "when_any": ["package.json"], "even_if_absent": false },
      { "dir": ".dart_tool", "when_any": ["pubspec.yaml"], "even_if_absent": false },
      { "dir": ".build", "when_any": ["Package.swift"], "even_if_absent": false },
      { "dir": "vendor/bundle", "when_any": ["Gemfile"], "even_if_absent": false },
      { "dir": "obj", "when_any": ["*.csproj", "*.fsproj"], "even_if_absent": false },
      { "dir": "bin", "when_any": ["*.csproj", "*.fsproj"], "even_if_absent": false },
      { "dir": ".zig-cache", "when_any": ["build.zig"], "even_if_absent": false },
      { "dir": "zig-out", "when_any": ["build.zig"], "even_if_absent": false },
      { "dir": "dist", "when_any": ["@host-binaries"], "even_if_absent": false },
      { "dir": "out", "when_any": ["@host-binaries"], "even_if_absent": false }
    ],
    "record_key": "shadows"
  },
  "setup": {
    "linux": {
      "order": ["bwrap", "podman", "docker"],
      "enable": { "cli": "sudo omnirush sandbox enable", "desktop": "pkexec" }
    },
    "win32": {
      "min_build": 19041,
      "virtualization_errors": "0x80370102|0x80370114|HCS_E_HYPERV_NOT_INSTALLED|Please enable the Virtual Machine Platform|virtualization is enabled in the BIOS|WSL_E_VM_MODE_INVALID_STATE|virtualization is not enabled on this machine",
      "install_script": [
        "$ErrorActionPreference = 'Stop'",
        "$log = $args[0]",
        "function Add-Log([string]$line) { try { $line | Out-File -Append -Encoding utf8 $log } catch {} }",
        "function Invoke-Native([string]$exe, [string[]]$argv) {",
        "  $ErrorActionPreference = 'Continue'",
        "  $global:LASTEXITCODE = 1",
        "  try { & $exe @argv 2>&1 | ForEach-Object { Add-Log \"$_\" } } catch { Add-Log \"${exe}: $_\" }",
        "  return [int]$global:LASTEXITCODE",
        "}",
        "$code = Invoke-Native 'wsl.exe' @('--install', '--no-distribution')",
        "if ($code -ne 0) {",
        "  $a = Invoke-Native 'dism.exe' @('/online', '/enable-feature', '/featurename:Microsoft-Windows-Subsystem-Linux', '/all', '/norestart')",
        "  $b = Invoke-Native 'dism.exe' @('/online', '/enable-feature', '/featurename:VirtualMachinePlatform', '/all', '/norestart')",
        "  $null = Invoke-Native 'wsl.exe' @('--update', '--web-download')",
        "  if (($a -eq 0 -or $a -eq 3010) -and ($b -eq 0 -or $b -eq 3010)) { $code = 0 } else { Add-Log \"dism exit $a $b\" }",
        "}",
        "if ($code -eq 0) { Add-Log 'done' } else { Add-Log \"failed $code\" }"
      ],
      "resume_run_once": "OmniRushSandboxSetup"
    },
    "darwin": {
      "backend": "lima",
      "min_macos": "13.0",
      "lima": {
        "version": "2.2.1",
        "assets": {
          "arm64": { "url": "https://github.com/lima-vm/lima/releases/download/v2.2.1/lima-2.2.1-Darwin-arm64.tar.gz", "sha256": "9e9eacce88f37e185c346bad73aa6136f738d8cdf8c3bb23cd42b071824bc66e" },
          "x64": { "url": "https://github.com/lima-vm/lima/releases/download/v2.2.1/lima-2.2.1-Darwin-x86_64.tar.gz", "sha256": "6b776e4bc41f358e6ee01fefcc78e2eb26f11635a0fcff632234af77a566c6c4" }
        }
      },
      "vm": {
        "name": "omnirush-box", "cpus_max": 4, "memory_min_gib": 3, "memory_fraction": 0.25, "disk_gib": 30, "idle_stop_min": 30,
        "contract": 1,
        "image": {
          "about": "The VM's disk. custom: OmniRush's own small Debian image (box/vm), sha256 per arch from the box-<version> release (box-images workflow; null: not published); fallback: the official Debian genericcloud image, pinned by its published sha512.",
          "custom": {
            "version": "2026.10.2",
            "arm64": { "url": "https://github.com/omnirush-ai/omnirush-gui/releases/download/box-2026.10.2/omnirush-vm-2026.10.2-arm64.qcow2", "sha256": "d8a0ddd0505dba325ad0a1a683ed7e8d21c490bd80ccdb361a85529ec5dced3d" },
            "x64": { "url": "https://github.com/omnirush-ai/omnirush-gui/releases/download/box-2026.10.2/omnirush-vm-2026.10.2-amd64.qcow2", "sha256": "b5ddc14fdf35fd066dc194e44dde5851721b35c05834812d0440314769eff718" }
          },
          "fallback": {
            "version": "debian-13-genericcloud-20261021-2638",
            "arm64": { "url": "https://cloud.debian.org/images/cloud/trixie/20261021-2638/debian-13-genericcloud-arm64-20261021-2638.qcow2", "sha512": "e66eea33be9e1345e6c8737e65096e5b31031f4bd4f3f7d59a6f8b53f995a9c41996e97c5b4ab89f1587663efed11dfbd10c4d35b7bcc85b2545e58a12cd0e83" },
            "x64": { "url": "https://cloud.debian.org/images/cloud/trixie/20261021-2638/debian-13-genericcloud-amd64-20261021-2638.qcow2", "sha512": "16e0965312c56feb331049d45d2b1b5778f3f942a33d4300eedbb97527707f2bea87c0006f3e4cc7a25fadbff739c4e235a51fb9bcd1b66fd554f7f8e80ba45c" }
          }
        }
      }
    }
  },
  "texts": {
    "cli": {
      "required_line": "This account runs new chats in the OmniRush sandbox, a Linux box set up for you, so sessions can be rebuilt.",
      "opt_out_refused": "The sandbox is required for new chats on this account; chats started before stay as they were.",
      "kept_old_chat": "This chat started on this machine before the sandbox was required, so it stays here.",
      "native_model": "{model} runs on this machine, not in the sandbox, so this chat stays here.",
      "host_only": "This project only builds on {label} ({things}), so its chats run on {machine}.",
      "shadows": "In the sandbox, {dirs} are the sandbox's own Linux copies; your {label} copies are left as they are. Install dependencies inside as needed.",
      "setup_needed": "Setting up the sandbox ({step})…",
      "cannot_run": "The sandbox can't run on this computer: {why}. This chat runs on {machine}.",
      "win_setup": "The sandbox needs WSL 2. Run `omnirush sandbox setup` (one Windows admin prompt, then a restart).",
      "win_restart": "WSL 2 is installed; restart Windows to finish. OmniRush finishes the setup on its next start.",
      "win_updating": "WSL is updating for the sandbox in the background; this chat runs on this PC, the next one in the sandbox."
    },
    "desktop": {
      "required_line": "New chats run in the OmniRush sandbox, set up for you.",
      "opt_out_refused": "Required for new chats on this account. Chats started before keep running where they started.",
      "kept_old_chat": "Started on this computer before the sandbox was required: it stays here.",
      "host_only": "This project only builds on {label} ({things}), so its chats run on {machine}.",
      "shadows": "In the sandbox, {dirs} are the sandbox's own Linux copies; your {label} copies are left as they are.",
      "cannot_run": "The sandbox can't run on this computer: {why}."
    },
    "why": {
      "firmware_off": "virtualization is turned off in the BIOS/UEFI settings (Intel VT-x or AMD SVM)",
      "nested_vm": "this Windows runs inside a virtual machine without nested virtualization",
      "s_mode": "Windows in S mode can't run WSL",
      "old_windows": "Windows 10 version 2004 (build 19041) or later is needed",
      "old_macos": "macOS 13 or later is needed",
      "policy": "your organisation's settings block WSL",
      "declined": "the setup was cancelled"
    }
  }
}