mcpField
R
remix-api-auth

remix-api-auth

github.com/farworld-labs开发60 次安装
代码仓库

关于 remix-api-auth

用于配置和排查终端、MCP 客户端及外部服务访问 Remix API 的认证。内容涵盖 API 密钥与 CLI 凭据流程、凭据优先级、验证方法及密钥安全。

主要功能

  1. 01Bearer API 密钥认证
  2. 02CLI 登录与身份检查
  3. 03MCP 凭据查找指南
  4. 04凭据优先级与验证
  5. 05API 密钥排错与安全

适用场景

  1. 01为服务配置 Remix API 认证
  2. 02使用 remix login 设置 CLI 访问
  3. 03为 MCP 服务配置凭据
  4. 04排查无效或被覆盖的 API 密钥

MCP 相关

针对 MCP 认证，建议使用 REMIX_API_KEY；未设置时，服务可回退使用 ~/.config/remix/credentials.json 中的 CLI 凭据。

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/farworld-labs/remix-skills --skill remix-api-auth

安装后在 Claude Code 中输入/remix-api-auth确认已加载。

附带文件scripts/README.mdscripts/remix-auth.js

详细介绍

Remix 身份验证设置

当用户需要通过 Remix 对终端、MCP 客户端或外部服务进行身份验证时，请使用此技能。

身份验证模式

  • REST 或自定义服务：向 https://api.remix.gg 发送 Authorization: Bearer <api_key>。
  • CLI：运行 remix login，然后使用 remix whoami 验证。
  • MCP：优先使用 REMIX_API_KEY；如果未设置，服务端可以复用 CLI 凭据 ~/.config/remix/credentials.json。

首选终端流程

curl -fsSL https://remix.gg/install.sh | bash
remix login
remix whoami

CLI 会将凭据存储在 ~/.config/remix/credentials.json 中。

API 密钥流程

  1. 登录 Remix 账户。
  2. 前往 https://remix.gg/api-keys。
  3. 创建新的 API 密钥。
  4. 将其存储为服务端密钥，或导出 REMIX_API_KEY。
  5. 使用基础 URL https://api.remix.gg。

验证

请先使用以下任一方式检查：

  • remix whoami
  • remix config where
  • GET /health
  • 如果用户明确需要经过身份验证的数据调用，则使用 GET /v1/games

API 密钥无效问题排查

  • 检查 REMIX_API_KEY 是否覆盖了存储的 CLI 凭据。
  • 检查 Authorization 的格式是否为 Bearer <api_key>。
  • 从 https://remix.gg/api-keys 重新复制密钥，并在需要时轮换。
  • 确认服务在当前运行环境中读取的是预期的密钥或环境变量。
  • 确认请求是在服务端发起的，未通过浏览器代码暴露。
  • 运行 remix whoami --json，检查解析出的身份验证和配置上下文。
  • 如果行为与本地文档似乎不一致，请以 https://api.remix.gg/docs 为准。

当前身份验证模型

服务端 API 基础 URL：https://api.remix.gg

Remix 服务端 API 使用从 Remix 账户设置中生成的 bearer API 密钥。

支持的身份验证请求头：

  • 直接通过 HTTP 使用时，采用 Authorization: Bearer <api_key>

CLI 的运行时优先级如下：

  1. 显式命令行标志
  2. 环境变量
  3. 存储的配置和凭据
  4. 默认值

后端会将密钥解析为用户，并在修改游戏/版本时执行所有权检查。

如何获取 API 密钥

  1. 登录 Remix 账户。
  2. 前往 https://remix.gg/api-keys。
  3. 生成新的 API 密钥。
  4. 复制一次，并将其存储在服务端密钥管理器中。

必需的请求头

Authorization: Bearer <api_key>
Content-Type: application/json

安全说明

  • 切勿在客户端浏览器代码中暴露 API 密钥。
  • 将密钥存储在服务端环境变量或密钥管理器中。
  • 前往 https://remix.gg/api-keys 撤销并轮换密钥。
  • 使用后会自动更新 lastUsed。

API 身份验证规则

  • 使用通过 https://remix.gg/api-keys 创建的 API 密钥。
  • 使用 Authorization: Bearer <api_key>。
  • 向 https://api.remix.gg 发送请求。
  • 不要在浏览器端代码中放置密钥。
  • 如果密钥泄露，请立即轮换。
  • 账户不得处于封禁或删除状态。

评论

支持 Markdown