moodle-cli 0.4.0

Terminal-first CLI for Moodle LMS

moodle-cli

Terminal-first CLI for Moodle LMS that reuses an authenticated browser session.

Features

• No API token setup required
• Reuses MoodleSession from okta-auth, your browser, or MOODLE_SESSION
• Works with Moodle AJAX APIs and falls back to authenticated page scraping when needed
• Upcoming timeline items for student-facing deadlines and actions
• Terminal output plus --json and --yaml

Requirements

• Python 3.10+
• uv
• One of:
  • okta-auth-cli configured for your Moodle site
  • An active Moodle browser session
  • A MOODLE_SESSION environment variable

Install

# Recommended: uv tool
uv tool install moodle-cli

# Optional: automatic Okta login and session reuse
uv tool install okta-auth-cli
okta config

# Alternative: pipx
pipx install moodle-cli

Agent Skill

Install the agent skill with the shared skills CLI spec:

npx skills add https://github.com/bunizao/moodle-cli

If you already installed moodle, the CLI exposes the same thing as a thin alias:

moodle skills add

If npx is not available, the alias falls back to npm exec.

Install from source:

git clone https://github.com/bunizao/moodle-cli.git
cd moodle-cli
uv sync

Usage

moodle --help
moodle user
moodle alerts
moodle todo
moodle overview
moodle courses
moodle grades 34637
moodle activities 34637
moodle https://school.example.edu/course/view.php?id=34637
moodle https://school.example.edu/mod/forum/discuss.php?d=9001#p9101 --json
moodle skills
moodle skills add
moodle update
moodle update --check-only

You can also paste supported Moodle page URLs directly as the first argument. The CLI routes forum discussion, forum view, assignment, quiz, resource, link, page, folder, course, and grade report URLs to the shortest matching command.

To check without applying an upgrade:

moodle update --check-only

moodle update now tries to upgrade directly with uv tool upgrade moodle-cli and falls back to pipx upgrade moodle-cli when needed.

To upgrade manually after an update is available:

uv tool upgrade moodle-cli
# or
pipx upgrade moodle-cli

Configuration

On first run, if no base_url is configured, the CLI will prompt you and write it to config.yaml in the project directory or in ~/.config/moodle-cli/:

base_url: https://school.example.edu

Required format:

• Use a full root URL such as https://school.example.edu
• Do not include paths, query strings, or fragments
• Do not use URLs like /login/index.php or /my/
• The CLI validates the URL against Moodle's token endpoint and asks again if it does not look valid

You can also set MOODLE_BASE_URL instead of using the interactive prompt. You can copy from config.example.yaml.

Environment overrides:

• MOODLE_BASE_URL
• MOODLE_SESSION

Development

uv run python -m compileall moodle_cli
uv build