CLI-ITU

An command-line interface (CLI) for all things ITU related.

The CLI currently allows you to:

• open ITU's platform (including individual LearnIT course pages)
• canteen: see the menu and opening hours
• wayfinding: find the location of every room, skybox, and facility on Campus
• Kattis commands (WIP)

This project is open source. Any contributions by students, professors or other staff members at the IT University of Copenhagen are highly welcome.

Powered by OCLIF

• CLI-ITU
• Usage
• Commands

Usage

$ npm install -g cli-itu
$ itu COMMAND
running command...
$ itu (-v|--version|version)
cli-itu/3.2.1 linux-x64 node-v14.18.1
$ itu --help [COMMAND]
USAGE
  $ itu COMMAND
...

Commands

• itu canteen [ACTION]
• itu commands
• itu feedback
• itu help [COMMAND]
• itu kattis ACTION PROBLEM_ID
• itu learnit [COURSE]
• itu open PLATFORM
• itu update [CHANNEL]
• itu where ROOMNAME

itu canteen [ACTION]

get the menu and opening hours of ITU's canteen

USAGE
  $ itu canteen [ACTION]

ARGUMENTS
  ACTION  (menu|hours) [default: menu]
          menu:  fetches the most recently uploaded lunch menu (not always up-to-date)
          hours: get the opening hours

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ itu lunch

See code: src/commands/canteen.ts

itu commands

list all the commands

USAGE
  $ itu commands

OPTIONS
  -h, --help              show CLI help
  -j, --json              display unfiltered api data in json format
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --hidden                show hidden commands
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

See code: @oclif/plugin-commands

itu feedback

report a bug or suggest an issue to improve the CLI.

USAGE
  $ itu feedback

OPTIONS
  -h, --help      show CLI help
  -n, --noprompt  turn off the issue prompt and open the issues page for the CLI instead

DESCRIPTION
  Requires Github CLI installed to create the issue. To manually submit, use the --noprompt flag.

See code: src/commands/feedback.ts

itu help [COMMAND]

display help for itu

USAGE
  $ itu help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

itu kattis ACTION PROBLEM_ID

fetch: downloads sample data files to directory. WARNING: the program will overwrite existing data files of the same name.

USAGE
  $ itu kattis ACTION PROBLEM_ID

OPTIONS
  -h, --help  show CLI help

DESCRIPTION
  fetch: downloads sample data files to directory. WARNING: the program will overwrite existing data files of the same 
  name.

See code: src/commands/kattis.ts

itu learnit [COURSE]

open a course's LearnIT page directly from your terminal.

USAGE
  $ itu learnit [COURSE]

ARGUMENTS
  COURSE  the name of the course to open in LearnIT. Supports fuzzy searching

OPTIONS
  -a, --add     add a course to the config file
  -d, --delete  remove a course from the config file
  -e, --edit    edit a course from the config file
  -h, --help    show CLI help
  -i, --init    initialize the config file
  -r, --reset   reset the config file

DESCRIPTION
  CONFIG
     for a course page to be openable, it must first be added to the config file.

     generate config   $ itu learnit --init
     add a course      $ itu learnit --add
     edit a course     $ itu learnit --edit
     delete a course   $ itu learnit --delete

     to find the course id:
     - open the LearnIT page
     - locate the number in the end of the URL

     Example: https://learnit.itu.dk/course/view.php?id=3020335 -> 3020335

ALIASES
  $ itu l

EXAMPLES
  $ itu learnit security
  $ itu learnit 'Applied Algorithms' 
  $ itu l discrete

  $ itu learnit --init
  $ itu learnit --reset
  $ itu learnit --delete
  $ itu learnit --add

See code: src/commands/learnit.ts

itu open PLATFORM

open an ITU platform

USAGE
  $ itu open PLATFORM

ARGUMENTS
  PLATFORM  (learnit|student|timeedit|mystudyactivities|itu|github|kattis) [default: learnit] ITU platform to open

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ itu o

EXAMPLES
  $ itu open learnit
  $ itu open timeedit

See code: src/commands/open.ts

itu update [CHANNEL]

update the itu CLI

USAGE
  $ itu update [CHANNEL]

OPTIONS
  --from-local  interactively choose an already installed version

See code: @oclif/plugin-update

itu where ROOMNAME

find the location of auditoriums, labs, departments and class rooms - on the first try

USAGE
  $ itu where ROOMNAME

ARGUMENTS
  ROOMNAME
      the following arguments are accepted: 
      Auditoriums: (AUD0|AUD1|AUD2|AUD3|AUD4) 
      Departments: (SAP|studentadvisors|IT|analog|scrollbar|canteen) 
      Labs: (AIR|BUILD|ETHOS|IXD) 
      Rooms: (2A08|2A12|...|5A64) 
      Wings: (B|C|D|E)

OPTIONS
  -h, --help  show CLI help

DESCRIPTION
  Tells which side the room is facing

ALIASES
  $ itu w
  $ itu whereis

See code: src/commands/where.ts