Git:
Flag | Long option | Name | Optional (Default) |
-g | --git | Github Request/Oauth Token | N/A |
-u | --username | Username | No |
-r | --repo | Path to repo txt file | No |
-b | --branch | Branch | No |
-d | --directory | Directory to download to | Yes (Temp dir)* |
--subdirectory | Subdirectory of repo to download | Yes | |
--files | Specific files to download | Yes | |
--timestamp | ISO 8601 compliant timestamp in format YYYY-MM-DDTHH:MM:SSZ | Yes (Current time) |
*OS specific, operation could fail, would then require declared directory
If executing a Git request without an Oauth token include the -g flag but add a space in quotes at the end:
-g “ “
Can combine subdirectory and path to list of files params, file path get concatenated to the end of subdirectory param. For example if wanting to pull test.txt from: https://github.com/[username]/[repo]/tree/[branch]/dir1/dir2/dir3/test.txt the correct param would be -subdirectory dir1/dir2 and -files linking to a file with the line dir3/test.txt. Using -subdirectory dir1/dir2 _and _dir1/dir2/dir3/test.txt would result in the API looking for your file at https://github.com/[username]/[repo]/tree/[branch]/dir1/dir2/dir1/dir2/dir3/test.txt
MOSS:
Flag | Long option | Name | Optional (Default) |
-m | --moss | Moss Request/ID | N/A |
-l | --language | Language of files | No |
-d | --directory | Directory of student files | No unless preceded by Git request |
--basefiles | Directory of basefiles | Yes |
Codequiry:
Flag | Long option | Name | Optional (Default) |
-c | --codequiry | Codequiry Request/API | N/A |
-l | --language | Language of files | No |
-d | --directory | Directory of student files | No unless preceded by Git request |
--name | Name of request | Yes |
For Codequiry ensure that the directory passed corresponds to the immediate parent of all student files/directories. It will treat every subfolder and file as its own student. If you have a folder with 10 student folders and a readme.md it will treat it as having 11 students, with one named “readme”.
The Directory flag is identical for Git, MOSS and Codequiry. It’s inclusion will set the directory for all the operations. Git will download to a temporary directory which MOSS and Codequiry operations will access.
Likewise the language flag is identical for MOSS and Codequiry it’s inclusion will set the language for both operations.
Examples of valid commands include:
-g “ ” -u synewmark-resources -r "C:\Users\ahome\OneDrive\Desktop\Students.txt" --subdirectory StudentCode -b main -c codequiry_api_key -l java
--codequiry Codequiry API key -l java --directory "C:\Users\ahome\OneDrive\Desktop\StudentFiles"
--moss MOSS API key --language java --directory "C:\Users\ahome\OneDrive\Desktop\StudentFiles\