For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /guide/commands.md.
  • 简体中文
  • 控制台命令速查

    在 sfmc 交互控制台(REPL)或系统终端中,可使用下列命令进行服务管控、模块管理与扩展包管理。

    在交互终端中,输入 help 可列出当前上下文支持的全部命令;输入 / 可激活交互式命令补全菜单。

    命令别名约定
    • 模块管理:mod ≡ module(顶层短命令 install / uninstall / search / list 等同于 mod <cmd>)
    • 附加包管理:packs ≡ addon
    • 详细执行机制请分别查阅:服务管理、模块管理、附加包管理。 :::

    1. 服务管理(Service Management)

    命令与常用参数典型示例功能与行为说明
    statussfmc> status查看所有伴生服务(db / qq / bds)的运行状态、PID 与内存占用。
    start <svc|-all>sfmc> /start -all
    sfmc> start db
    启动全部服务或指定子服务(可选:db、qq、llbot、bds、-all)。自动执行前置依赖检查与装载闸门。
    stop <svc|-all>sfmc> stop bds安全停止指定服务或终止所有进程(-all)。
    restart <svc|-all>sfmc> restart qq重新启动指定服务。常用于修改 qq_config.json 或 db_config.json 后应用配置。
    logs <svc> [-n N] [-f]sfmc> logs bds -f
    sfmc> logs db -n 50
    实时查看或追踪指定服务的运行日志。在交互终端中亦可随时按下快捷键 Ctrl + L 切换日志源。
    send <svc> <input>sfmc> send bds op Alex向指定服务的子进程标准输入(stdin)发送指令(仅在交互式 REPL 中有效)。
    initsfmc> init唤起首次开服交互式初始化向导(需在标准 TTY 终端中运行)。
    update [--check-only]sfmc> update检查并升级 Bedrock Dedicated Server 官方服务端。使用 --check-only 仅查询版本不下载。

    2. 模块管理(Module Management)

    命令与常用参数典型示例功能与行为说明
    mod search [keyword]sfmc> mod search economy在官方 sfmc-modules 索引库中检索可用功能模块。
    mod info <id>sfmc> mod info afk查看指定模块的作者、版本号、描述与依赖项清单。
    mod install <id...> [--from <src>] [--link]sfmc> mod install afk
    sfmc> mod install my-mod --from dir:../my-mod --link
    下载并安装模块到 modules/packages/。支持从本地目录挂接(--link 软链调试)。
    mod uninstall <id...>sfmc> mod uninstall afk卸载指定模块并清理其源码文件。
    mod listsfmc> mod list列出本地已安装模块、启停状态、文件数、体积、源码指纹与官方认证标识(● 官方启用 / ○ 官方禁用 / ? 未知发布源 / ○ 契约缺失)。
    mod enable <id...>sfmc> mod enable afk启用指定模块。写入 module-lock.json,若 db-server 在线则同步热更新内存状态。
    mod disable <id...>sfmc> mod disable afk禁用指定模块。禁用后下次组装行为包时将排除该模块。
    mod verifysfmc> mod verify校验本地所有模块的 manifest.json 契约合规性与依赖完整度。
    mod buildsfmc> mod build执行模块组装与编译,将启用的模块编译至 packs/_build/ 暂存区。
    mod reload [--build-only]sfmc> mod reload编译、组装并部署至当前世界目录,同时向 BDS 发起重载请求。

    :::info 模块开发者注意 模块的本地测试、文件监视(Watch)与发布已收敛至 VS Code / Cursor 扩展 「SFMC Module」;CLI 不再提供旧版 mod test、mod watch 与 mod publish 命令。详见 模块开发指南。

    3. 附加包管理(Add-ons & Packs)

    命令与常用参数典型示例功能与行为说明
    packs scan [--force] [--dry-run]sfmc> packs scan扫描 <SFMC_ROOT>/packs/ 收件箱中的待装包,自动解析并安装入世界。
    packs list [--kind bp|rp|all]sfmc> packs list --kind bp列出当前游戏世界中已激活的所有第三方行为包(BP)与资源包(RP)。
    packs install <path|--inbox> [--force]sfmc> packs install ./cool.mcpack直接安装指定路径下的附加包或处理收件箱归档。
    packs enable <uuid|folder>sfmc> packs enable my-addon在当前世界中启用指定附加包(支持使用 UUID 或文件夹名)。
    packs disable <uuid|folder>sfmc> packs disable my-addon在当前世界中停用指定附加包。
    packs uninstall <id...> [--purge]sfmc> packs uninstall my-addon将附加包移出世界目录(默认移至 packs/_trash/ 回收站;--purge 永久删除)。
    packs search <keyword>sfmc> packs search "Vehicles"在 CurseForge 基岩版资源库中搜索附加包项目。
    packs bind <id> <slug>sfmc> packs bind my-addon vehicle-pack将已安装的本地附加包与 CurseForge 项目 slug 绑定,用于版本更新。
    packs unbind <id>sfmc> packs unbind my-addon解除本地附加包与远端更新源的绑定。
    packs sourcessfmc> packs sources查看所有已登记的更新源映射表。
    packs checksfmc> packs check检查所有已绑定的附加包是否有远端新版本发布。
    packs update [--all]sfmc> packs update --all下载并升级所有已绑定的第三方附加包到最新版本。
    packs bump <id>sfmc> packs bump my-addon-rp针对资源包(RP):将其 patch 版本号 +1,使客户端重新拉取材质缓存。
    packs doctorsfmc> packs doctor [--fix] [--all-experiments] [--experiments]扫描排查世界清单损坏,诊断并安全配置 level.dat 实验性玩法开关(Beta APIs、创作者功能、照相机、Voxel、村民再平衡、2026第3次更新、教育版等)。
    packs pathsfmc> packs path打印当前世界行为包与资源包的文件系统路径。

    4. 全局通用与诊断命令(General & Diagnostics)

    命令说明与行为
    help [command]打印全局帮助手册或指定命令的参数详解。
    version打印当前 SFMC CLI、Node.js 运行时及 SDK 的构建版本信息。
    locale [lang]切换或查看交互控制台界面语言(如 zh 或 en)。
    quit / exit退出交互控制台(后台服务保持运行)。
    debug <subcommand>底层诊断工具,用于查看内部状态与事件流。