Returns a list of all background processes in the sandbox, including running, completed, and failed processes.
Method Signature
await sandbox.listProcesses(
sessionId?: string
): Promise<Process[]>
Parameters
Optional session ID. If not provided, the default session is used.
Returns
Array of Process objects
Unique process identifier
System process ID (if available and running)
Command that was executed
Current process status: 'starting' | 'running' | 'completed' | 'failed' | 'killed' | 'error'
When the process was started
When the process ended (if completed)
Process exit code (if completed)
Examples
List all processes
const processes = await sandbox.listProcesses();
for (const process of processes) {
console.log(`${process.id}: ${process.command} (${process.status})`);
}
Filter running processes
const processes = await sandbox.listProcesses();
const running = processes.filter(p => p.status === 'running');
console.log(`${running.length} processes running`);
Check process status
const processes = await sandbox.listProcesses();
const server = processes.find(p => p.command.includes('server'));
if (server && server.status === 'running') {
console.log('Server is running');
}