Skip to content

AnyDesk

AnyDesk is a remote desktop app for connecting to remote devices. Protocol Launcher allows you to generate AnyDesk URL handlers for remote sessions and license registration.

Usage

There are two ways to use this library:

  • On-Demand import from subpaths enables tree-shaking and keeps bundles small.
  • Full Import from the root package is convenient but includes all app modules.

Pick On-Demand for production builds; Full Import is fine for quick scripts or demos.

Select Installation Method

On-Demand
Recommended. Optimized for production.
Full Import
Convenient. Good for quick scripts.

Connect

AnyDesk documents the standard remote-session URL as anydesk:<anydesk-id-or-alias>.

On-Demand
ts
import { connect } from 'protocol-launcher/anydesk'

const url = connect({
  idOrAlias: 'user@namespace',
})

Connect Custom Client

AnyDesk documents anydesk-<prefix>:<anydesk-id-or-alias> for non-MSI custom clients.

On-Demand
ts
import { connectCustomClient } from 'protocol-launcher/anydesk'

const nonMsiUrl = connectCustomClient({
  prefix: 'example',
  idOrAlias: '123456789',
})

Connect Custom Client MSI

AnyDesk documents anydesk:AnyDesk-<prefix>_msi:<anydesk-id-or-alias> for MSI custom clients.

On-Demand
ts
import { connectCustomClientMsi } from 'protocol-launcher/anydesk'

const msiUrl = connectCustomClientMsi({
  prefix: 'example',
  idOrAlias: '123456789',
})

Register License

AnyDesk documents license registration as anydesk://register-license?key=LICENSE-KEY.

On-Demand
ts
import { registerLicense } from 'protocol-launcher/anydesk'

const url = registerLicense({
  key: 'LICENSE-KEY',
})

const silentUrl = registerLicense({
  key: 'LICENSE-KEY',
  silent: true,
})

Register License Custom Client

AnyDesk documents anydesk-<prefix>://register-license?key=LICENSE-KEY for non-MSI custom clients.

On-Demand
ts
import { registerLicenseCustomClient } from 'protocol-launcher/anydesk'

const url = registerLicenseCustomClient({
  prefix: 'example',
  key: 'LICENSE-KEY',
})

Register License Custom Client MSI

AnyDesk documents anydesk:AnyDesk-<prefix>_msi://register-license?key=LICENSE-KEY for MSI custom clients.

On-Demand
ts
import { registerLicenseCustomClientMsi } from 'protocol-launcher/anydesk'

const url = registerLicenseCustomClientMsi({
  prefix: 'example',
  key: 'LICENSE-KEY',
})

Appending &silent is supported on license registration URLs by passing silent: true. These examples intentionally do not render live launch buttons because the official handlers can start a remote session or submit a license key. See the official AnyDesk URL Handler documentation.