NTULearn: Courses, folders and search CLI commands
Back to NTULearn CLI ยท MCP reference
ntu learn auth statusntu learn content treentu learn content showntu learn courses listntu learn search allntu learn search course
Command details
ntu learn auth status
Sign in to NTULearn and report whether access is verified.
Usage
ntu learn auth status
Use ntu learn auth status --help for the current interface.
Arguments and options
--json,-j: Write the result as JSON to stdout; diagnostics go to stderr.
Result
The result may include: credentials_configured, credential_storage, credential_error, session_verified, authentication_method, last_verified_at, session_storage, cache_ttl_seconds.
For the corresponding MCP operation and its field types, see the MCP schema.
ntu learn content tree
Read a course's nested content tree.
Usage
ntu learn content tree ZZ0001
ZZ0001 is a fictional course code. Use ntu learn content tree --help for the current interface.
Arguments and options
COURSE_ID: Required. The NTULearn course ID returned byntu learn courses.--max-depth: Maximum nesting depth to traverse. Default:5.--max-nodes: Maximum number of content nodes to examine. Default:1000.--max-requests: Maximum number of upstream requests the operation may make. Default:100.--refresh,-r: Fetch fresh data instead of using an available cached result.--json,-j: Write the result as JSON to stdout; diagnostics go to stderr.
Result
The result may include: retrieved_at, from_cache, cache_age_seconds, complete, requests_used, issues, course_id, contents, max_depth.
For the corresponding MCP operation and its field types, see the MCP schema.
ntu learn content show
Read one level of course content.
Usage
ntu learn content show ZZ0001
ZZ0001 is a fictional course code. Use ntu learn content show --help for the current interface.
Arguments and options
COURSE_ID: Required. The NTULearn course ID returned byntu learn courses.--parent: The ID of a parent folder. Omit it to browse the top level.--limit,-l: Maximum number of results to return in this page. Default:50.--offset: Number of results to skip before this page. Default:0.--refresh,-r: Fetch fresh data instead of using an available cached result.--json,-j: Write the result as JSON to stdout; diagnostics go to stderr.
Result
The result may include: retrieved_at, from_cache, cache_age_seconds, course_id, contents, offset, next_offset.
For the corresponding MCP operation and its field types, see the MCP schema.
ntu learn courses list
List your enrolled NTULearn courses and organizations, including published availability and course IDs.
Usage
ntu learn courses list --limit 20
Use ntu learn courses list --help for the current interface.
Arguments and options
--limit,-l: Maximum number of results to return in this page. Default:50.--offset: Number of results to skip before this page. Default:0.--refresh,-r: Fetch fresh data instead of using an available cached result.--json,-j: Write the result as JSON to stdout; diagnostics go to stderr.
Result
The result may include: retrieved_at, from_cache, cache_age_seconds, courses, offset, next_offset.
For the corresponding MCP operation and its field types, see the MCP schema.
ntu learn search all
Recursively search content across available enrolled courses, or selected course_ids.
Usage
ntu learn search all example
Use ntu learn search all --help for the current interface.
Arguments and options
QUERY: Required. The search terms. Quote multiword text so the shell passes it as one argument.--course-ids: A JSON array of course IDs.--max-depth: Maximum nesting depth to traverse. Default:5.--max-nodes: Maximum number of content nodes to examine. Default:1000.--max-results: Maximum number of matching results to collect. Default:50.--max-requests: Maximum number of upstream requests the operation may make. Default:100.--refresh,-r: Fetch fresh data instead of using an available cached result.--json,-j: Write the result as JSON to stdout; diagnostics go to stderr.
Result
The result may include: retrieved_at, from_cache, cache_age_seconds, complete, requests_used, issues, query, courses_searched, matches.
For the corresponding MCP operation and its field types, see the MCP schema.
ntu learn search course
Recursively search one course's content titles, body and description for a case-insensitive substring.
Usage
ntu learn search course ZZ0001 example
ZZ0001 is a fictional course code. Use ntu learn search course --help for the current interface.
Arguments and options
COURSE_ID: Required. The NTULearn course ID returned byntu learn courses.QUERY: Required. The search terms. Quote multiword text so the shell passes it as one argument.--max-depth: Maximum nesting depth to traverse. Default:5.--max-nodes: Maximum number of content nodes to examine. Default:1000.--max-results: Maximum number of matching results to collect. Default:50.--max-requests: Maximum number of upstream requests the operation may make. Default:100.--refresh,-r: Fetch fresh data instead of using an available cached result.--json,-j: Write the result as JSON to stdout; diagnostics go to stderr.
Result
The result may include: retrieved_at, from_cache, cache_age_seconds, complete, requests_used, issues, query, courses_searched, matches.
For the corresponding MCP operation and its field types, see the MCP schema.