docdoc 文档

list 命令

列出远程服务器上所有已注册的站点。

语法

docdoc list (--remote docdoc://host:port | --config <path>) [--token <token>]

参数

参数 说明 必填 缺省
--remote <remote> 远程地址，形如 docdoc://docs.example.com:10001 与 --config 二选一 —
--config <path> 本地服务配置文件路径，端点与服务 token 从配置解析；TLS 模式走管理端口（managementPort，缺省 tls.httpPort），非 TLS 走 service.port 与 --remote 二选一 —
--token <token> 认证令牌（非交互传入） 否 读取缓存，缓存无则交互询问

行为说明

  • 请求管理接口 GET /api/v1/sites（见 API 参考），以对齐表格打印全部站点
  • 没有任何站点时打印 服务器上没有已注册的站点
  • --config 与 --remote 互斥，同时指定报错；管理 token 直接取配置中的 service.token，无需 --token（显式 --token 优先级更高）
  • 列含义：站点名、绑定域名（未绑定为 -）、源（git 源带 @<ref> 后缀，本地上传源显示 本地产物）、页数、构建时间（UTC）

输出示例

共 2 个站点：

站点名      绑定域名                          源           页数  构建时间
docdoc     docdoc.docs.internal.xeegam.com  本地产物    106   2026-10-04 23:59 UTC
api-guide  api-guide.example.com            git@main    42    2026-01-12 08:30 UTC