cli commands - yumi-furry/AstralGame-cli GitHub Wiki

命令行接口 CLI

astral-server 提供三个子命令:run(运行服务)、init(生成示例配置)、export-web(导出 Web 管理端)。

astral-server 1.5.1_1
Astral Game P2P server (headless) with embedded web management

子命令一览

子命令 作用 参数
run 运行服务:启动 EasyTier 节点 + Web 管理端 --config <路径>(可选)
init 生成一份示例配置文件 --config <路径>(可选)
export-web 导出内嵌 Web 管理端(index.html) --output <路径>(可选,默认 web-export/index.html)

run

启动 EasyTier 节点与内嵌 Web 管理端(REST API + WebSocket + 静态单页前端),监听 Ctrl-C / SIGTERM 优雅停止节点。

# 使用可执行文件同目录的 config.toml
sudo ./astral-server run

# 指定配置文件路径
sudo ./astral-server run --config /etc/astral-server/config.toml

--config 未指定时默认使用可执行文件同目录下的 config.toml(所有运行期数据都放在该目录)。

启动时还会自动完成:

  • ws_key 为空时自动生成随机密钥并写回配置;
  • 首次运行生成 Email/ 邮件模板;
  • 按守护进程自动联网策略自动创建 / 加入预设房间,或按配置文件中的 EasyTier 实例段自动联网。

init

在指定路径生成一份内置示例配置(自动创建父目录),生成后即可直接 run:

./target/release/astral-server init
# 会在可执行文件同目录生成 config.toml

# 指定生成路径
./target/release/astral-server init --config /etc/astral-server/config.toml

export-web

把编译时内嵌的单文件 Web 管理端导出到磁盘,便于外部托管或备份:

# 默认导出到 web-export/index.html
./target/release/astral-server export-web

# 指定输出路径
./target/release/astral-server export-web --output web/index.html

配置路径约定

未显式指定 --config 时,配置与运行期数据(config.toml、servers.json、avatar.bin、Email/ 模板)统一放在可执行文件同目录,符合"单目录即可维护整套服务"的部署约定。

相关页面