CommandsSandbox
sandbox
Usage: polyaxon sandbox [OPTIONS] COMMAND [ARGS]...
Commands for sandbox-enabled runs.
Options:
--help Show this message and exit.
Commands:
download Download one sandbox file to a local path.
exec Execute a command in a sandbox run.
logs Read background exec logs.
ls List a sandbox directory.
ping Check sandbox health.
shell Start an interactive PTY in a sandbox-enabled service.
upload Upload one local file to a sandbox run.sandbox ping
Usage: polyaxon sandbox ping [OPTIONS]
Check sandbox health.
Options:
-p, --project TEXT The project name, e.g. 'mnist' or
'acme/mnist'.
-uid, -id, --uid, --uuid TEXT The run uuid.
--help Show this message and exit.sandbox exec
Usage: polyaxon sandbox exec [OPTIONS] [COMMAND]...
Execute a command in a sandbox run.
The command must follow a `--` separator:
$ polyaxon sandbox exec -p owner/project -uid UUID -- python -V
Options:
-p, --project TEXT The project name, e.g. 'mnist' or
'acme/mnist'.
-uid, -id, --uid, --uuid TEXT The run uuid.
--stream Stream command output.
--detach Start command and exit.
--tag TEXT Optional tag for detached commands.
--timeout-ms INTEGER Remote command timeout in milliseconds.
--help Show this message and exit.sandbox logs
Usage: polyaxon sandbox logs [OPTIONS] EXEC_ID
Read background exec logs.
Options:
-p, --project TEXT The project name, e.g. 'mnist' or
'acme/mnist'.
-uid, -id, --uid, --uuid TEXT The run uuid.
--stream [stdout|stderr] The background log stream. [default: stdout]
--offset INTEGER Log offset. [default: 0]
--max-bytes INTEGER Maximum bytes to read.
--help Show this message and exit.sandbox ls
Usage: polyaxon sandbox ls [OPTIONS] PATH
List a sandbox directory.
Options:
-p, --project TEXT The project name, e.g. 'mnist' or
'acme/mnist'.
-uid, -id, --uid, --uuid TEXT The run uuid.
--recursive List recursively.
--max-entries INTEGER Maximum entries to return.
--help Show this message and exit.sandbox upload
Usage: polyaxon sandbox upload [OPTIONS] PATH_FROM PATH_TO
Upload one local file to a sandbox run.
Options:
-p, --project TEXT The project name, e.g. 'mnist' or
'acme/mnist'.
-uid, -id, --uid, --uuid TEXT The run uuid.
--chunk-size INTEGER RANGE [default: 65536; x>=1]
--help Show this message and exit.sandbox download
Usage: polyaxon sandbox download [OPTIONS] PATH_FROM PATH_TO
Download one sandbox file to a local path.
Options:
-p, --project TEXT The project name, e.g. 'mnist' or
'acme/mnist'.
-uid, -id, --uid, --uuid TEXT The run uuid.
--chunk-size INTEGER RANGE [default: 65536; x>=1]
--help Show this message and exit.sandbox shell
Usage: polyaxon sandbox shell [OPTIONS]
Start an interactive PTY in a sandbox-enabled service.
The run must use ``kind: service`` with ``plugins.sandbox: true``. This
command creates a PTY managed by the sandbox daemon and attaches to it
directly; it does not use Kubernetes exec.
A sandbox PTY survives a client disconnect until it exits or reaches its
detached-idle timeout. This command currently creates a new PTY on every
invocation and does not reattach to a previous session. ``--replay-bytes``
replays recent output from the newly created PTY when attaching; it does not
select or restore an earlier PTY.
The command defaults to ``sh`` and is parsed using shell-like quoting before
being executed directly.
Examples:
$ polyaxon sandbox shell -p acme/project -uid UUID
$ polyaxon sandbox shell -p acme/project -uid UUID --command "python -i"
Options:
-p, --project TEXT The project name, e.g. 'mnist' or
'acme/mnist'.
-uid, -id, --uid, --uuid TEXT The run uuid.
-cmd, --command TEXT The shell command to start. [default: sh]
--cols INTEGER RANGE Initial terminal columns. [x>=1]
--rows INTEGER RANGE Initial terminal rows. [x>=1]
--replay-bytes INTEGER RANGE PTY output bytes to replay on attach.
[default: 0; x>=0]
--help Show this message and exit.