sklp macos

Raw command JSON

{
  "path": [
    "sklp",
    "macos"
  ],
  "slug": "macos",
  "name": "macos",
  "short": "Manage the Linux VM sklp runs on macOS (Virtualization.framework)",
  "long": "sklp macos — the Linux VM sklp relays into on this Mac.\n\nThe vz backend runs the Linux guest on Apple's Virtualization.framework\ninstead of shelling out to Lima, so macOS needs no VM manager installed. It\nneeds two artifacts in its cache:\n\n  kernel      Linux 6.12.28 with the Kata guest config plus the\n              netfilter/tun options spacenet needs (a stock distro kernel\n              ships those as modules and will not boot here)\n  rootfs.img  an ext4 image built from debian:trixie-slim, carrying sklp,\n              skt and the tools sklp shells out to\n\nThis backend is the default on Apple silicon; SKLP_VM_PROVIDER=lima|orbstack\npicks another. The artifacts live under ~/.cache/sklp/vz (SKLP_VZ_DIR).",
  "synopsis": "sklp macos",
  "subcommands": [
    {
      "path": [
        "sklp",
        "macos",
        "build"
      ],
      "slug": "macos-build",
      "name": "build",
      "short": "Build the guest kernel and rootfs image",
      "long": "Builds both artifacts from pinned sources.\n\nThe kernel is compiled from upstream 6.12.28 with the config\nextracted from the Kata 3.17.0 guest kernel; the rootfs is\nassembled from the debian:trixie-slim OCI layer. Both steps need a Linux\nbuilder: this runs them wherever sklp is already relaying to.",
      "synopsis": "sklp macos build [args…]",
      "rawArgs": true
    },
    {
      "path": [
        "sklp",
        "macos",
        "down"
      ],
      "slug": "macos-down",
      "name": "down",
      "short": "Stop the VM, taking every space running in it with it",
      "synopsis": "sklp macos down"
    },
    {
      "path": [
        "sklp",
        "macos",
        "status"
      ],
      "slug": "macos-status",
      "name": "status",
      "short": "Show which artifacts are present and their versions",
      "synopsis": "sklp macos status"
    },
    {
      "path": [
        "sklp",
        "macos",
        "up"
      ],
      "slug": "macos-up",
      "name": "up",
      "short": "Start the VM now instead of on the next command",
      "synopsis": "sklp macos up"
    }
  ]
}