Local runner for GitHub autograder
1# GitHub Grader Preview
2
3Simple program that runs test cases specified in an autograding.json file and
4reports results. Useful for previewing how GitHub will run your autograder and
5project.
6
7> [!WARNING]
8>
9> While this works on Windows, the GitHub classroom runner uses Linux by
10> default, and so some professors may write commands specific to Linux meaning
11> they won't work for you. You can try running this in WSL.
12
13## Usage
14
15```sh
16gh-grader-preview
17```
18
19Will auto-find the `autograding.json` file located in `.github/classroom`
20relative to the current dir.
21
22You can specify `-f` to choose a different file.
23
24```sh
25gh-grader-preview -f some/other/dir/autograding.json
26```
27
28To see output from the test cases, use the `-v` flag.
29
30```sh
31gh-grader-preview -v
32```
33
34For more information, run `gh-grader-preview -h`.
35
36## Building
37
38`cargo build --release`
39
40### Installation
41
42Copy the binary from `target/release/gh-grader-preview` to a directory in your
43PATH.
44
45Run `gh-grader-preview --man-page` to print the man page to stdout, and then
46save it to a file.
47
48Run `gh-grader-preview --completions=SHELL` (replace `SHELL` with `bash`,
49`fish`, or `zsh`) to generate a shell completion script.