Skip to content

CLI 命令

version

查看当前 Elog 的版本号

shell
elog --version

init

初始化 Elog 配置

shell
elog init [option] [value]
optionalias说明默认值
--config-c自定义配置文件的名称elog.config.js
--env-e自定义缓存文件的名称elog.cache.json

sync

同步文章

shell
elog sync [option] [value]
optionalias说明默认值
--config-c指定配置文件 pathelog.config.js
--env-e指定环境文件 path-
--cache-a指定缓存文件 pathelog.cache.json
--debug打印更多调试日志
--force强制同步
--full-cache缓存文档全部信息
-disable-cache禁用缓存进行同步,等同于删除缓存文件进行全量更新

--force 说明

当需要写作平台的文档和本地文档保持一致时,可添加此命令行参数。例如在写作平台删除文档A后,可通过--force参数在本次同步文档时删除本地的文档A。

使用前请注意以下事项:

  • 只支持文档删除时强制同步,不支持文档改名后删除改名前的文档
  • 你也可以通过elog clean直接清空本地文档后,重新同步文档

--full-cache 说明

请注意,使用此参数后,缓存文件的大小大约是原文档的2-10倍!

常用于本地调试,elog.cache.json缓存文件是实现Elog增量同步的关键,一般情况下只会保存文档的一部份原始信息。

当需要对比原文档和Elog处理之后的文档时,可通过此命令行缓存文档处理过程中的所有信息。

clean

清理文章、上次同步缓存、上次同步时间

shell
elog clean [option] [value]
optionalias说明默认值
--config-c指定配置文件 path,用于读取存储文章目录elog.config.js
--cache-a指定缓存文件 pathelog.cache.json

upgrade

更新全局 elog 版本到最新正式版(latest) 版本

shell
elog upgrade