README.md

yukictl

Table of Content

• Introduction
• Handbook
  • 自动补全
  • 获取同步状态
  • 手动开始同步任务
  • 更新仓库同步配置

Introduction

yuki 的命令行客户端。

Handbook

自动补全

# Zsh:
$ yukictl completion zsh

# Bash:
$ yukictl completion bash

获取同步状态

$ yukictl meta ls [repo]

手动开始同步任务

$ yukictl sync <repo>

开启同步任务的 debug 模式

$ yukictl sync --debug <repo>

更新仓库同步配置

新增或修改完仓库的 YAML 配置后，需要执行下面的命令来更新配置。

$ yukictl reload <repo>

注意：在新增配置前需要先创建仓库相应的 storageDir。

如果不带任何参数的话，则该命令会更新所有仓库的同步配置，并且删除配置里没有但数据库里有的仓库配置。

$ yukictl reload

若需要删除仓库，则可以删除相应的配置文件，然后执行 yukictl repo rm <repo> 或 yukictl reload 来从数据库里删除配置。