canvas-sync

一个基础的 CLI 工具，用于使本地文件夹与 Canvas 上的在线文件夹保持同步。

• 安装
• 配置
• 用法

安装

安装 canvas-sync 需要先安装 cargo。要安装 cargo，请遵循这些 优秀的说明。安装 cargo 后，现在可以使用以下命令安装 canvas-sync：

cargo install canvas-sync

配置

根据您的操作系统，canvas-sync 会选择不同的默认配置文件位置。要查找此位置，请运行：

canvas-sync config

如果不存在，则创建它并使用此模板填写：

---
access_token: a_very_secret_value
base_path: /path/to/your/base # optional
folders:
  - url: https://canvas.nus.edu.sg/courses/12345/files/folder/Lecture%20Notes
    path: MA2101/lec
  - url: https://canvas.nus.edu.sg/courses/98765/files/folder/Tutorials
    path: MA2104/tut

1. access_token - 这是在 canvas 中使用而不是用户名和密码进行身份验证的。这可以在您的 canvas 个人资料设置 中找到，并查找 'token' 关键字。生成一个新的并确保将令牌字符串保存在安全的位置。

2. base_path - 这是一个可选参数，将在配置中预加所有其他路径。如果您想更自由地指定每个路径，则不要在配置中使用此参数。否则，这是一种缩短所有其他路径的好方法。

3. folders - 这是一个包含 { url, path } 对象的数组。 url 指向您要跟踪的 canvas 上的文件夹。 path 指向您计算机上要与此在线文件夹同步的本地目录。

指定 URL

在 { url, path } 对象中，每个 URL 应指向的页面

path 将跟踪此文件夹的内容。

用法

指定您的 配置 后，canvas-sync 支持以下一些命令

canvas-sync        # ping canvas servers to check if token is valid
canvas-sync fetch  # fetch updates without downloading
canvas-sync pull   # fetch and download updates
canvas-sync config # see where your config.yml is stored.
canvas-sync set-token <token>  # set your token