开始使用
Orbit 账户的组织方式、控制台各处的功能,以及从登录到让我们的网络开始应答一个域名的最短路径。
命令行与 AI 代理
每个端点,多三种用法。
命令行工具、SDK、MCP 服务器与 API 参考都由与 API 本身相同的定义生成,因此每个端点上线当天就出现在它们每一个里。
01
安装命令行工具
一个文件,没有依赖。需要 Node.js 22.18 或更新版本。
curl -fsSLo orbit.mjs https://orbit.yunzheng.space/cli/orbit.mjs
node orbit.mjs --help命令按产品分组:dns、shield、pages、link、verify、mail、meet、vgate 等。node orbit.mjs dns --help 列出某个产品的命令;在任何命令后加 --help 查看其字段。
02
用令牌登录
在控制台的 API 页面创建令牌,然后保存为配置档。只读令牌足以完成所有只查看的操作。
node orbit.mjs login --token orb_…
node orbit.mjs whoami| 位置 | |
|---|---|
| 令牌 | --token,其次 ORBIT_TOKEN,最后是已保存的配置档 |
| 配置档 | ~/.config/orbit/config.json;用 --profile 或 ORBIT_PROFILE 选择 |
03
日常命令
node orbit.mjs dns zones list
node orbit.mjs dns records create 42 --name www --type A --content 192.0.2.10 --ttl 300
node orbit.mjs dns records list 42 --all --json
node orbit.mjs shield sites purge 7 --urls /index.html,/app.js- id 是位置参数:先区域,后记录。
--json原样输出应答;--all读取列表的全部分页。- 删除前会先询问;在脚本中请加
--yes。
04
用代码管理 DNS 与 Shield
在与代码放在一起的文件里描述区域、记录与 Shield 站点。plan 显示将发生的变化;apply 让账户与文件一致。
export default {
zones: [{
name: "example.com",
records: [
{ name: "www", type: "A", content: "192.0.2.10", ttl: 300 },
{ name: "@", type: "MX", content: "10 mx.example.com" },
],
}],
sites: [{ hostname: "www.example.com", origin: "192.0.2.10", force_https: true }],
};node orbit.mjs plan -f orbit.config.ts
node orbit.mjs apply -f orbit.config.ts- 文件列出的记录集(名称加类型)会严格按所写生成;未列出的记录集保持不变,除非该区域写明
prune: true。 - 有变化时
plan以退出码 2 结束,流水线可以据此在出现偏差时停下。 apply在改动前会先询问;--yes跳过询问。- 也可以用 JSON:
orbit.config.json。
05
连接 AI 代理
MCP 服务器把每个端点作为一个工具提供。把它加入任何支持远程 MCP 服务器的客户端,并以令牌作为 Authorization 头。
{
"mcpServers": {
"orbit": {
"url": "https://dash.yunzheng.space/mcp",
"headers": { "Authorization": "Bearer orb_…" }
}
}
}- 只读令牌只会列出只读工具。在地址后加
?readonly=1,可以让读写令牌在这个客户端里保持只读。 - 会修改账户的工具先返回预览;代理向你确认后再调用一次执行。
- 想要更少的工具、更小的上下文:
?products=dns,shield。
06
控制台里的代理
在内置代理的浏览器中,控制台会为当前页面提供工具:在区域页列出、添加与删除记录,在 Shield 站点页查看站点并清除缓存。它们以你自己的登录身份操作,删除或清除缓存前会先在屏幕上向你确认。
07
常见问题
命令行覆盖哪些端点?
全部。命令、SDK 方法、MCP 工具与参考页面都由 API 定义生成;任何一个落后于定义,检查就会让构建失败。
代理能不经询问就修改我的账户吗?
MCP 服务器上的写入工具只有在预览之后、带着明确确认再次调用时才会执行。使用只读令牌,或在地址后加 ?readonly=1,它就完全无法修改任何内容。