云端文档库
云端文档库是 Loci Server 上预先发布的公开文档快照。CLI 可以将快照下载为本地副本,之后即可离线浏览、搜索和读取。
修改默认的云端文档库地址
正式版 CLI 默认连接 https://loci.xiaowo.live。如果使用自行部署的 Loci Server,可以将 server-url 改为对应地址。LOCI_SERVER_URL 环境变量优先于持久设置;变量存在时,CLI 会拒绝 config set server-url,请先取消覆盖再修改。
示例:
使用以下命令可以确认当前地址并检查 Server 是否可以访问:
这里修改的是云端文档库的 Server 地址,不会改变本地文档源的网页 URL。已经下载的副本会继续从原 Server 更新;切换地址后,如需更新旧副本,请先切回对应的 Server。
如果你希望自己在服务器上搭建 Loci Server,并向其他人发布文档库,请阅读 Admin:部署与管理 Server。
浏览和下载文档库
运行 loci ui 后,也可以在“云端目录”页面完成浏览、拉取、更新、每日检查开关和本地副本删除。拉取完成后,副本会进入普通“文档”页面并继续使用同一套目录、阅读和搜索界面;来源列表和当前来源标题会持续显示“云端副本 · 自动更新”或“云端副本 · 手动更新”,避免把它误认为本地抓取库。Web 与下列 CLI 命令共用同一数据库和云端副本锁;同时操作同一文档库不会生成两份本地副本。
loci cloud list
读取 Server 上公开的文档库目录,显示页面数、内容大小和短 ID,并标记每个文档库在本地是否已经存在或有可用更新。
Server 暂时不可访问时,已经下载的内容仍可离线读取,不会被清空。
示例:
loci cloud tree [library] 与 loci cloud read <library> <file>
无需下载完整快照即可按需浏览 Server 上的目录和正文:
tree 只读取指定目录层级;read 只读取指定文件,并可用 --offset 与 --max-chars 续读较长正文。按需阅读不会创建本地副本;需要离线使用时再执行 cloud pull。
loci cloud pull [library]
将一个公开文档库下载为本地副本。[library] 可以是云端文档库名称、完整 ID 或唯一短 ID;在交互终端中省略时可以从云端目录选择。
示例:
下载时添加 --auto-sync 会同时开启每日自动同步,并在保存前确保后台服务可用:
下载后可以使用 loci document list、loci document tree、loci document search 和 loci document read 浏览副本内容。
当云端没有可用内容或拉取失败时,可以改用 loci source add <官方文档 URL> 创建本地抓取库。云端副本不会占用同域名的本地文档源位置,因此两者可以并存。
loci cloud update [library]
从最初下载快照的 Server 更新本地云端副本。该命令只适用于已经下载的云端文档库;在交互终端中省略 [library] 时可以从本地云端副本中选择。
示例:
loci cloud delete [library]
删除一个本地云端副本,不会影响 Server 上的原始文档库。CLI 默认会再次确认;只有在脚本中确认目标无误时才应使用 --yes 跳过确认。
示例:
loci cloud auto-sync [library]
为已经下载的云端副本开启或关闭每日同步。使用 --on 或 --off flag;交互终端省略 flag 时会询问。
使用默认数据目录时,CLI 或 Web UI 开启每日同步会立即安装或启动无 HTTP 的常驻 worker。关闭开关不会擅自停止 worker,因为其他文档库或定时抓取可能仍依赖它。Web 会话不承载检查,也不需要在退出时交接;常驻 worker 启动时检查一次云端更新,持续运行期间每天检查。设置 LOCI_DATA_DIR 时不保证登录或机器重启后恢复,长期运行需要外部进程管理器托管。详见后台服务与 Web UI。
关闭每日同步只会把来源标记切换为“云端副本 · 手动更新”,不会删除已经下载的正文。以后手动更新或重新开启自动更新时,Loci 会在完整快照校验成功后事务性替换旧内容;失败时继续保留当前可读版本。
需要自己从公开网站创建和抓取文档时,查看本地文档库。