Raxol.AgentClientProtocol.Schema.ClientTypes.CreateTerminalRequest (Raxol Agent Client Protocol v0.1.0)

Copy Markdown View Source

Request to create a new terminal and execute a command (terminal/create).

env is a list of Raxol.AgentClientProtocol.Schema.AgentTypes.EnvVariable (nested under AgentTypes in agent_types.ex; see this file's header comment for the cross-module naming note).

Fixed defect (wire-shape, vs. schema-oracle)

Upstream modeled a timeoutMs field that does not exist in the pinned schema-v1.19.0 schema, and omitted the oracle's outputByteLimit (nullable uint64) field entirely. timeout_ms was dropped; output_byte_limit was added.

Ported from the MIT f1729/agent_client_protocol (c) 2025 f1729; see NOTICE.md.

Summary

Types

t()

Functions

from_json(map)

Total: never raises. Missing/non-string sessionId/command is the only failure mode.

new(session_id, command)
to_json(r)

Types

t()

@type t() :: %Raxol.AgentClientProtocol.Schema.ClientTypes.CreateTerminalRequest{
  _meta: map(),
  args: [String.t()],
  command: String.t(),
  cwd: String.t() | nil,
  env: [Raxol.AgentClientProtocol.Schema.AgentTypes.EnvVariable.t()],
  output_byte_limit: non_neg_integer() | nil,
  session_id: String.t()
}

Functions

from_json(map)

@spec from_json(term()) :: {:ok, t()} | {:error, term()}

Total: never raises. Missing/non-string sessionId/command is the only failure mode.

new(session_id, command)

@spec new(String.t(), String.t()) :: t()

to_json(r)

@spec to_json(t()) :: map()