Using the Filesystem
Use the CodeGrade Filesystem to locally mount submissions in CodeGrade to your local machine for manual grading.
The CodeGrade Filesystem is a unique way to mount your CodeGrade instance locally on your system. This provides the teacher much flexibility by allowing to test, review and grade work from students locally, in your favourite editor and using all required tools.
The CodeGrade Filesystem is an external application that has to be installed on your system manually. Please consult the installing guide for instructions on installing the CodeGrade Filesystem on your operating system:
Before using the Filesystem, you need to have a password set up for your CodeGrade account, find instructions on how to do that here:
Follow the instructions below to use the Filesystem:
  1. 1.
    Open the CodeGrade Filesystem application.
  2. 2.
    Select your institution, or select Other to enter a custom CodeGrade URL.
  3. 3.
    Enter your username and password.
  4. 4.
    Optionally set advanced options in the Advanced tab:
    • Mount location: Specify a custom location for the CodeGrade mount, this defaults to the desktop.
    • Option - Revision mode: Enable revision mode to save and send all additions, edits and deletions in student submissions back to the student as a Teacher Revision. Disable to not synchronise additions, edits or deletions with the CodeGrade server.
    • Option - Assigned to me: Enable to only show submissions that are assigned to you. This option only has effect if submissions are actually assigned and you are one of the assignees.
    • Option - Latest submissions only: Enable to only show the most recent submission of each student, rather than all of their submissions.
    • Notifications: Set the verbosity of notifications, default and recommended is All.
  5. 5.
    Press Mount to mount the CodeGrade server to your computer.
  6. 6.
    Press the pink mountpoint on the top of the CodeGrade Filesystem to navigate to the mount. In this directory an organised overview of courses, assignments and submissions can be found, tested and reviewed.
With the CodeGrade Filesystem mounted, you have access to all submissions in your courses on CodeGrade. These submissions can be opened in your favourite editor to test, review and grade without any overhead. All mounts follow the structure of Course/Assignment/Student_Submission/. All folders with student submissions follow the naming format Full Student Name - DATE TIME, with hand in time and date.
Multiple "special files" can be found in student submissions too, these are generated automatically by CodeGrade Filesystem and can be used to review and grade code. Use the .cg_grade file to grade work, use the .cg_rubric file to fill in the rubric (if present) and use the .cg_feedback file to write general feedback. Saving these files results in automatically updating the values on the CodeGrade server too. Read more about all special files in the section below.
In addition to our AutoTest platform, the use of the special files can allow you to locally run automatic grading scripts that write to the special files to synchronise with the CodeGrade server.
Ultimately, to remove the CodeGrade mount, simply press the Stop button or close the CodeGrade Filesystem application.

Special Files

The CodeGrade Filesystem also creates a few special files, these are files that are not submitted by a student but can be used to control CodeGrade. The format of these files is validated on each save, which fails if not correct. You can use these special files to interact with CodeGrade and give feedback or grade student work. The following special files exist in the CodeGrade Filesystem:
Special files are only editable with the right permissions.
Name
Editable
Location
Use
Format
.api.socket
βœ—
Root
Location of the api socket
Single line with file location
.cg-mode
βœ—
Root
Mode file system
FIXED (non revision mode) or NOT_FIXED (revision mode)
.cg-assignment-id
βœ—
Assignment
ID of this assignment
Single line with ID
.cg-assignment-settings.ini
βœ“
Assignment
Settings for this assignment
Ini file with settings
.cg-edit-rubric.md
βœ“
Assignment
Rubric for this assignment, editing changes the rubric
See .cd-edit-rubric.help
.cg-edit-rubric.help
βœ—
Assignment
Help file for the rubric file
Plain text file
.cg-feedback
βœ“
Submission
The general feedback for this submission
Plain text file
.cg-grade
βœ“
Submission
The grade for this submission
Single float or empty to delete or reset the grade
.cg-rubric.md
βœ“
Submission
The rubric for this submission
Markdown file where a ticked box means the item is selected.
.cg-submission-id
βœ—
Submission
ID of this submission
Single line with ID
Only the markdown checkboxes in the .cg-rubric.md file should be changed to fill in the rubric.
In the case the exact format of a special file is not followed and it cannot be easily recovered, the __RESET__ string can be written to any writable special file to reset it to its server state.
Last modified 5mo ago
Copy link