Skip to content
Lightcone Lightcone
NorthstarPlatformPricingLogin
API Reference
Computers

Execute debug command (deprecated — use /exec)

computers.debug(strid, ComputerDebugParams**kwargs) -> ActionResult
POST/computers/{id}/debug

Deprecated — prefer /exec (streaming NDJSON) or /exec/sync (buffered JSON). Executes a shell command inside the session and returns a buffered result with stdout, stderr, and exit_code. This endpoint always runs synchronously; for real-time output use /exec, which streams command output line by line.

tab_id is accepted for compatibility but is only meaningful on browser-session actions; debug commands run in desktop sessions. timeout_seconds defaults to 120; max_output_length defaults to 65536 bytes and truncates stdout / stderr.

ParametersExpand Collapse
id: str
command: Optional[str]
max_output_length: Optional[int]
tab_id: Optional[str]
timeout_seconds: Optional[int]
ReturnsExpand Collapse
class ActionResult: …
error_message: Optional[str]
executed_tab_id: Optional[str]
page_context: Optional[PageContext]
device_scale_factor: Optional[float]
is_main_tab: Optional[bool]
page_height: Optional[int]
page_width: Optional[int]
scroll_x: Optional[float]
scroll_y: Optional[float]
tab_id: Optional[str]
title: Optional[str]
url: Optional[str]
viewport_height: Optional[int]
viewport_width: Optional[int]
request_id: Optional[str]
result: Optional[Dict[str, object]]
status: Optional[str]
timestamp: Optional[str]

Execute debug command (deprecated — use /exec)

import os
from tzafon import Lightcone

client = Lightcone(
    api_key=os.environ.get("TZAFON_API_KEY"),  # This is the default and can be omitted
)
action_result = client.computers.debug(
    id="id",
)
print(action_result.executed_tab_id)
{
  "error_message": "error_message",
  "executed_tab_id": "executed_tab_id",
  "page_context": {
    "device_scale_factor": 0,
    "is_main_tab": true,
    "page_height": 0,
    "page_width": 0,
    "scroll_x": 0,
    "scroll_y": 0,
    "tab_id": "tab_id",
    "title": "title",
    "url": "url",
    "viewport_height": 0,
    "viewport_width": 0
  },
  "request_id": "request_id",
  "result": {
    "foo": "bar"
  },
  "status": "status",
  "timestamp": "timestamp"
}
Returns Examples
{
  "error_message": "error_message",
  "executed_tab_id": "executed_tab_id",
  "page_context": {
    "device_scale_factor": 0,
    "is_main_tab": true,
    "page_height": 0,
    "page_width": 0,
    "scroll_x": 0,
    "scroll_y": 0,
    "tab_id": "tab_id",
    "title": "title",
    "url": "url",
    "viewport_height": 0,
    "viewport_width": 0
  },
  "request_id": "request_id",
  "result": {
    "foo": "bar"
  },
  "status": "status",
  "timestamp": "timestamp"
}