opensandbox-cli 0.1.1__tar.gz → 1.1.0__tar.gz

{opensandbox_cli-0.1.1 → opensandbox_cli-1.1.0}/.gitignore

@@ -269,6 +269,19 @@ nbdist/
 generated/
 **/generated/**
 
+# Fast Sandbox FastPath gRPC stubs are committed intentionally (deterministic protoc
+# output; the server package needs them at install time, so they are checked
+# in rather than regenerated).
+!server/opensandbox_server/services/fast_sandbox/generated/
+!server/opensandbox_server/services/fast_sandbox/generated/**
+server/opensandbox_server/services/fast_sandbox/generated/__pycache__/
+
+# execd eBPF kernel BTF dumps (bpf2go build-time only, never committed —
+# see components/execd/pkg/ebpf/prog/audit.bpf.c; regenerate with:
+#   bpftool btf dump file /sys/kernel/btf/vmlinux format c > .../vmlinux.h)
+components/execd/pkg/ebpf/prog/vmlinux.h
+components/execd/pkg/ebpf/prog/vmlinux_*.h
+
 # gVisor runtime binaries (downloaded dynamically)
 kubernetes/test/kind/gvisor/runsc
 kubernetes/test/kind/gvisor/containerd-shim-runsc-v1
@@ -276,3 +289,8 @@ bin/
 obj/
 
 .qoder/
+/.vs
+
+# fast-sandbox pinned source checkout (materialized by
+# manifests/release/build-fast-sandbox.sh from manifests/third-party/fast-sandbox.commit)
+.fast-sandbox/

{opensandbox_cli-0.1.1 → opensandbox_cli-1.1.0}/PKG-INFO

@@ -1,11 +1,11 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: opensandbox-cli
-Version: 0.1.1
+Version: 1.1.0
 Summary: OpenSandbox CLI - Command-line interface for managing sandboxes
 Project-URL: Homepage, https://open-sandbox.ai
-Project-URL: Repository, https://github.com/alibaba/OpenSandbox
+Project-URL: Repository, https://github.com/opensandbox-group/OpenSandbox
 Project-URL: Documentation, https://open-sandbox.ai
-Project-URL: Issues, https://github.com/alibaba/OpenSandbox/issues
+Project-URL: Issues, https://github.com/opensandbox-group/OpenSandbox/issues
 Author-email: OpenSandbox Team <ninan.nn@alibaba-inc.com>
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -224,7 +224,7 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Requires-Dist: click<9.0,>=8.1.0
-Requires-Dist: opensandbox<0.2.0,>=0.1.9
+Requires-Dist: opensandbox<2.0.0,>=1.1.0
 Requires-Dist: pyyaml<7.0,>=6.0
 Requires-Dist: rich<14.0,>=13.0.0
 Requires-Dist: tomli>=2.0.0; python_version < '3.11'
@@ -238,6 +238,7 @@ Description-Content-Type: text/markdown
 - run commands inside a sandbox
 - read and modify sandbox files
 - inspect runtime egress policy
+- manage sandbox-local Credential Vault state
 - collect low-level diagnostics
 - install OpenSandbox-specific skills for coding agents
 
@@ -282,6 +283,7 @@ opensandbox-server
 osb config init
 osb config set connection.domain localhost:8080
 osb config set connection.protocol http
+osb config set connection.api_key <your-api-key>
 osb config show -o json
 ```
 
@@ -379,6 +381,12 @@ osb sandbox create \
   --volumes-file volumes.json
 ```
 
+Create with Credential Vault proxy enabled:
+
+```bash
+osb sandbox create --image python:3.12 --network-policy-file network-policy.json --credential-proxy -o json
+```
+
 ### List and inspect sandboxes
 
 ```bash
@@ -390,6 +398,17 @@ osb sandbox metrics <sandbox-id>
 osb sandbox metrics <sandbox-id> --watch -o raw
 ```
 
+### Pause a sandbox
+
+Pause is asynchronous. `Pause request accepted` confirms that the server accepted
+the request, not that the sandbox has reached the `Paused` state. Poll the sandbox
+until the transition finishes:
+
+```bash
+osb sandbox pause <sandbox-id>
+osb sandbox get <sandbox-id> -o json
+```
+
 ### Expose a service
 
 ```bash
@@ -412,6 +431,17 @@ osb command status <sandbox-id> <execution-id> -o json
 osb command logs <sandbox-id> <execution-id> -o json
 ```
 
+By default the payload after `--` is joined into one shell command string, so
+pipelines, redirection, and `$VAR` expansion work as in a terminal. Add `--argv`
+to pass the arguments to the executable as a literal argv list (no shell) when
+values such as `$HOME`, quotes, embedded spaces, or empty strings must reach the
+process unchanged. `--argv` needs a sandbox image whose execd accepts argv
+requests:
+
+```bash
+osb command run <sandbox-id> -o raw --argv -- python3 -c "import sys; print(sys.argv[1:])" "a b" '$HOME' "x'y" ""
+```
+
 Persistent shell session:
 
 ```bash
@@ -433,6 +463,11 @@ osb file replace <sandbox-id> /workspace/app.py --old old --new new -o json
 osb file chmod <sandbox-id> /workspace/script.sh --mode 755 -o json
 ```
 
+Downloads replace regular files only on success; a failed or interrupted
+download preserves any existing regular file. Existing devices and named pipes
+receive data directly. Stdout aliases (such as `/dev/stdout`) stream only the file
+bytes, without a success message. See the [CLI guide](../docs/cli/index.md#work-with-files).
+
 ### Manage runtime egress policy
 
 Inspect current policy:
@@ -453,26 +488,46 @@ If you are debugging connectivity, verify behavior with an actual command:
 osb command run <sandbox-id> -o raw -- curl -I https://pypi.org
 ```
 
+### Manage Credential Vault
+
+Credential Vault operations call the sandbox egress sidecar through the Python SDK.
+Create the sandbox with `--credential-proxy` and an explicit network policy before
+writing vault state.
+
+```bash
+osb credential-vault create <sandbox-id> --file vault.yaml -o json
+osb credential-vault get <sandbox-id> -o json
+osb credential-vault patch <sandbox-id> --file mutation.yaml -o json
+osb credential-vault credential list <sandbox-id> -o json
+osb credential-vault binding list <sandbox-id> -o json
+osb credential-vault delete <sandbox-id> -o json
+```
+
+Use `--file -` to read a JSON/YAML payload from stdin. Do not pass plaintext
+credential values as command-line flags; keep them in the payload stream or file.
+
 ### Collect diagnostics
 
 Use the stable diagnostics commands for API-backed log and event descriptors.
 
 ```bash
-osb diagnostics events <sandbox-id> --scope lifecycle -o raw
 osb diagnostics events <sandbox-id> --scope runtime -o raw
+osb diagnostics events <sandbox-id> --scope all -o raw
 osb diagnostics logs <sandbox-id> --scope container -o raw
-osb diagnostics logs <sandbox-id> --scope lifecycle -o json
+osb diagnostics logs <sandbox-id> --scope all -o json
 osb diagnostics events <sandbox-id> --scope runtime -o json
 osb diagnostics logs <sandbox-id> --scope container -o yaml
 ```
 
-`--scope` is required for stable diagnostics. Common scopes are `lifecycle` and
-`container` for logs, and `lifecycle` and `runtime` for events. Raw output
-prints inline diagnostic text, or the content URL when diagnostics are
-delivered as a temporary URL. Structured CLI output follows the SDK/Python field
-style, for example `content_url`, `content_length`, and `expires_at`.
-Some server builds may return `DIAGNOSTICS_NOT_IMPLEMENTED` for scoped
-diagnostics until the stable backend implementation is enabled.
+`--scope` is required for stable diagnostics. The built-in server supports
+`container` and `all` for logs, and `runtime` and `all` for events. It returns
+`DIAGNOSTICS_SCOPE_UNSUPPORTED` for unavailable scopes, including lifecycle events.
+Best-effort scopes may include a `warnings` field when the backend can only
+provide a subset. Raw output prints inline
+diagnostic text, or the content URL when diagnostics are delivered as a
+temporary URL. Structured CLI output follows the SDK/Python field style, for
+example `content_url`, `content_length`, and `expires_at`. Older server builds
+may still return `DIAGNOSTICS_NOT_IMPLEMENTED` for scoped diagnostics.
 
 Legacy DevOps diagnostics remain experimental. Prefer `osb diagnostics logs/events`
 for stable API-backed log and event collection.

{opensandbox_cli-0.1.1 → opensandbox_cli-1.1.0}/README.md

@@ -6,6 +6,7 @@
 - run commands inside a sandbox
 - read and modify sandbox files
 - inspect runtime egress policy
+- manage sandbox-local Credential Vault state
 - collect low-level diagnostics
 - install OpenSandbox-specific skills for coding agents
 
@@ -50,6 +51,7 @@ opensandbox-server
 osb config init
 osb config set connection.domain localhost:8080
 osb config set connection.protocol http
+osb config set connection.api_key <your-api-key>
 osb config show -o json
 ```
 
@@ -147,6 +149,12 @@ osb sandbox create \
   --volumes-file volumes.json
 ```
 
+Create with Credential Vault proxy enabled:
+
+```bash
+osb sandbox create --image python:3.12 --network-policy-file network-policy.json --credential-proxy -o json
+```
+
 ### List and inspect sandboxes
 
 ```bash
@@ -158,6 +166,17 @@ osb sandbox metrics <sandbox-id>
 osb sandbox metrics <sandbox-id> --watch -o raw
 ```
 
+### Pause a sandbox
+
+Pause is asynchronous. `Pause request accepted` confirms that the server accepted
+the request, not that the sandbox has reached the `Paused` state. Poll the sandbox
+until the transition finishes:
+
+```bash
+osb sandbox pause <sandbox-id>
+osb sandbox get <sandbox-id> -o json
+```
+
 ### Expose a service
 
 ```bash
@@ -180,6 +199,17 @@ osb command status <sandbox-id> <execution-id> -o json
 osb command logs <sandbox-id> <execution-id> -o json
 ```
 
+By default the payload after `--` is joined into one shell command string, so
+pipelines, redirection, and `$VAR` expansion work as in a terminal. Add `--argv`
+to pass the arguments to the executable as a literal argv list (no shell) when
+values such as `$HOME`, quotes, embedded spaces, or empty strings must reach the
+process unchanged. `--argv` needs a sandbox image whose execd accepts argv
+requests:
+
+```bash
+osb command run <sandbox-id> -o raw --argv -- python3 -c "import sys; print(sys.argv[1:])" "a b" '$HOME' "x'y" ""
+```
+
 Persistent shell session:
 
 ```bash
@@ -201,6 +231,11 @@ osb file replace <sandbox-id> /workspace/app.py --old old --new new -o json
 osb file chmod <sandbox-id> /workspace/script.sh --mode 755 -o json
 ```
 
+Downloads replace regular files only on success; a failed or interrupted
+download preserves any existing regular file. Existing devices and named pipes
+receive data directly. Stdout aliases (such as `/dev/stdout`) stream only the file
+bytes, without a success message. See the [CLI guide](../docs/cli/index.md#work-with-files).
+
 ### Manage runtime egress policy
 
 Inspect current policy:
@@ -221,26 +256,46 @@ If you are debugging connectivity, verify behavior with an actual command:
 osb command run <sandbox-id> -o raw -- curl -I https://pypi.org
 ```
 
+### Manage Credential Vault
+
+Credential Vault operations call the sandbox egress sidecar through the Python SDK.
+Create the sandbox with `--credential-proxy` and an explicit network policy before
+writing vault state.
+
+```bash
+osb credential-vault create <sandbox-id> --file vault.yaml -o json
+osb credential-vault get <sandbox-id> -o json
+osb credential-vault patch <sandbox-id> --file mutation.yaml -o json
+osb credential-vault credential list <sandbox-id> -o json
+osb credential-vault binding list <sandbox-id> -o json
+osb credential-vault delete <sandbox-id> -o json
+```
+
+Use `--file -` to read a JSON/YAML payload from stdin. Do not pass plaintext
+credential values as command-line flags; keep them in the payload stream or file.
+
 ### Collect diagnostics
 
 Use the stable diagnostics commands for API-backed log and event descriptors.
 
 ```bash
-osb diagnostics events <sandbox-id> --scope lifecycle -o raw
 osb diagnostics events <sandbox-id> --scope runtime -o raw
+osb diagnostics events <sandbox-id> --scope all -o raw
 osb diagnostics logs <sandbox-id> --scope container -o raw
-osb diagnostics logs <sandbox-id> --scope lifecycle -o json
+osb diagnostics logs <sandbox-id> --scope all -o json
 osb diagnostics events <sandbox-id> --scope runtime -o json
 osb diagnostics logs <sandbox-id> --scope container -o yaml
 ```
 
-`--scope` is required for stable diagnostics. Common scopes are `lifecycle` and
-`container` for logs, and `lifecycle` and `runtime` for events. Raw output
-prints inline diagnostic text, or the content URL when diagnostics are
-delivered as a temporary URL. Structured CLI output follows the SDK/Python field
-style, for example `content_url`, `content_length`, and `expires_at`.
-Some server builds may return `DIAGNOSTICS_NOT_IMPLEMENTED` for scoped
-diagnostics until the stable backend implementation is enabled.
+`--scope` is required for stable diagnostics. The built-in server supports
+`container` and `all` for logs, and `runtime` and `all` for events. It returns
+`DIAGNOSTICS_SCOPE_UNSUPPORTED` for unavailable scopes, including lifecycle events.
+Best-effort scopes may include a `warnings` field when the backend can only
+provide a subset. Raw output prints inline
+diagnostic text, or the content URL when diagnostics are delivered as a
+temporary URL. Structured CLI output follows the SDK/Python field style, for
+example `content_url`, `content_length`, and `expires_at`. Older server builds
+may still return `DIAGNOSTICS_NOT_IMPLEMENTED` for scoped diagnostics.
 
 Legacy DevOps diagnostics remain experimental. Prefer `osb diagnostics logs/events`
 for stable API-backed log and event collection.

{opensandbox_cli-0.1.1 → opensandbox_cli-1.1.0}/pyproject.toml

@@ -1,4 +1,4 @@
-# Copyright 2026 Alibaba Group Holding Ltd.
+# Copyright 2026 The OpenSandbox Authors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -42,7 +42,9 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "opensandbox>=0.1.9,<0.2.0",
+    # `command run --argv` passes a list to commands.run; the SDK accepts a
+    # list there from 0.1.17. Release the CLI only after that SDK is published.
+    "opensandbox>=1.1.0,<2.0.0",
     "click>=8.1.0,<9.0",
     "rich>=13.0.0,<14.0",
     "pyyaml>=6.0,<7.0",
@@ -51,9 +53,9 @@ dependencies = [
 
 [project.urls]
 Homepage = "https://open-sandbox.ai"
-Repository = "https://github.com/alibaba/OpenSandbox"
+Repository = "https://github.com/opensandbox-group/OpenSandbox"
 Documentation = "https://open-sandbox.ai"
-Issues = "https://github.com/alibaba/OpenSandbox/issues"
+Issues = "https://github.com/opensandbox-group/OpenSandbox/issues"
 
 [project.scripts]
 opensandbox = "opensandbox_cli.main:cli"
@@ -64,8 +66,8 @@ source = "vcs"
 
 [tool.hatch.version.raw-options]
 root = ".."
-tag_regex = "^cli/v(?P<version>\\d+\\.\\d+\\.\\d+(?:[\\.\\w\\+\\-]*)?)$"
-git_describe_command = 'git describe --dirty --tags --long --match "cli/v*"'
+tag_regex = "^release-(?P<version>\\d+\\.\\d+\\.\\d+(?:[\\.\\w\\+\\-]*)?)$"
+git_describe_command = 'git describe --dirty --tags --long --match "release-*"'
 fallback_version = "0.1.1"
 
 [tool.hatch.build]

{opensandbox_cli-0.1.1 → opensandbox_cli-1.1.0}/src/opensandbox_cli/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2026 Alibaba Group Holding Ltd.
+# Copyright 2026 The OpenSandbox Authors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

{opensandbox_cli-0.1.1 → opensandbox_cli-1.1.0}/src/opensandbox_cli/__main__.py

@@ -1,4 +1,4 @@
-# Copyright 2026 Alibaba Group Holding Ltd.
+# Copyright 2026 The OpenSandbox Authors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

{opensandbox_cli-0.1.1 → opensandbox_cli-1.1.0}/src/opensandbox_cli/client.py

@@ -1,4 +1,4 @@
-# Copyright 2026 Alibaba Group Holding Ltd.
+# Copyright 2026 The OpenSandbox Authors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

{opensandbox_cli-0.1.1 → opensandbox_cli-1.1.0}/src/opensandbox_cli/commands/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2026 Alibaba Group Holding Ltd.
+# Copyright 2026 The OpenSandbox Authors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

{opensandbox_cli-0.1.1 → opensandbox_cli-1.1.0}/src/opensandbox_cli/commands/command.py

@@ -1,4 +1,4 @@
-# Copyright 2026 Alibaba Group Holding Ltd.
+# Copyright 2026 The OpenSandbox Authors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -51,17 +51,28 @@ def _run_command(
     workdir: str | None,
     timeout: timedelta | None,
     output_format: str | None,
+    argv: bool = False,
 ) -> None:
     """Shared implementation for ``command run``.
 
     Mode contract:
     - foreground (default): stream output directly, allow only ``-o raw``
     - background (``--background``): return a tracked execution object, allow structured output
+
+    Payload contract:
+    - default: join the arguments into one shell command string (works against
+      every deployed execd)
+    - ``--argv``: send the arguments as a literal argv list, no shell; needs an
+      execd that accepts the ``argv`` request field
     """
     allowed = ("table", "json", "yaml") if background else ("raw",)
     fallback = "table" if background else "raw"
     prepare_output(obj, output_format, allowed=allowed, fallback=fallback)
-    cmd_str = " ".join(shlex.quote(arg) for arg in command)
+    payload: str | list[str]
+    if argv:
+        payload = list(command)
+    else:
+        payload = " ".join(shlex.quote(arg) for arg in command)
     sandbox = obj.connect_sandbox(sandbox_id)
 
     try:
@@ -72,7 +83,7 @@ def _run_command(
         )
 
         if background:
-            execution = sandbox.commands.run(cmd_str, opts=opts)
+            execution = sandbox.commands.run(payload, opts=opts)
             obj.output.success_panel(
                 {
                     "execution_id": execution.id,
@@ -99,7 +110,7 @@ def _run_command(
             sys.stderr.flush()
 
         handlers = ExecutionHandlersSync(on_stdout=on_stdout, on_stderr=on_stderr)
-        execution = sandbox.commands.run(cmd_str, opts=opts, handlers=handlers)
+        execution = sandbox.commands.run(payload, opts=opts, handlers=handlers)
 
         # Ensure terminal prompt starts on a new line
         if last_text and not last_text.endswith("\n"):
@@ -124,13 +135,25 @@ def _handle_execution_error(obj: ClientContext, execution) -> None:
 @command_group.command(
     "run",
     help="Run a command in a sandbox. Use `--` before the sandbox command payload.",
-    epilog="Separator rule: use `--` before the sandbox command payload.",
+    epilog=(
+        "Separator rule: use `--` before the sandbox command payload.\n\n"
+        "By default the payload is joined into one shell command string. Add "
+        "`--argv` to pass the arguments to the executable as-is (no shell), so "
+        "literal `$HOME`, quotes, and empty strings are preserved; this needs a "
+        "sandbox image whose execd accepts argv requests."
+    ),
 )
 @click.argument("sandbox_id")
 @click.argument("command", nargs=-1, required=True)
 @click.option("-d", "--background", is_flag=True, default=False, help="Run in background.")
 @click.option("-w", "--workdir", default=None, help="Working directory.")
 @click.option("-t", "--timeout", type=DURATION, default=None, help="Command timeout (e.g. 30s, 5m).")
+@click.option(
+    "--argv",
+    is_flag=True,
+    default=False,
+    help="Pass the payload as a literal argv list (no shell). Requires an argv-capable execd.",
+)
 @output_option("table", "json", "yaml", "raw")
 @click.pass_obj
 @handle_errors
@@ -141,12 +164,14 @@ def command_run(
     background: bool,
     workdir: str | None,
     timeout: timedelta | None,
+    argv: bool,
     output_format: str | None,
 ) -> None:
     """Run a command in a sandbox.
 
     Default mode streams output directly. Add ``--background`` to return a
     tracked execution object instead. Use ``--`` before the sandbox command payload.
+    The payload is sent as a shell command string unless ``--argv`` is given.
     """
     _run_command(
         obj,
@@ -156,6 +181,7 @@ def command_run(
         workdir,
         timeout,
         output_format,
+        argv=argv,
     )
 
 

{opensandbox_cli-0.1.1 → opensandbox_cli-1.1.0}/src/opensandbox_cli/commands/config_cmd.py

@@ -1,4 +1,4 @@
-# Copyright 2026 Alibaba Group Holding Ltd.
+# Copyright 2026 The OpenSandbox Authors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.