beidou

BeiDou-Server 游戏服务端命令行管理工具，AI agent 通过 HTTP API 远程启停服务、查询数据、修改配置、发放道具等。

安装

国内用户推荐使用 install-cn 脚本，通过 ghproxy.net 代理加速 GitHub 下载。

macOS / Linux

# 国内推荐（ghproxy 代理加速）
curl -fsSL https://raw.githubusercontent.com/BeiDouMS/beidou-cli/master/install-cn.sh | bash

# 直连 GitHub
curl -fsSL https://raw.githubusercontent.com/BeiDouMS/beidou-cli/master/install.sh | bash

安装到 ~/.local/bin/beidou，自动写入 ~/.bashrc / ~/.zshrc。

Windows

# 国内推荐（ghproxy 代理加速）
irm https://raw.githubusercontent.com/BeiDouMS/beidou-cli/master/install-cn.ps1 | iex

# 直连 GitHub
irm https://raw.githubusercontent.com/BeiDouMS/beidou-cli/master/install.ps1 | iex

安装并自动加入用户 PATH，重启终端即可使用。

更新

beidou update    # 自动下载最新版覆盖当前二进制

如需卸载：

beidou uninstall  # 删除二进制并清理 PATH

手动下载

从 Releases 页面下载对应平台的二进制。

快速开始

# 1. 配置服务端连接（一次就行）
beidou config --server http://localhost:8686 --username admin --password 123456

# 2. 查看可用 API
beidou apis

# 3. 测试连通性
beidou call GET /server/v1/online

AI Agent 使用指南

安装 Skill

beidou-cli 提供了 skill 文件，AI agent 应将其下载并注册为 skill/工具，而非仅作为参考文档。

Skill 文件地址：

https://raw.githubusercontent.com/BeiDouMS/beidou-cli/master/beidou-cli.md

通用安装方式：

1. 下载上述 URL 对应的文件
2. 按你的 agent 平台要求注册为 skill（如放到 skills 目录、注册为自定义命令等）

Claude Code 用户：

将文件放到 ~/.claude/commands/（全局，推荐）或 <project>/.claude/commands/（仅当前项目）目录下，即可通过 /beidou-cli 指令直接调用。

安装 beidou CLI 二进制

如果你已经安装了 beidou CLI 二进制，按以下顺序操作：

# 第一步：确认 CLI 可用（二进制在 PATH 中）
beidou version

# 第二步：让用户提供配置，或执行
beidou config --server <url> --username <user> --password <pass>

# 第三步：查看全部可用接口
beidou apis

# 第四步：调用 API（单次）
beidou call GET /server/v1/online

# 批量查询（一次 shell 调用全返回，减少交互）
echo '
GET /server/v1/online
GET /server/v1/version
POST /character/v1/online/list {"pageNum":1,"pageSize":10}
' | beidou batch

注意事项：

• Git Bash（Windows）下路径参数会被 MSYS 自动转换，beidou 会自动修复。如遇问题加 MSYS_NO_PATHCONV=1
• 敏感操作（关服、删除、修改数据）默认拦截，需加 --force
• 成功码是 20000（不是 HTTP 200），别误判失败
• 首次 call 自动登录获取 token，无需手动 beidou login
• 非交互环境下 beidou config 会报错提示用命令行参数

构建

如需从源码构建：

# JAR
mvn package -DskipTests

# 原生二进制（需要 GraalVM JDK 21 + native-image）
# Linux/macOS: 需要 GCC/Xcode
# Windows: 需要 Visual Studio 2022+ 含 C++ 桌面开发
./build-native.sh  # macOS/Linux
build-native.bat   # Windows