boxer-sdk
    Preparing search index...

    Interface RunOptions

    Options accepted by BoxerClient.run.

    interface RunOptions {
        cwd?: string;
        env?: string[];
        files?: string[];
        limits?: ResourceLimits;
        network?: "none" | "sandbox" | "host";
        persist?: boolean;
    }
    Index

    Properties

    cwd?: string

    Working directory inside the container. Defaults to "/".

    env?: string[]

    Environment variables injected into the container, in "KEY=value" form.

    files?: string[]

    Remote paths of files to bind-mount read-only inside the container. Each path must have been uploaded first via BoxerClient.uploadFile. The file is mounted at /<path> (e.g. "script.py"/script.py).

    Resource limits for this execution. Unset fields fall back to the server defaults.

    network?: "none" | "sandbox" | "host"

    Network mode for the sandbox.

    • "none" (default) - no network access.
    • "sandbox" - isolated network with internet access via a gVisor netstack.
    • "host" - shares the host network namespace (requires root on the server).
    persist?: boolean

    When true, output files written to /output/ inside the container are retained after the run and can be downloaded via BoxerClient.downloadFile. Defaults to false (output files are deleted before the response is returned).