CLI工具
在终端部署 JavaScript 项目、查看日志、管理实例与存储,并连接自己的电脑或服务器。
runtime-cli 是运行时的命令行工具。用它从本地目录部署项目、启停云端实例、查看日志和管理存储;需要让云端任务访问自己的电脑或服务器时,再启动 daemon。
项目代码在云端执行。日常部署和资源管理无需运行本机代理。
下载与安装
在客户端下载区选择对应系统,下载并解压。安装包内包含可执行文件和 README。
| 系统 | 安装包 | 可执行文件 |
|---|---|---|
| Windows x64 | Windows x64 | runtime-cli.exe |
| macOS Intel / Apple Silicon | macOS Universal | runtime-cli |
| Linux x64 | Linux x64 | runtime-cli |
在终端进入解压后的可执行文件目录。macOS / Linux:
chmod +x ./runtime-cli
./runtime-cli version
export PATH="$PWD:$PATH"Windows PowerShell:
.\runtime-cli.exe version
$env:Path = "$PWD;$env:Path"上面的 PATH 设置只对当前终端生效。设置后即可在其他目录使用下文的 runtime-cli 命令;长期使用可将该目录加入系统的 PATH。
配置连接
从 API 密钥页获取自己的 API key 和对应的 project ID。当前站点的 API 地址为 https://api.lexmount.cn。
macOS / Linux:
export LEXMOUNT_API_KEY='<your-api-key>'
export LEXMOUNT_PROJECT_ID='<your-project-id>'
export LEXMOUNT_BASE_URL='https://api.lexmount.cn'Windows PowerShell:
$env:LEXMOUNT_API_KEY = '<your-api-key>'
$env:LEXMOUNT_PROJECT_ID = '<your-project-id>'
$env:LEXMOUNT_BASE_URL = 'https://api.lexmount.cn'若希望新终端也能使用,可在用户主目录创建 lexmount.env,填入以下内容:
LEXMOUNT_API_KEY='<your-api-key>'
LEXMOUNT_PROJECT_ID='<your-project-id>'
LEXMOUNT_BASE_URL='https://api.lexmount.cn'三个变量分别取第一个非空配置,优先级为:当前进程环境变量 → 可执行文件目录的 env → 同目录的 .env → 用户主目录的 lexmount.env → .lexmount.env。不会从当前项目或父目录查找连接配置。API key 和 project ID 必须提供,API 地址请按上方示例显式设置。
连接凭据用于 CLI 鉴权,与项目的 .runtime.config 分开保存。不要将含 API key 的文件提交到代码仓库。
部署第一个项目
runtime-cli init ./my-project --name my-app
cd my-project
runtime-cli deploy
runtime-cli loginit 要求目标为新目录或空目录。它会创建一个停止状态的云端实例,并在本地生成最小 HTTP 服务 main.js 和 .runtime.config,随后由 deploy 上传文件并运行。可编辑 main.js,再次执行 deploy 发布修改。
命令输出 Submitted 表示云端已接收执行请求。通过日志或实例管理确认运行结果;生成的 HTTP 服务持续运行时,可从实例列表查看公开访问地址。
| 命令 | 行为 |
|---|---|
runtime-cli deploy | 上传当前文件、同步配置并提交新执行;已有执行会被替换 |
runtime-cli start | 同步配置,使用云端上次部署的文件启动;运行中或正在启动时保持当前执行 |
runtime-cli stop | 停止实例并等待清理,保留代码和历史 |
runtime-cli log | 输出保留日志并持续跟随;Ctrl+C 仅退出查看 |
runtime-cli log --no-follow | 输出已有日志后退出 |
runtime-cli inspect | 输出当前运行实例的 CDP WebSocket 调试地址 |
这些项目命令都从当前目录读取 .runtime.config,不向父目录查找。修改本地代码后使用 deploy;start 不上传本地文件,首次运行前也必须先部署。
将 inspect 输出的地址交给 DevTools 或其他 CDP 工具使用,步骤见调试实例。任何持有该地址的人均可连接调试器,请妥善保管。
项目配置与文件
init 生成的 .runtime.config 使用 JSON。保留其中实际生成的 instance_id,按需调整其他字段:
{
"instance_id": "11111111-1111-4111-8111-111111111111",
"name": "my-app",
"entry": "main.js",
"max_runtime_ms": 0,
"env": { "GREETING": "Hello" },
"storage": {
"db": [],
"kv": [],
"oss": []
},
"ignore": [".git/", "node_modules/"]
}entry是项目内的 JS/MJS 入口;max_runtime_ms的单位为毫秒,0表示不限时。env是云端脚本的环境变量,通过lexmount:env读取。空对象会清空实例保存的环境变量。storage按类型填写当前项目内资源的完整名称,不会自动创建资源;空数组或省略某类会解除该类全部关联。改变关联前先停止实例并等待清理。deploy和start将这些配置同步到云端。配置保存分多次请求完成;中途失败时,先前保存的部分可能已生效,修正后重试。
上传遵循项目内各级 .gitignore,再叠加 ignore 中的规则,后者优先。生成配置默认忽略 .git/ 和 node_modules/;.runtime.config 始终排除。其他隐藏文件依照忽略规则处理,含密钥的文件也应加入忽略列表。
单文件和整个项目均不得超过 8 MiB 原始字节。JS/MJS 必须使用 UTF-8,其他文件作为二进制资源上传。运行时使用 Web API,不提供 Node.js 内置模块、npm 依赖解析或 TypeScript / JSX 编译;相关说明见运行环境和多文件与图片。
按 ID 管理实例
以下命令可在任意目录使用,直接操作云端实例,不读取或修改本地项目配置。将占位符替换为完整实例 UUID:
runtime-cli instance list
runtime-cli instance start '<instance-id>'
runtime-cli instance stop '<instance-id>'
runtime-cli instance log '<instance-id>' --no-followlist 列出当前账号可访问的全部实例,包含状态和 HTTP 服务地址。按 ID 的 start 使用云端保存的代码和配置。移除 --no-follow 可持续查看日志。
删除实例会先停止并清理执行,再永久删除实例、代码和执行历史;已关联的存储及其数据保留。本地配置中的该实例 ID 随后失效:
runtime-cli instance delete '<instance-id>'管理存储与关联
存储资源属于当前 API key 对应的项目。db 表示数据库,kv 表示键值存储,oss 表示对象存储;以下命令不要求项目目录:
runtime-cli storage db list
runtime-cli storage kv list
runtime-cli storage oss list
runtime-cli storage db create my-database
runtime-cli storage kv create my-cache
runtime-cli storage oss create my-files创建后,在 .runtime.config 中按名称关联资源,再于实例停止后运行 deploy 或 start:
{
"storage": {
"db": ["my-database"],
"kv": ["my-cache"],
"oss": ["my-files"]
}
}也可以按 UUID 单独添加或移除关联,先停止实例:
runtime-cli instance stop '<instance-id>'
runtime-cli instance link '<instance-id>' db '<storage-id>'
runtime-cli instance unlink '<instance-id>' db '<storage-id>'类型参数也可使用 kv 或 oss。手动关联不修改本地配置;下次在项目内执行 deploy / start 时,配置文件的名称列表会重新应用。
永久删除资源使用 runtime-cli storage db delete '<storage-id>',将 db 换成 kv 或 oss 可删除其他类型。先解除所有实例关联,才能删除资源及数据。CLI 管理资源本身,数据读写使用存储接口。
连接自己的电脑或服务器
需要云端脚本访问本机文件、执行命令或连接本机网络时,启动后台代理:
runtime-cli daemon start
runtime-cli daemon liststart 不要求项目目录,启动后关闭终端仍会运行,每位系统用户只运行一个代理。用客户端管理确认在线、可达,再将完整客户端 ID 填入远程调用示例。使用 runtime-cli daemon stop 停止本机代理并等待清理。
代理以启动它的操作系统用户身份执行操作。默认允许读文件、执行命令、TCP 和 HTTP 服务,文件接口写入默认关闭;关闭文件写入不限制 shell 命令修改文件。按需通过下方命令或控制台调整客户端权限:
runtime-cli daemon list --all
runtime-cli daemon config '<client-id>'list --all 同时显示离线和不可达客户端;config 逐项询问权限,回车保留原值,最后确认才保存,离线修改在重连后应用。客户端属于账号,同一用户不同项目共享客户端,project ID 不提供客户端隔离。
runtime-cli daemon delete '<client-id>' 会断开并永久撤销客户端 ID,不停止或卸载本机服务。需要停止本机代理时使用 daemon stop。
设置自动启动
临时后台代理在系统重启后不会自动运行。需要自动启动时,在普通用户终端执行:
runtime-cli daemon stop
runtime-cli daemon install
runtime-cli daemon startinstall 只注册服务,不立即启动。各系统的启动时机如下:
| 系统 | 自动启动方式 |
|---|---|
| macOS | 当前用户 LaunchAgent,GUI 登录后启动,无需 sudo |
| Windows | 当前用户登录计划任务,登录后启动,注销后结束 |
| Linux | 用户登录后启动,优先 systemd 用户服务,再选 OpenRC 用户服务;回退 OpenRC 系统服务时按提示使用 sudo,系统服务在开机时启动 |
安装会保存当前连接配置、可执行文件路径和工作目录。更换凭据或移动程序后,先 daemon stop,再重新 daemon install;单独修改环境变量不会更新已安装服务。
runtime-cli daemon uninstall 停止并移除自动启动配置,保留客户端身份。代理日志位置由启动命令输出;runtime-cli log 查看的是云端项目日志。
版本与更新
runtime-cli version
runtime-cli update --check检查更新不需要 API key 或 project ID,也不会下载或替换程序。实际更新前先停止本机代理:
runtime-cli daemon stop
runtime-cli update更新按 LEXMOUNT_BASE_URL 选择对应站点的发布清单,校验安装包哈希、架构和版本后替换可执行文件,保留连接配置、项目文件和客户端身份。相同或更新的本机版本不会降级。需要代理时,在更新后手动执行 runtime-cli daemon start。
帮助与排查
- 查看命令参数:运行
runtime-cli help、runtime-cli help deploy或runtime-cli help daemon install,均无需连接凭据。 - 找不到命令:确认安装目录已加入当前终端的 PATH;在解压目录也可使用
./runtime-cli或.\runtime-cli.exe。 - 鉴权失败:核对 API key、project ID、API 地址是否来自同一站点,并检查高优先级环境变量是否覆盖了配置文件。
- 找不到项目配置:进入包含
.runtime.config的目录后执行项目命令;按 ID 管理资源则无需项目目录。 - 启动后没有新代码:
start使用云端已部署文件,本地修改需要执行deploy。 - 关联存储失败:核对资源类型和完整名称,并先停止实例、等待清理;按 ID 关联时使用 UUID。
