sbx_create_copilot.yaml

name: sbx create copilot
synopsis: Create a sandbox for copilot
description: |-
    Create a sandbox with access to a host workspace for copilot.

    The workspace path is required and will be mounted inside the sandbox at the
    same path as on the host. Additional workspaces can be provided as extra
    arguments. Append ":ro" to mount them read-only.

    Use "sbx run SANDBOX" to attach to the agent after creation.
usage: sbx create copilot PATH [PATH...] [flags]
options:
    - name: help
      shorthand: h
      default_value: "false"
      usage: help for copilot
inherited_options:
    - name: clone
      default_value: "false"
      usage: |
        Run the agent on a private in-container clone of the host Git repository (mounted read-only) instead of bind-mounting the workspace; the agent's commits are accessible via the sandbox-<name> git remote on the host
    - name: cpus
      default_value: "0"
      usage: |
        Number of CPUs to allocate to the sandbox (0 = auto: N-1 host CPUs, min 1)
    - name: debug
      shorthand: D
      default_value: "false"
      usage: Enable debug logging
    - name: kit
      default_value: '[]'
      experimental: true
      usage: |
        Kit reference (directory, ZIP, or OCI). Can be specified multiple times
    - name: memory
      shorthand: m
      usage: |
        Memory limit in binary units (e.g., 1024m, 8g). Default: 50% of host memory, max 32 GiB
    - name: name
      usage: |
        Name for the sandbox (default: <agent>-<workdir>, letters, numbers, hyphens, periods, plus signs and minus signs only)
    - name: quiet
      shorthand: q
      default_value: "false"
      usage: Suppress verbose output
    - name: template
      shorthand: t
      usage: |
        Container image to use for the sandbox (default: agent-specific image)
example: |4-
      # Create in the current directory
      sbx create copilot .

      # Create with a specific path
      sbx create copilot /path/to/project

      # Create with additional read-only workspaces
      sbx create copilot . /path/to/docs:ro
see_also:
    - sbx create - Create a sandbox for an agent