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