mcgill-cli v0.0.0

mcgill-cli

A CLI to interact with McGill University's online resources

• mcgill-cli
• Usage
• Commands

Usage

$ npm install -g mcgill-cli
$ mcgill COMMAND
running command...
$ mcgill (-v|--version|version)
mcgill-cli/0.0.0 darwin-x64 node-v12.9.1
$ mcgill --help [COMMAND]
USAGE
  $ mcgill COMMAND
...

Commands

• mcgill addCourse
• mcgill getCourse
• mcgill getTranscript
• mcgill help [COMMAND]
• mcgill watch

mcgill addCourse

addCourse signs you up for a course (by CRN)

USAGE
  $ mcgill addCourse

OPTIONS
  -c, --crn=crn            CRN code for desired class
  -h, --help               show CLI help
  -p, --password=password  minerva password
  -s, --season=season      season as 1 letter: 'f' for fall, 'w' for winter, 's' for summer
  -u, --username=username  minerva username (mcgill email)
  -y, --year=year          year of class

See code: src/commands/addCourse.ts

mcgill getCourse

getCourse returns the information for a specific course

USAGE
  $ mcgill getCourse

OPTIONS
  -S, --subject=subject    class/department subject (ex: "COMP")
  -h, --help               show CLI help
  -n, --classNum=classNum  class number (ex: "303" for COMP 303
  -p, --password=password  minerva password
  -s, --season=season      season as 1 letter: 'f' for fall, 'w' for winter, 's' for summer
  -u, --username=username  minerva username (mcgill email)
  -y, --year=year          year of class

See code: src/commands/getCourse.ts

mcgill getTranscript

getTranscript retrieves current transcript from Minerva

USAGE
  $ mcgill getTranscript

OPTIONS
  -c, --current            current year only
  -h, --help               show CLI help
  -p, --password=password  minerva password
  -u, --username=username  minerva username (mcgill email)

See code: src/commands/getTranscript.ts

mcgill help [COMMAND]

display help for mcgill

USAGE
  $ mcgill help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

mcgill watch

watches a specific course, and signs you up as soon as a spot becomes available

USAGE
  $ mcgill watch

OPTIONS
  -S, --subject=subject    class/department subject (ex: "COMP")
  -c, --crn=crn            CRN code for desired class
  -h, --help               show CLI help
  -n, --classNum=classNum  class number (ex: "303" for COMP 303
  -p, --password=password  minerva password
  -s, --season=season      season as 1 letter: 'f' for fall, 'w' for winter, 's' for summer
  -u, --username=username  minerva username (mcgill email)
  -y, --year=year          year of class

See code: src/commands/watch.ts