add 命令
把站点注册到远程 docdoc 服务器。
语法
docdoc add --remote docdoc://host:port <src> --name <name> [--domain <domain>] [--ref <ref>] [--token <token>]
参数
| 参数 | 说明 | 必填 | 缺省 |
|---|---|---|---|
--remote <remote> |
远程地址,形如 docdoc://docs.example.com:10001 |
是 | — |
<src> |
本地目录或 git 仓库地址 | 是 | — |
--name <name> |
站点名,须匹配 ^[a-z][a-z0-9-]*$,全局唯一;缺省读本地源 docdoc.json 的 name |
本地源可缺省,git 源必填 | 清单声明值 |
--domain <domain> |
绑定域名,绑定后该域名请求直接落在此站点;缺省读本地源 docdoc.json 的 domain |
否 | 仅路径前缀访问 |
--ref <ref> |
git 分支或标签(仅 git 源有效) | 否 | 默认分支 |
--token <token> |
认证令牌(脚本场景非交互传入) | 否 | 读取缓存,缓存无则交互询问 |
行为说明
- 本地源:CLI 在本地完成构建,把产物打包上传到服务器;终端先打印
本地源:构建产物…。站点名/域名的取值顺序为「命令行参数 → 源目录docdoc.json的name/domain」,命令行参数优先,可在发布时同步覆盖清单声明 - git 源:CLI 把仓库地址提交给服务器,由服务器克隆并构建
- 首次接入某台服务器时若返回 401,CLI 会提示输入令牌并缓存,之后复用
- 同名站点已注册时返回 409「站点名已存在」
输出示例
注册成功:docs,57 页,构建于 2026-09-24T12:15:27.686Z
成功后站点立即可访问:绑定了域名用 http(s)://<域名>/,否则用 http(s)://host:port/<站点名>/。
