Terminal

import { CMDOPClient } from '@cmdop/node';
 
// Connect to the cloud relay and select the target machine
const client = await CMDOPClient.remote({ apiKey: 'cmdop_xxx' });
await client.terminal.setMachine('my-server');
 
// Execute a one-shot command and capture output + exit code
const { output, exitCode } = await client.terminal.execute('ls -la /var/log');
console.log(output.toString());
console.log('Exit code:', exitCode);

// Execute with a custom working directory, environment, and timeout
const { output, exitCode } = await client.terminal.execute('npm install', {
  cwd: '/app',                        // Run inside the /app directory
  env: { NODE_ENV: 'production' },     // Set environment variables
  timeout: 60000,                      // Fail after 60 seconds
});

// Create a streaming command executor
const stream = client.terminal.stream();
 
// Attach a callback for each chunk of stdout/stderr data
stream.onOutput((data) => {
  process.stdout.write(data.toString());
});
 
// Attach a callback for when the command exits
stream.onExit((code) => {
  console.log('Exited with code:', code);
});
 
// Start streaming a long-running command
await stream.execute('tail -f /var/log/app.log');

// Open an interactive bash session with custom terminal dimensions
const session = await client.terminal.createSession({
  shell: '/bin/bash',
  cols: 120,
  rows: 40,
});
 
// Handle output from the session
session.onOutput((data) => process.stdout.write(data));
 
// Send commands as if typing in a terminal (include newline to submit)
await session.sendInput('ls -la\n');
await session.sendInput('cd /app\n');

// Dynamically resize the terminal dimensions
await session.resize({ cols: 200, rows: 50 });

// Send SIGINT (equivalent to Ctrl+C) to interrupt a running command
await session.signal('SIGINT');
 
// Send SIGTERM to gracefully terminate the process
await session.signal('SIGTERM');

// Close the interactive session and release resources
await session.close();

// Set the target machine for subsequent terminal commands
await client.terminal.setMachine('prod-server');
 
// Switch to a different machine mid-session
await client.terminal.setMachine('staging-server');