sms-cli-h11bcake
v2.0.1
Published
SMS v2 Command Line Interface - Student Marks Management System
Downloads
214
Maintainers
Readme
SMS v2 CLI - Student Marks Management System
Command-line interface for the SMS v2 Student Marks Management System built with Node.js.
Installation
Prerequisites
- Node.js >= 16.0.0
- npm >= 7.0.0
npm install -g sms-cli-h11bcakeCommands Overview
Test installation
sms --helpLogin (interactive prompt)
sms loginLogin with flags
sms login --zid <your-zid> --password <your-password>Check who's logged in
sms whoamiLogout
sms logoutView Course Information
Shows count of students, items in course, type of each item, average marks, etc.
sms course <CourseCode> <TermCode>Make a New Course using an Old Course as Template
Creates a new course in the current term with the same items as an existing course in the source term.
sms mkcourse <SourceCourseCode> <SourceTermCode>OR Creates a new course in the specified term with the same items as an existing course in the source term.
sms mkcourse <SourceCourseCode> <SourceTermCode> <NewCourseCode> <NewTermCode>View Student Marks
Shows marks for all submitted items past deadline. Displays:
sms marks <CourseCode> <TermCode> <zID>View Item Details
Shows details of a specific item (type, maxval, deadline, etc.)
sms item <CourseCode> <TermCode> <ItemCode>Download Marks
Downloads final marks in studentID,mark format to stdout. Redirect to file as shown above.
sms download <CourseCode> <TermCode> <ItemCode>Upload Marks
Uploads raw marks from file in studentID,mark format.
sms upload <CourseCode> <TermCode> <ItemCode> <path-to-file-with-marks>View My Marks (as Students)
Shows your own marks for all submitted and calculated items, including:
sms mymarks <CourseCode> <TermCode>Enrollment Cron Job
Starts a cron job that periodically uploads enrollment data from a tab-separated file. Default schedule: Every day at midnight (00:00).
sms enrollment-cron <path-to-enrollment-file>Submissions Cron Job
Starts a cron job that periodically uploads submission data from a file generated by UNSW Give System. Default schedule: Every 20 minutes.
sms submissions-cron <path-to-submissions-file>Custom schedule (every 5 minutes)
sms <cron-command> --schedule "*/5 * * * *"Stop Cron Job
sms <cron-command> --action stop