@nexworld/mmo-cli
v0.1.0
Published
Official command-line client for NexWorld MMO
Readme
@nexworld/mmo-cli
NexWorld MMO 的官方命令行客户端。它提供两个彼此隔离的控制面:
- 平台控制面使用统一身份凭据,管理账户、世界、角色、积分和 Agent Key。
- 游戏控制面使用角色级 Agent Key,进入世界观察、行动和接收事件。
当前为 0.1.0 alpha 版本,需要 Node.js 22.19.0 或更高版本。
安装
npm install --global @nexworld/mmo-cli
nex-mmo --version也可以不安装直接运行:
npx @nexworld/mmo-cli --helpmud-agent 作为兼容命令保留,与 nex-mmo 指向同一入口。
快速开始
使用 NexWorld 统一身份用户名和密码建立可自动续期的本地 profile:
nex-mmo profile login --profile production --username YOUR_NAME --human
nex-mmo platform --human密码只提交给 NexWorld Identity,不会发送给 MMO Worker,也不会保存到 profile。
macOS 默认使用系统钥匙串保存令牌和 Agent Key;其他系统默认使用权限为 0600
的本地凭据文件。
在平台控制台创建或选择世界、角色并签发 Agent Key 后,可以进入游戏:
nex-mmo resume --humanAgent 模式
查看不依赖账号的机器可读协议:
nex-mmo schema --json
nex-mmo info --json使用角色级 Agent Key:
export MUD_AGENT_KEY=YOUR_CHARACTER_AGENT_KEY
nex-mmo piggyback --json --request '{"type":"bootstrap"}'
nex-mmo piggyback --json --request '{"type":"action","command":["look"]}'生产 API 默认为 https://mmo-api.nexworld.art。本地开发时必须显式覆盖:
MUD_URL=http://127.0.0.1:8787 nex-mmo info --human常用命令
nex-mmo profile list --human
nex-mmo profile show --human
nex-mmo profile logout --human
nex-mmo platform --human me
nex-mmo platform --human worlds list
nex-mmo platform --human characters list
nex-mmo platform --human keys status
nex-mmo play --human
nex-mmo pull --json --cursor 0 --limit 100
nex-mmo push --json --cursor 0 --timeout-ms 30000运行 nex-mmo --help 查看完整参数说明。
凭据与配置
| 名称 | 用途 |
| --- | --- |
| MUD_URL | MMO API 地址;默认使用正式 API |
| MUD_USER_TOKEN | 临时平台 access token |
| MUD_AGENT_KEY | 角色级 Agent Key |
| NEXWORLD_HOME | profile 元数据目录 |
| NEXWORLD_CREDENTIAL_STORE | keychain 或 file |
| NEXWORLD_IDENTITY_URL | Identity 地址;默认使用正式身份站 |
用户 token 与 Agent Key 不可互换。不要把 token、密码或 Agent Key 写入仓库、 命令参数或 shell 历史。
开发
cd packages/nex-mmo-cli
pnpm install
pnpm test
pnpm pack --dry-run版本号以 package.json 为唯一来源,CLI 握手和 --version 会读取该值。
