Cyberdriver Installation

What is Cyberdriver?

Cyberdriver is a small, simple executable that connects your desktop to Cyberdesk, enabling AI-powered automation of any desktop task. It provides a secure bridge between Cyberdesk’s cloud infrastructure and your local machine.

Key Features

Local HTTP Server - All endpoints for display, keyboard, and mouse control
WebSocket Tunnel - Secure connection to Cyberdesk cloud
Screenshot Capture - With intelligent scaling modes
Advanced Keyboard Input - Support for complex key sequences
Automatic Reconnection - Robust connection handling with exponential backoff

No Firewall Configuration Required

Unlike traditional remote desktop solutions, Cyberdriver doesn’t require you to open any inbound firewall ports. It works through a secure reverse tunnel, connecting outbound to Cyberdesk Cloud. This means:

✅ Works behind corporate firewalls
✅ No router configuration needed
✅ No exposed ports on your machine
✅ Secure, encrypted connection

Installation

Mac & Linux Support: We’re actively working to support Mac and Linux versions of Cyberdriver. If you’d like to see this prioritized, please let us know at founders@cyberdesk.io!

Windows PowerShell Installation

The easiest way to install Cyberdriver on Windows is using our PowerShell installer.

Admin Privileges: Cyberdriver does not require administrator privileges by default. However, if you need to automate desktop applications that require admin rights to start (such as many legacy enterprise applications), you must run cyberdriver from an Administrator PowerShell terminal:

Right-click on PowerShell and select “Run as Administrator”
Navigate to your desired directory
Run cyberdriver join --secret YOUR_KEY

For regular user-level applications, you can run cyberdriver normally without admin privileges.

Run the installer in PowerShell

# Create tool directory
$toolDir = "$env:USERPROFILE\.cyberdriver"
New-Item -ItemType Directory -Force -Path $toolDir

# Download cyberdriver
Invoke-WebRequest -Uri "https://github.com/cyberdesk-hq/cyberdriver/releases/download/v0.0.15/cyberdriver.exe" -OutFile "$toolDir\cyberdriver.exe"

# Add to PATH if not already there
$userPath = [Environment]::GetEnvironmentVariable("Path", "User")
if ($userPath -notlike "*$toolDir*") {
    [Environment]::SetEnvironmentVariable("Path", $userPath + ";" + $toolDir, "User")
}

Write-Host "Cyberdriver installed! You may need to restart your terminal for PATH changes to take effect."

Restart PowerShell

Close and reopen your PowerShell terminal for the PATH changes to take effect. Once restarted, you’re ready to connect to Cyberdesk Cloud in the next section.

Cyberdriver automatically disables PowerShell’s QuickEdit Mode on startup. This prevents the terminal from freezing when you accidentally click on it while Cyberdriver is running.

Getting Started

Connect to Cyberdesk Cloud

To connect your desktop to Cyberdesk for remote automation:

cyberdriver join --secret YOUR_API_KEY

Replace YOUR_API_KEY with your actual API key from the Cyberdesk Dashboard.

When you run cyberdriver join, Cyberdriver connects your machine to Cyberdesk Cloud using your API key. You can view the machine in the Cyberdesk Dashboard; the machine ID is managed in the backend and not printed by the CLI.

Local Development Mode

While most users will connect to Cyberdesk Cloud, you can also run Cyberdriver in standalone mode for local development and testing:

cyberdriver start

This starts Cyberdriver with just the local API server on http://localhost:3000, without connecting to Cyberdesk Cloud.

Common Issues

TLS Certificate Errors

If you encounter TLS certificate errors when connecting to Cyberdesk, run this PowerShell script to install the required certificates:

Fix TLS Certificate Errors

