sklp space

Raw command JSON

{
  "path": [
    "sklp",
    "space"
  ],
  "slug": "space",
  "name": "space",
  "short": "Manage closed environments from .sklp/space.yaml (up | ls | get | down | exec | purge | build)",
  "synopsis": "sklp space [-- cmd…]",
  "passthrough": true,
  "subcommands": [
    {
      "path": [
        "sklp",
        "space",
        "build"
      ],
      "slug": "space-build",
      "name": "build",
      "short": "Build the space rootfs only (no shell)",
      "synopsis": "sklp space build [args…]",
      "rawArgs": true
    },
    {
      "path": [
        "sklp",
        "space",
        "down"
      ],
      "slug": "space-down",
      "name": "down",
      "short": "Stop + remove a space and its named volumes",
      "synopsis": "sklp space down <name>",
      "positionals": [
        {
          "name": "name",
          "required": true,
          "complete": "space"
        }
      ]
    },
    {
      "path": [
        "sklp",
        "space",
        "exec"
      ],
      "slug": "space-exec",
      "name": "exec",
      "short": "Exec a command (or open a shell) in a live space (-c <svc> to pick a container)",
      "synopsis": "sklp space exec <name>",
      "positionals": [
        {
          "name": "name",
          "required": true,
          "complete": "space"
        }
      ],
      "rawArgs": true
    },
    {
      "path": [
        "sklp",
        "space",
        "get"
      ],
      "slug": "space-get",
      "name": "get",
      "short": "Show one space's detail",
      "synopsis": "sklp space get <name>",
      "positionals": [
        {
          "name": "name",
          "required": true,
          "complete": "space"
        }
      ]
    },
    {
      "path": [
        "sklp",
        "space",
        "ls"
      ],
      "slug": "space-ls",
      "name": "ls",
      "short": "List all spaces (running or stopped)",
      "synopsis": "sklp space ls"
    },
    {
      "path": [
        "sklp",
        "space",
        "purge"
      ],
      "slug": "space-purge",
      "name": "purge",
      "short": "Tear down every space with no running container, volumes included",
      "synopsis": "sklp space purge"
    },
    {
      "path": [
        "sklp",
        "space",
        "stop"
      ],
      "slug": "space-stop",
      "name": "stop",
      "short": "Stop a space, keeping its named volumes (data survives)",
      "synopsis": "sklp space stop <name>",
      "positionals": [
        {
          "name": "name",
          "required": true,
          "complete": "space"
        }
      ]
    },
    {
      "path": [
        "sklp",
        "space",
        "up"
      ],
      "slug": "space-up",
      "name": "up",
      "short": "Open a space and an interactive shell in it (from --image or a space.yaml recipe)",
      "synopsis": "sklp space up [flags] <name>",
      "flags": [
        {
          "name": "image",
          "usage": "open a bare space straight from this OCI image (no recipe / space.yaml needed)",
          "type": "string"
        },
        {
          "name": "file",
          "usage": "explicit path to the space recipe (space.yaml); overrides the .sklp lookup",
          "type": "string"
        },
        {
          "name": "repo",
          "usage": "project repo holding .sklp/space.yaml",
          "type": "string",
          "default": "."
        }
      ],
      "positionals": [
        {
          "name": "name",
          "required": true
        }
      ]
    }
  ]
}