canvas-cli 0.1.0

Interact with Canvas LMS from the command line.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

[![Build and Release](https://github.com/mbund/canvas-cli/actions/workflows/build.yaml/badge.svg)](https://github.com/mbund/canvas-cli/actions/workflows/build.yaml)
![Crates.io Version](https://img.shields.io/crates/v/canvas-cli)
![Crates.io License](https://img.shields.io/crates/l/canvas-cli)

Interact with [Canvas LMS by Instructure](https://instructure.com) from the command line. If your institution hosts Canvas under a `*.instructure.com` domain, it is very likely this will work :rocket:

Features:

- [Submit assignments](#submit-assignments)
- [Download files](#download-files)

![canvas-cli --help](./docs/help.gif)

## Install

### Crate

```
cargo install canvas-cli
```

### Single Static Binary

Download from the [GitHub Releases](https://github.com/mbund/canvas-cli/releases/latest).

### Nix

As a [Nix](https://nixos.org) flake:

```nix
{
  inputs = {
    canvas-cli.url = "github:mbund/canvas-cli";
  };
}
```

```nix
{
  pkgs,
  canvas-cli,
  ...
}: {
  # home-manager
  home.packages = with pkgs; [
    # ...
    canvas-cli.packages.x86_64-linux.default
  ];

  # nixos
  environment.systemPackages = with pkgs; [
    # ...
    canvas-cli.packages.x86_64-linux.default
  ];
}
```

Or run it directly with `nix run github:mbund/canvas-cli auth`.

## Authenticate

Run `canvas-cli auth` and follow the prompts. In total, you will:

Go to your user profile settings at `https://YOUR_INSTITUTION.instructure.com/profile/settings` or through the UI. Go to **Approved Integrations** and click on **+ New Access Token**.

![](./docs/new-access-token.png)

Then, give your access token a reasonable name like `canvas-cli` and click **Generate Token**. You can leave the **Expiration date** and **Expiration time** blank for it to never expire, or to whatever date you feel is reasonable. Note that access tokens can be revoked at any time you want to later.

![](./docs/new-access-token-dialog.png)

Finally, copy this `Token` field and paste it into `canvas-cli auth` when it asks. You can now close out of the dialog.

![Access Token Details dialog with ](./docs/access-token-details.png)

```
$ canvas-cli auth
> Canvas Instance URL: https://osu.instructure.com
> Access token: ********
✓ Test query successful
Authenticated as:
  Mark Bundschuh (he / him / his)
```

## Submit assignments

![canvas-cli submit --help](./docs/submit-help.gif)

Submit interactively, selecting the course and assignment from a dropdown.

![canvas-cli submit upload-test.pdf](./docs/submit.gif)

Or submit programmatically, specifying the Course ID and Assignment ID as arguments. These IDs are in the URL of the assignment on your Canvas instance.

![canvas-cli submit -c 162316 -a 3936973 upload-test-1.pdf](./docs/submit-ids.gif)

Or just pass the URL to parse it.

![canvas-cli submit -u https://osu.instructure.com/courses/183022/assignments/4598164 upload-test-1.pdf](./docs/submit-url.gif)

## Download files

Download one or more files from a course. Note that the list is like the **Files** tab on the course page, rather than any linked files under an Assignment.

![canvas-cli download](./docs/download.gif)