Access your UIT course materials faster — from your terminal or through AI agents.
Download lectures, check deadlines, read announcements, submit assignments, and more.
Built on Moodle Web Services — works with any Moodle instance.

npm install -g uit-cli  then  uit init.

---

Quick start

npm install -g uit-cli
uit init                    # prompts for student ID/password and stores a Moodle token locally
uit courses --current       # verify it works

uit init uses your password once to request a Moodle Mobile web-service token. The password is not saved; only the returned token is written to ~/.uit/.env on your machine.

Nothing is sent to any third-party server. Credentials and tokens stay local; the CLI talks directly from your machine to the Moodle server configured by UIT_BASE_URL.

Prefer pasting a token manually?

Get your token by visiting this URL in a browser while logged in:

https://courses.uit.edu.vn/login/token.php?username=YOUR_STUDENT_ID&password=YOUR_PASSWORD&service=moodle_mobile_app

uit init --token <your-token>
# Positional token form is still supported:
# uit init <your-token>

Build from source

git clone https://github.com/RyanNg1403/uit-cli.git && cd uit-cli
npm install
npm run build
npm link

# Or run without linking globally:
npm run dev -- courses --current

Requires Node.js 20 or newer. Works on macOS, Linux, and Windows.

---

How IDs Flow

courses   -> course_id  -> contents / download / announcements / deadlines / grades
contents  -> module_id  -> view
view      -> assign_id  -> submit / status
          -> discussion_id -> view-discussion
view-discussion -> post_id -> reply
deadlines -> assign_id  -> view / submit / status

For flags, output formats, and detailed behavior of each command, see the CLI Reference.

---

Examples

For every command, add --json before the command name to get structured output:

uit --json courses --current
uit --json view 428837

Browse and drill down into a course

uit contents 19207                   # see sections, modules, files
uit view 428837                      # inspect an assignment — shows description, due date, status
uit view 432640                      # inspect a lesson — shows instructions, URLs

Download course materials

uit download 19207                   # everything in the course
uit download 19207 --module 428955   # one specific module
uit download 19207 --file "Crypto"   # files matching a name

See upcoming work

uit events                           # assignments, quizzes, calendar events
uit events -n 50                     # more events
uit events --course-id 19207         # filter to one course

Assignment workflow

uit deadlines                        # what's due?
uit view 428837                      # read the assignment description
uit submit 101617 ./report.pdf       # submit
uit status 101617                    # check result

Read announcements and forum threads

uit announcements 19438 --full       # read announcements with full content
uit view-discussion 77900            # read a specific forum thread

Jump to browser from any ID

uit open 428837                      # opens the module page
uit open --course 19207              # opens the course page
uit open --discussion 77900          # opens the discussion thread

Paste Moodle URLs directly — no need to extract IDs

uit view 'https://courses.uit.edu.vn/mod/assign/view.php?id=428837'
uit contents 'https://courses.uit.edu.vn/course/view.php?id=19207'
uit view-discussion 'https://courses.uit.edu.vn/mod/forum/discuss.php?d=77900'

---

Configuration

uit init saves credentials to ~/.uit/.env. You can also place a .env file in your project directory (takes precedence). See .env.example.

By default, uit init prompts for your student ID and password, requests a Moodle Mobile web-service token from /login/token.php, and stores only the returned token. If you already have a token, use uit init --token <token>. The older positional form, uit init <token>, still works.

Development

npm run build       # compile TypeScript into dist/
npm test            # run the regression suite
npm run typecheck   # type-check without emitting files

The npm package exposes the uit binary from dist/cli.js.

Releasing

Releases are tag-driven. After changes are merged to main:

git switch main
git pull origin main
npm version patch   # or minor / major
git push origin main --follow-tags

Pushing the v* tag runs GitHub Actions, publishes to npm, and creates a GitHub Release. The repository must have an npm automation token saved as the NPM_TOKEN GitHub secret.

---

Security and ethics

This tool uses Moodle's official Web Services API — the same interface the Moodle Mobile app uses. It does not scrape, bypass authentication, or exploit any vulnerability. All data accessed is scoped to what your account already has permission to see through the web interface.

UIT-CLI has no backend service. Your student ID, password, Moodle token, downloaded files, and submitted files stay on your local machine except for direct requests from your machine to the Moodle server.

• Keep your API token private — treat it like a password. Never commit .env files or share your token.
• Rotate your token if you suspect it has been compromised by running uit init again.
• Prefer the interactive uit init prompt over uit init --password ...; command-line passwords can be saved in shell history.
• This tool does not escalate privileges — it cannot access anything your account cannot access on the website.

---

License

MIT