Quickstart

npm install cyberdesk
# or
yarn add cyberdesk
# or
pnpm add cyberdesk

import { createCyberdeskClient } from 'cyberdesk';
 
const cyberdesk = createCyberdeskClient({
  apiKey: 'YOUR_API_KEY',
  // Optionally, you can override the baseUrl or provide a custom fetch implementation
});

const launchResult = await cyberdesk.launchDesktop({
  body: { timeout_ms: 600000 } // Optional: 10-minute timeout
});
 
if ('error' in launchResult) {
  throw new Error('Failed to launch desktop: ' + launchResult.error);
}
 
const desktopId = launchResult.id;

const info = await cyberdesk.getDesktop({ path: { id: desktopId } });
 
if ('error' in info) {
  throw new Error('Failed to get desktop info: ' + info.error);
}
 
console.log('Desktop info:', info);
console.log('Stream URL:', info.stream_url);

const actionResult = await cyberdesk.executeComputerAction({
  path: { id: desktopId },
  body: {
    type: 'click_mouse',
    x: 100,
    y: 150,
    button: 'left'
  }
});
 
if ('error' in actionResult) {
  throw new Error('Mouse click failed: ' + actionResult.error);
}

const bashResult = await cyberdesk.executeBashAction({
  path: { id: desktopId },
  body: {
    command: 'ls -la /tmp'
  }
});
 
if ('error' in bashResult) {
  throw new Error('Bash command failed: ' + bashResult.error);
}
 
console.log('Bash command output:', bashResult.output);

const terminateResult = await cyberdesk.terminateDesktop({
  path: { id: desktopId }
});
 
if ('error' in terminateResult) {
  // You might still want to proceed even if termination fails
}

// All methods are available as async functions (see above)

// All request/response types are available from the generated models