TronClass CLI Skill#

You have access to tronclass-cli, a command-line tool for managing the user's TronClass account.

Setup#

Install globally (once):

bash

npm install -g tronclass-cli

General Guidelines#

• Authentication: Most commands require a saved session. If a command fails, tell the user to run tronclass auth login <username>. The session is reused automatically; tronclass auth check probes a live TronClass endpoint to confirm whether it's still valid.
• FJU users: Use tronclass auth login --fju <student_id> for the CAS flow with CAPTCHA support.
• Non-interactive login (agents/scripts): Pass --password <p> (and --base-url <u> for generic deployments) to skip prompts. For FJU, where a human must solve the CAPTCHA, use the two-step deferred flow: tronclass auth login --fju --non-interactive <user> prints a captcha ID and opens the captcha image; then tronclass auth captcha --password <p> <captcha_id> <code> completes the login. The password is never written to disk — it is supplied only at resume time.
• Finding IDs: The typical lookup chain is courses list → activities list <course_id> → activities view <activity_id>. The todo command shows activity IDs directly in the first column.
• Aliases: activities → a, courses → c, homework → hw/ h, todo → td/ t, announcements → ann. Subcommands also have short aliases ( list → l/ ls, view → v, download → d/ dl, submit → s).

Command Quick Reference#

CommandWhat it doestronclass auth login [--fju] [--password <p>] [--base-url <u>] <user>Log in (interactive by default; --password / --base-url make it non-interactive)tronclass auth login --fju --non-interactive <user>Start a deferred-CAPTCHA FJU login; prints a captcha ID, no password on disktronclass auth captcha --password <p> <id> <code>Complete a deferred FJU login with the solved CAPTCHAtronclass auth checkProbe a live endpoint to report session validity (Valid / Expired / Unknown)tronclass auth logoutClear saved sessiontronclass todoPending tasks — first column is the activity IDtronclass courses list [--all] [--raw]List coursestronclass activities list <course_id>List activities in a coursetronclass activities view <activity_id>Rich view: metadata + description + attachmentstronclass activities download <ref_id> [output]Download file (defaults to ~/Downloads/)tronclass homework list <course_id>List homework for a coursetronclass homework view <activity_id>Rich view: metadata + prompt + teacher attachments + your own submission/drafttronclass homework submit <activity_id> <files...>Submit homework filestronclass ann list [course_id]List announcements (school-wide if no course_id)tronclass ann view <ann_id> [course_id]Rich view: metadata + HTML-rendered body + attachmentstronclass ann download <ref_id> [output]Download an announcement attachment

Most list/view commands support --fields f1,f2,... to customize displayed columns.

Key Behaviors#

tronclass todo — shows id, course_name, title, end_time by default. The id column is the activity ID you can pass directly to activities view.

tronclass activities view <id> — displays a formatted table (not raw JSON). The Attachments section lists each file with its ref_id and a ready-to-run download command. No need to manually dig through JSON.

tronclass activities download <ref_id> — output_file is optional. If omitted, the file is saved to ~/Downloads/<filename> using the server-provided filename.

tronclass homework view <activity_id> — rich layout: metadata (status / deadline color-coded), HTML-rendered prompt, teacher attachments (each with ref_id for activities download), and a "My Submission" section showing whether you've submitted, saved a draft, or done nothing — plus the files you uploaded. Use this before submitting to read the prompt and confirm a draft.

tronclass ann list — with no argument, lists the school-wide announcement feed (first page, ~30 items). Pass a course_id to list announcements for a specific course.

tronclass ann view <ann_id> — renders the announcement's HTML body in the terminal (bold, links, lists, images). If you know which course the announcement belongs to, pass course_id as the second argument to skip a multi-page search of the global feed.

Common Workflows#

Check what's due:

bash

tronclass todo

Download a course file:

bash

tronclass courses list                        # get course_id
tronclass activities list <course_id>         # get activity_id
tronclass activities view <activity_id>       # see Attachments table → note ref_id
tronclass activities download <ref_id>        # saves to ~/Downloads/ automatically

Submit homework:

bash

tronclass homework list <course_id>           # find activity_id
tronclass homework view <activity_id>         # read the prompt + grab teacher attachments
tronclass homework submit <activity_id> ./my_essay.pdf --draft   # save a draft first
tronclass homework view <activity_id>         # verify the draft
tronclass homework submit <activity_id> ./my_essay.pdf           # final submit

Read announcements:

bash

tronclass ann list                            # school-wide feed
tronclass ann list <course_id>                # course-specific feed
tronclass ann view <ann_id> [course_id]       # full content, HTML rendered

Reference Files#

For detailed option lists, field names, and edge cases, load the relevant reference:

• references/auth.md — login flows, session management
• references/todo.md — todo fields, filtering
• references/courses.md — course fields, --raw flag
• references/activities.md — activities list/view/download in depth
• references/homework.md — homework list, view, submit options, draft mode
• references/announcements.md — announcements list, view (HTML rendering), download