Skip to main content

DockerSandbox

Struct DockerSandbox 

Source
pub struct DockerSandbox { /* private fields */ }
Expand description

Manages a Docker sandbox container lifecycle

Implementations§

Source§

impl DockerSandbox

Source

pub fn new(config: SandboxConfig, workspace_path: impl Into<String>) -> Self

Source

pub fn set_proxy(&mut self, port: u16)

Enable the API proxy: the container will use ANTHROPIC_BASE_URL instead of receiving the raw API key.

Source

pub async fn image_exists(image: &str) -> bool

Check if a Docker image exists locally.

Source

pub async fn auto_build_image(image: &str) -> Result<()>

Auto-build the default sandbox image from the embedded Dockerfile. Writes the Dockerfile to a temp dir and runs docker build.

Source

pub async fn is_docker_available() -> bool

Check if Docker is available in PATH

Source

pub async fn is_sandbox_available() -> bool

Check if Docker Desktop >= 4.40 is available (required for Docker Sandbox). Falls back to checking that docker is simply available when version detection fails (useful in CI environments where Docker CE is sufficient).

Source

pub async fn create(&mut self) -> Result<()>

Create the sandbox container (without starting it)

Source

pub async fn copy_workspace(&self, src: &str) -> Result<()>

Copy a host directory into the running sandbox container.

When the config has exclude patterns, we use tar --exclude piped into docker cp to skip large directories like node_modules/ and target/ that would otherwise make the copy prohibitively slow.

Note: macOS tar emits many harmless warnings about extended attributes (LIBARCHIVE.xattr.*) when the receiving Linux tar doesn’t understand them. We suppress these via --no-xattrs and --no-mac-metadata flags and only fail on real errors (e.g. source directory missing).

Source

pub async fn run_command(&self, cmd: &str) -> Result<SandboxOutput>

Run a shell command inside the sandbox and return the output

Source

pub async fn run_command_as_user( &self, cmd: &str, user: &str, ) -> Result<SandboxOutput>

Run a shell command inside the sandbox as a specific user. Used for agent steps that need non-root execution (Claude CLI refuses --dangerously-skip-permissions when running as root).

Source

pub async fn copy_results(&self, dest: &str) -> Result<()>

Copy results from the sandbox back to the host.

First checks whether any files were actually modified inside the container (via git status --porcelain). If nothing changed, the copy is skipped entirely — this is the common case for read-only workflows like code-review.

Source

pub async fn destroy(&mut self) -> Result<()>

Stop and remove the sandbox container (safe to call even if not created)

Trait Implementations§

Source§

impl Drop for DockerSandbox

Drop impl ensures cleanup even if destroy() was not called explicitly

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,