Miosa.Sandbox.Terminal (Miosa v1.0.0)

Copy Markdown View Source

PTY session control for a sandbox.

  • POST /sandboxes/:id/terminal — create/2
  • DELETE /sandboxes/:id/terminal/:session_id — delete/3

Summary

Functions

create(client, sandbox_id, opts \\ %{})

Open a new PTY session (POST /sandboxes/:sandbox_id/terminal).

delete(client, sandbox_id, session_id)

Delete a PTY session (DELETE /sandboxes/:sandbox_id/terminal/:session_id).

Functions

create(client, sandbox_id, opts \\ %{})

@spec create(Miosa.Client.t(), String.t(), map()) :: Miosa.Client.result(map())

Open a new PTY session (POST /sandboxes/:sandbox_id/terminal).

Options map keys

  • "cols" — Terminal column width.
  • "rows" — Terminal row count.
  • "shell" — Shell binary path.
  • "cwd" — Working directory.
  • "env" — Environment variables map.

delete(client, sandbox_id, session_id)

@spec delete(Miosa.Client.t(), String.t(), String.t()) ::
  :ok | {:error, Miosa.Error.t()}

Delete a PTY session (DELETE /sandboxes/:sandbox_id/terminal/:session_id).