Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

xLab Quick Start

This document is intended for students of Peking University only, so it will be in Chinese.

安装SSH

Windows

Windows 10(版本 1809 及之后)和 Windows 11 通常已经自带 OpenSSH 客户端。打开“设置”→“应用”→“可选功能”,在列表中确认已安装“OpenSSH 客户端”;如果没有,点击“查看功能”,搜索并安装它。也可以使用管理员身份打开 PowerShell,执行:

Add-WindowsCapability -Online -Name OpenSSH.Client~~~~0.0.1.0

安装完成后打开 PowerShell 或“Windows Terminal”,检查 SSH 是否可用:

ssh -V

macOS

macOS 已经自带 OpenSSH。打开“终端”(可在“应用”→“实用工具”中找到),检查 SSH 是否可用:

ssh -V

生成 SSH 密钥对

在 PowerShell、Windows Terminal 或 macOS 的“终端”中执行以下命令。命令中的邮箱仅用于标识密钥,可以替换为自己的邮箱:

ssh-keygen -t ed25519 -C "your_email@example.com"

看到 Enter file in which to save the key 时直接按回车,使用默认保存位置;看到 Enter passphrase 时可以设置一个密钥密码,也可以直接按回车留空。命令会生成一对密钥:

  • 私钥:Windows 通常位于 C:\Users\你的用户名\.ssh\id_ed25519,macOS 位于 ~/.ssh/id_ed25519。私钥只能自己保存,不能上传或发送给他人。
  • 公钥:与私钥同名并以 .pub 结尾,即 id_ed25519.pub。接下来需要将公钥的完整内容添加到 xLab。

查看并复制公钥内容:

Windows(PowerShell):

Get-Content $HOME\.ssh\id_ed25519.pub

macOS:

cat ~/.ssh/id_ed25519.pub

复制输出的整行文本(以 ssh-ed25519 开头),不要复制私钥。然后继续下面“配置 xLab”中的“添加公钥”步骤。

在xLab上添加公钥

首先,访问xLab主页,完成登录,进入“我的节点”界面。然后点击右上角的账户按钮(显示文本为你的名字 s你的学号),会弹出一个表单。

在弹出的表单中,把你刚刚复制的公钥内容粘贴到“公钥”表单中,然后给你的公钥起一个你喜欢的名字。都填完后,点击添加公钥,退出表单进入到下一步。

在xLab上新建节点

回到“我的节点”界面,点击右上角的“新建节点”按钮。理论上你什么都不需要配置,直接点击新建节点即可。

节点创建可能需要一些时间,静待一到两分钟,刷新界面,如果你的节点显示“运行中”,说明创建已经成功。

连接xLab

通过网页终端

点击“通过网页终端”即可。

如果你需要完成大量的代码编写任务,不推荐通过这种形式连接,除非你是vim/nano/emacs/其他非图形化代码编辑器领域大神。(其实北大里还真有这样一位大神,他甚至非常年轻,他就是Prof. Mechtaev。)

通过本地终端

复制右侧的ssh -p ...指令,打开你的终端,粘贴,按回车即可。

比起网页终端,你或许可以整出更多的活,但是依旧不如直接用vscode。

通过vscode

首先,打开你的vscode,下载拓展Remote-SSH,在下载完成后关掉你的vscode。

然后回到“我的节点”界面,点击“打开VS Code”按钮,找到弹出的每个窗口的确认键,点击它们。然后你的vscode会自动启动,可能会弹出一个选项卡让你选择连接目标的平台,选择Linux即可。然后等待vscode远程服务器部署好,即可完成连接。

你也可以尝试不依赖xLab为你提供的一键式连接,实际上这并不困难,问问你的AI agents吧。

More Resources

xLab Official(?) Slides

xLab Official Documents