环境设置

系统要求

• TypeScript/JavaScript
  Node.js 14及以上版本
  建议安装在维护期内的LTS版本

• Window版本要求
  Windows 8.1 或 Windows Server 2012 R2 及以上

• Linux版本要求
  kernel>=3.10

安装方法

npm 安装

npm install @ctyun/desktop-agent-sdk

yarn 安装

yarn add @ctyun/desktop-agent-sdk

pnpm 安装

pnpm add @ctyun/desktop-agent-sdk

基本使用方法

创建 Client 实例

首先导入并创建 Client 实例。创建实例时需要提供以下参数：

• apiKey (必需): 控制台上的AccessKey ID

• apiSecret (必需): 控制台上的AccessKey Secret

• desktopCode (必需): 桌面编码

• serviceURL (可选): 服务地址，默认为 https://desk.ctyun.cn:8816

import Client from '@ctyun/desktop-agent-sdk';

const client = new Client({
  apiKey: 'your-api-key',
  apiSecret: 'your-api-secret',
  desktopCode: 'your-desktop-code',
  serviceURL: 'https://desk.ctyun.cn:8816' // 可选，使用默认值
});

创建会话

使用 createSession() 方法创建会话，会话创建成功后将返回会话对象，包含 sessionId 和操作方法。

const session = await client.createSession();
console.log('会话创建成功，sessionId:', session.sessionId);

使用 computer 方法

创建会话后，可以通过 session.computer 对象调用各种计算机控制方法。

移动鼠标

// 将鼠标移动到指定坐标
await session.computer.move_mouse({x:500, y:300});

点击鼠标

// 在指定坐标点击鼠标（默认左键、按下并释放）
await session.computer.click_mouse({x:500, y:300});

// 点击一下左键
await session.computer.click_mouse({x:500, y:300, clickMode:'left'});

// 点击一下右键
await session.computer.click_mouse({x:500, y:300, clickMode:'right'});

// 双击一下鼠标
await session.computer.click_mouse({x:500, y:300, clickMode:'double_left'});

// 仅按下鼠标左键（不释放）
await session.computer.click_mouse({x:500, y:300, clickMode:'left', pressMode:true, releaseMode:false});

// 仅释放鼠标
await session.computer.click_mouse({x:500, y:300, clickMode:'left', pressMode:false, releaseMode:true});

拖拽鼠标

// 从起始坐标拖拽到目标坐标
await session.computer.drag_mouse({startX:500, startY:300, endX:800, endY:500});

滚动

// 在指定位置滚动（Direction: 'up' 或 'down'）
await session.computer.scroll({startX:500, startY:300, direction:'down', amount:3});

按下键盘按键

// 按下键盘按键（如 Enter）
await session.computer.press_key({key:'Enter'});

输入文本

// 输入文本
await session.computer.type_text({text:'Hello World'});

屏幕截图

// 截取屏幕
await session.computer.screen_shot();

获取鼠标位置

// 获取当前鼠标位置
await session.computer.get_cursor_position();

关闭会话

使用完成后，应该关闭会话以释放资源。

await session.close();

console.log('会话已关闭');