# Install the Relay Skill

Relay hands off files between devices asynchronously. Each Bundle carries a required handoff note. The receiving device collects it later; Relay does not start or schedule the receiving agent.

## Install into your project

```bash
npx skills add https://relaybundles.com --skill relay
```

Run this in the project where your agent works. Choose the agent and review the installation when prompted. The Skill includes instructions, setup and doctor scripts, command references, and its Apache-2.0 license. Installing the Skill does not execute its scripts or sign you in.

The skills installer has its own runtime requirement: skills 1.7.2 requires Node.js 22.20.0 or later. This differs from the Relay CLI setup requirement below. Use separate Node environments when needed, or download the full archive and follow your agent’s manual Skill installation instructions.

For a specific client, add `-a claude-code`, `-a cursor`, or another client supported by your skills CLI. On Windows, add `--copy` if symbolic links are unavailable.

## Install and configure the CLI

The CLI source is public at [https://github.com/Telescop-Lab/Relay-CLI](https://github.com/Telescop-Lab/Relay-CLI). The current setup scripts require Node.js 20.x and npm. CLI installation from GitHub also requires Git.

From the installed Skill directory, review and run the matching setup script:

```powershell
.\scripts\setup.ps1 -RelayUrl "https://relaybundles.com"
```

```bash
RELAY_URL="https://relaybundles.com" bash ./scripts/setup.sh
```

Use the intended service URL for a self-hosted or test service. The setup script sets the active profile URL, so check existing configuration before running it.

## Sign in and verify

You need a Relay account on the selected service. Public account registration may be closed even while the Skill is available. On the current service, new accounts verify email and set a password through the Dashboard; legacy CLI signup returns EMAIL_VERIFICATION_REQUIRED. Existing usernames still work. An email can sign in only after verification. Waitlist signup does not create an account.

Reuse an existing CLI session first. With explicit sign-in authorization and an approved credential source, a runner may use relay login --identifier <username-or-email> --device <device-name> --password-stdin with the password piped to stdin. Without approved credentials, ask the person to sign in in their own terminal; unattended jobs should return authentication-required instead of waiting. Keep passwords out of chat, command literals and logs. Do not automatically re-login after known revocation or password reset.

```bash
relay login --identifier <username-or-email>
relay whoami --json
relay ws list --json
```

Choose the intended workspace with `relay ws use <workspace-id-or-name>`. If you have no workspace, create one with `relay ws create <name> --use`. The published doctor scripts check installation and sign-in; workspace selection is a separate requirement.

A setup exit code of 4 means authentication is needed. Complete sign-in and re-run the setup. Never run a transfer until a workspace is selected.

## Downloads and machine discovery

- [Full Skill archive](/.well-known/agent-skills/archives/relay-4a5367244a516e2c5e1800343c0d083be311d61aa178058bddc5c0df12686427.tar.gz)
- [Skill instructions](/.well-known/agent-skills/relay/SKILL.md)
- [Discovery index v0.2.0](/.well-known/agent-skills/index.json)
- [Legacy discovery index](/.well-known/skills/index.json)
- Archive SHA-256: `4a5367244a516e2c5e1800343c0d083be311d61aa178058bddc5c0df12686427`

- Source: [Relay CLI 0.1.0, commit 8576ad3f85d3](https://github.com/Telescop-Lab/Relay-CLI/tree/8576ad3f85d399f690802377d960e0074b76bb8e/skills)

The discovery format is a draft. Client support varies. The archive is content-addressed and contains SKILL.md at its root, plus every referenced script and reference file.

## More information

- [Agent guide](https://relaybundles.com/agents)
- [Getting started](https://relaybundles.com/get-started)
- [Trust and privacy](https://relaybundles.com/trust)
- [CLI source](https://github.com/Telescop-Lab/Relay-CLI)

## 中文说明

在项目目录运行上面的 npx 命令，按提示选择 Agent 并确认安装。该命令安装 Skill；脚本不会随安装自动执行，账号也不会自动登录。skills 1.7.2 要求 Node.js 22.20.0 或更新版本，与下方 Relay CLI 的要求不同。必要时使用独立 Node 环境，或下载完整归档并按 Agent 的说明手动安装。

CLI 已开源。当前 setup 脚本要求 Node.js 20.x、npm 和 Git。安装 Skill 后，在 Skill 目录检查并运行对应系统的 setup 命令。使用自托管或测试服务时，请替换服务地址。setup 会设置当前 profile 的服务地址，运行前请核对已有配置。

账号注册可能尚未开放。当前服务的新账号需从 Dashboard 验证邮箱并设置密码；旧版 CLI signup 会提示 EMAIL_VERIFICATION_REQUIRED。已有用户名继续有效；邮箱验证后才能用于登录。等待名单不会创建账号。

优先复用 CLI 会话。用户或部署者已授权登录并配置凭据来源时，可通过 --password-stdin 无人值守登录，并明确提供 --device。不要把密码写入聊天、命令字面量或日志。缺少凭据时请人在自己的终端登录；后台任务应明确返回需要认证，避免挂起。已撤销或重置密码的会话不可自动密码重登。setup 退出码 4 表示需要认证。公开 doctor 只检查安装和登录；请另行选择工作区，或创建首个工作区。公开 Skill 原始快照仍对应下列来源提交；本页说明当前服务的邮箱认证要求。Relay 不会自动启动远端 Agent。