跳到主要内容

workspace login

workspace login 会向 SteamHarness Server 发起 device flow 登录请求,打开浏览器授权页,等待用户在 Web 端批准后把 CLI 专用 API Key 写入本地 workflow-auth.json。无需手工输入 token。

命令格式​

pnpm exec steamharness workspace login --server <url>

参数​

参数说明
--server <url>必填。SteamHarness Server 地址。

验证方式​

步骤说明
创建设备码CLI 调用 POST /api/auth/device/start。
打开浏览器自动打开 verificationUriComplete;无浏览器时输出 URL 和 user code。
轮询结果CLI 轮询 POST /api/auth/device/token,直到成功、拒绝、过期或被限流。
写入配置成功后写入 workflow-auth.json,保存 server、API Key、过期时间和用户信息。

配置文件​

配置说明
文件名workflow-auth.json
macOS 默认目录~/Library/Application Support/steamharness
Windows 默认目录%APPDATA%/steamharness
Linux 默认目录$XDG_CONFIG_HOME/steamharness 或 ~/.config/steamharness
自定义目录设置 STEAMHARNESS_CLI_AUTH_DIR

输出​

情况输出
登录成功{ errCode: 0, errMessage: "", data: { loggedIn: true, serverUrl, user, expiresAt, apiKeyPrefix } }
授权被拒绝或过期输出 server 返回的错误响应,退出码为 1。
参数缺失输出错误信息,退出码为 1。

示例​

pnpm exec steamharness workspace login --server http://localhost:7126

相关命令​

目标命令
查看登录状态status
清空登录态logout
检查服务健康health