# Check if running as admin
$isAdmin = ([Security.Principal.WindowsPrincipal] [Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)

if ($isAdmin) {
    $store = "Cert:\LocalMachine\Root"
    Write-Host "Running as Administrator - installing system-wide" -ForegroundColor Green
} else {
    $store = "Cert:\CurrentUser\Root"
    Write-Host "Running as user - installing for current user only" -ForegroundColor Yellow
}

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

# Only the working certificate URLs
$certs = @(
    @{
        Name = "ISRG Root X1"
        Url = "https://letsencrypt.org/certs/isrgrootx1.der"
    }
)

foreach ($cert in $certs) {
    try {
        Write-Host "Downloading $($cert.Name)..." -ForegroundColor Cyan
        $tempFile = "$env:TEMP\$($cert.Name -replace ' ','_').der"
        Invoke-WebRequest -Uri $cert.Url -OutFile $tempFile -UseBasicParsing
        
        $certObj = Import-Certificate -FilePath $tempFile -CertStoreLocation $store
        Write-Host "✓ Installed $($cert.Name)" -ForegroundColor Green
        
        Remove-Item $tempFile -Force -ErrorAction SilentlyContinue
    } catch {
        Write-Host "✗ Failed to install $($cert.Name): $_" -ForegroundColor Red
    }
}

After running this script, retry the cyberdriver join command.

Connection Issues

If Cyberdriver fails to connect or keeps disconnecting:

Verify your API key - Make sure you’re using a valid API key from your dashboard
Check your internet connection - Cyberdriver requires a stable internet connection
Check application permissions - If automating admin-level apps, ensure you’re running cyberdriver from an Administrator PowerShell terminal

Performance Issues

If automation seems slow or unresponsive:

Close unnecessary applications - Free up system resources
Check CPU usage - High CPU usage can affect automation performance
Disable Windows animations - This can speed up window switching

Configuration

Cyberdriver stores its configuration in Windows at:

%LOCALAPPDATA%\.cyberdriver\config.json

The configuration file includes:

Version: Current Cyberdriver version
Fingerprint: Unique machine identifier
Connection settings: Host and authentication details

API Endpoints

Cyberdriver always starts a local HTTP server on port 3000. When you use cyberdriver join, it additionally creates a secure reverse tunnel to Cyberdesk Cloud, allowing remote access without opening any inbound ports. The local server exposes these endpoints:

Display

GET /computer/display/screenshot - Capture screen
- Query params: width, height, mode (exact/aspect_fit/aspect_fill)
- Returns: PNG image
GET /computer/display/dimensions - Get screen dimensions

Keyboard

POST /computer/input/keyboard/type - Type text
- Body: {"text": "Hello world"}
POST /computer/input/keyboard/key - Send key combinations
- Body: {"text": "ctrl+c"} (XDO style: ‘ctrl+c’, ‘alt+tab’, ‘cmd+a’)

Mouse

GET /computer/input/mouse/position - Get cursor position
POST /computer/input/mouse/move - Move cursor instantly
- Body: {"x": 100, "y": 200}
POST /computer/input/mouse/click - Click mouse button
- Body: {"button": "left", "down": true/false, "x": 100, "y": 200}

File System

GET /computer/fs/list - List directory contents
- Query param: path (defaults to current directory)
GET /computer/fs/read - Read file contents
- Query param: path (required)
- Returns: Base64 encoded content (100MB limit)
POST /computer/fs/write - Write file contents
- Body: {"path": "/path/to/file", "content": "base64_encoded_data", "mode": "write/append"}

PowerShell

POST /computer/shell/powershell/exec - Execute PowerShell commands
- Body: {"command": "Get-Process", "timeout": 30, "working_directory": "C:\\"}
POST /computer/shell/powershell/session - Manage PowerShell sessions
- Body: {"action": "create/destroy", "session_id": "uuid"}

Security Considerations

Cyberdriver provides remote access to your desktop. Follow these security best practices:

Keep your API key secret - Never share or commit it to version control
Use on trusted networks - Avoid public WiFi when possible
Monitor active connections - Check your dashboard for unexpected activity
Update regularly - Install Cyberdriver updates for security patches

Next Steps

Now that you have Cyberdriver installed and connected:

Quick Start Guide

Create and run your first workflow

SDK Guides

Learn how to trigger runs programmatically

Dashboard

Create workflows and manage machines

Support

Get help from the Cyberdesk team

Getting started

SDK Guides

Cyberdriver

Workflow Prompting

What is Cyberdriver?

Key Features

No Firewall Configuration Required

Installation

Windows PowerShell Installation

Getting Started

Connect to Cyberdesk Cloud

Local Development Mode

Common Issues

TLS Certificate Errors

Connection Issues

Performance Issues

Configuration

API Endpoints

Display

Keyboard

Mouse

File System

PowerShell

Security Considerations

Next Steps

Quick Start Guide

SDK Guides

Dashboard

Support

Getting started

SDK Guides

Cyberdriver

Workflow Prompting

​What is Cyberdriver?

​Key Features

​No Firewall Configuration Required

​Installation

​Windows PowerShell Installation

​Getting Started

​Connect to Cyberdesk Cloud

​Local Development Mode

​Common Issues

​TLS Certificate Errors

​Connection Issues

​Performance Issues

​Configuration

​API Endpoints

​Display

​Keyboard

​Mouse

​File System

​PowerShell

​Security Considerations

​Next Steps

Quick Start Guide

SDK Guides

Dashboard

Support

What is Cyberdriver?

Key Features

No Firewall Configuration Required

Installation

Windows PowerShell Installation

Getting Started

Connect to Cyberdesk Cloud

Local Development Mode

Common Issues

TLS Certificate Errors

Connection Issues

Performance Issues

Configuration

API Endpoints

Display

Keyboard

Mouse

File System

PowerShell

Security Considerations

Next Steps