Skip to content
Lightcone Lightcone
NorthstarPlatformPricingLogin
API Reference
Computers

Execute debug command (deprecated — use /exec)

client.computers.debug(stringid, ComputerDebugParams { command, max_output_length, tab_id, timeout_seconds } body, RequestOptionsoptions?): ActionResult { error_message, executed_tab_id, page_context, 4 more }
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: string
body: ComputerDebugParams { command, max_output_length, tab_id, timeout_seconds }
command?: string
max_output_length?: number
tab_id?: string
timeout_seconds?: number
ReturnsExpand Collapse
ActionResult { error_message, executed_tab_id, page_context, 4 more }
error_message?: string
executed_tab_id?: string
page_context?: PageContext { device_scale_factor, is_main_tab, page_height, 8 more }
device_scale_factor?: number
is_main_tab?: boolean
page_height?: number
page_width?: number
scroll_x?: number
scroll_y?: number
tab_id?: string
title?: string
url?: string
viewport_height?: number
viewport_width?: number
request_id?: string
result?: Record<string, unknown>
status?: string
timestamp?: string

Execute debug command (deprecated — use /exec)

import Lightcone from '@tzafon/lightcone';

const client = new Lightcone({
  apiKey: process.env['TZAFON_API_KEY'], // This is the default and can be omitted
});

const actionResult = await client.computers.debug('id');

console.log(actionResult.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"
}