pocketenv-io.sandbox — io.pocketenv/pocketenv 0.1.1-SNAPSHOT

Sandbox record and pipe-safe operations.

The Sandbox record is the central type of the SDK. Obtain one from pocketenv-io.pocketenv/create-sandbox or get-sandbox, then pipe operations with Clojure's -> threading macro:

(-> (pocketenv/create-sandbox "my-box") (sandbox/start) (sandbox/wait-until-running) (sandbox/exec "clojure" ["-M:test"]))

Every operation accepts either a bare Sandbox record or an {:ok sandbox} result map, enabling seamless threading. Passing {:error reason} raises an exception, keeping error handling explicit.

delete clj

(delete sandbox-or-result)

(delete sandbox-or-result opts)

Deletes the sandbox permanently. Returns {:ok sandbox} with last known state.

Options: :token

delete-secret clj

(delete-secret sandbox-or-result id)

(delete-secret sandbox-or-result id opts)

Deletes a secret by its id.

Options: :token

exec clj

(exec sandbox-or-result cmd)

(exec sandbox-or-result cmd args)

(exec sandbox-or-result cmd args opts)

Executes a shell command inside the sandbox.

Returns {:ok ExecResult} with :stdout, :stderr, :exit-code.

Options: :token

exec-result-from-map clj

(exec-result-from-map m)

expose clj

(expose sandbox-or-result port)

(expose sandbox-or-result port opts)

Exposes a port on the sandbox. Returns {:ok preview-url-or-nil}.

Options: :description, :token

get-ssh-keys clj

(get-ssh-keys sandbox-or-result)

(get-ssh-keys sandbox-or-result opts)

Fetches the SSH key pair for the sandbox.

Options: :token

get-tailscale-auth-key clj

(get-tailscale-auth-key sandbox-or-result)

(get-tailscale-auth-key sandbox-or-result opts)

Fetches the Tailscale auth key for the sandbox.

Options: :token

list-ports clj

(list-ports sandbox-or-result)

(list-ports sandbox-or-result opts)

Lists all exposed ports on the sandbox.

Returns {:ok [Port]}

list-secrets clj

(list-secrets sandbox-or-result)

(list-secrets sandbox-or-result opts)

Lists all secrets for the sandbox.

Options: :limit (default 100), :offset (default 0), :token

port-from-map clj

(port-from-map m)

profile-from-map clj

(profile-from-map m)

sandbox-from-map clj

(sandbox-from-map m)

secret-from-map clj

(secret-from-map m)

set-secret clj

(set-secret sandbox-or-result name value)

(set-secret sandbox-or-result name value opts)

Adds an encrypted secret to the sandbox.

Options: :token

set-ssh-keys clj

(set-ssh-keys sandbox-or-result private-key public-key)

(set-ssh-keys sandbox-or-result private-key public-key opts)

Stores an SSH key pair. The private key is encrypted client-side.

Options: :token

set-tailscale-auth-key clj

(set-tailscale-auth-key sandbox-or-result auth-key)

(set-tailscale-auth-key sandbox-or-result auth-key opts)

Stores a Tailscale auth key. Must start with "tskey-auth-". Encrypted client-side before transmission.

Options: :token

ssh-key-from-map clj

(ssh-key-from-map m)

start clj

(start sandbox-or-result)

(start sandbox-or-result opts)

Starts the sandbox. Re-fetches state after the call.

Options: :repo, :keep-alive, :token

stop clj

(stop sandbox-or-result)

(stop sandbox-or-result opts)

Stops the sandbox. Re-fetches state after the call.

Options: :token

tailscale-auth-key-from-map clj

(tailscale-auth-key-from-map m)

unexpose clj

(unexpose sandbox-or-result port)

(unexpose sandbox-or-result port opts)

Removes an exposed port. Returns {:ok sandbox}.

Options: :token

vscode clj

(vscode sandbox-or-result)

(vscode sandbox-or-result opts)

Exposes VS Code Server and returns its URL.

Returns {:ok preview-url-or-nil}

Options: :token

wait-until-running clj

(wait-until-running sandbox-or-result)

(wait-until-running sandbox-or-result opts)

Polls until the sandbox status becomes :running.

Options: :timeout-ms (default 60000), :interval-ms (default 2000), :token