https://github.com/kariy/imaluum-cli
i-Ma'luum as a command line tool
https://github.com/kariy/imaluum-cli
cli iium
Last synced: about 1 year ago
JSON representation
i-Ma'luum as a command line tool
- Host: GitHub
- URL: https://github.com/kariy/imaluum-cli
- Owner: kariy
- Created: 2022-08-29T12:08:38.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-04T03:27:34.000Z (almost 3 years ago)
- Last Synced: 2024-03-15T12:13:08.084Z (over 2 years ago)
- Topics: cli, iium
- Language: TypeScript
- Homepage:
- Size: 116 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 
i-Ma'luum CLI (In progress)
Access i-Ma'luum directly from your command line.
## 🛠 Installation
### Prerequisites
- Must have [`Node.js` & `npm`](https://nodejs.org/en/download/package-manager/) installed.
To install, just do :
```
$ npm install -g imaluum-cli
```
## ✨ Features
Features are rather limited at the moment as there is only so much that you can do on i-Ma'luum from a command line but features that most people would often use are available right now. (or to be implemented)
- [x] Exam Result
- [x] Class Timetable
- [ ] Final Exam Schedule
- [ ] Co-Curricular Information
## 🕹 Usage
```
$ imaluum
Usage: imaluum [options] [command]
A tool to access i-Ma'luum directly from your command line.
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
result [options] Get your examination result.
timetable [options] Show class timetable for the given semester.
authenticate [options] Authenticate to i-Ma'luum site.
help [command] display help for command
```
## 📝 Todo
- [ ] Add support to output as image `.png` for exam result, class, & exam timetable. 📷
- [ ] Add more colours. 🎨
- [ ] Add loader. 🔁
- [ ] Better error handling. 🚫
- [ ] Make it run faster (idk how). ⚡
## 📣 Disclaimer
This tool is not associated with the official i-Ma'luum of IIUM.