edstem-cli 0.3.6

A CLI for Ed Discussion — browse courses, threads, and comments in terminal

edstem-cli

A terminal-first CLI for Ed Discussion: browse courses, lessons, threads, and comments without leaving the terminal.

Features

• Courses: list all enrolled courses
• Lessons: list course lessons and inspect lesson slides
• Lesson read automation: read matching lessons and push their slide status forward
• Threads: list, filter, and sort course threads
• Thread detail: view full thread with answers and comment tree
• Activity: browse your activity across courses
• User profile: view current user info
• JSON output: export any data for scripting and AI agent integration

AI Agent Tip: Always use --json for structured output instead of parsing the default rich-text display. Use --max to limit results.

Installation

# Recommended: uv tool (fast, isolated)
uv tool install edstem-cli

# Alternative: pipx
pipx install edstem-cli

Agent Skill

Install the agent skill with the shared skills CLI spec:

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

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

edstem skills add

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

Install from source:

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

Update

Update the CLI in place:

edstem update

If you installed from source, update the checkout instead:

git pull
uv sync

Running an older version? Check with edstem --version first. If a command in this README does not exist locally, update the CLI before trying again.

Quick Start

Get your API token from: https://edstem.org/settings/api-tokens

# View your profile and courses
edstem user

# List enrolled courses
edstem courses

# List threads in a course
edstem threads 12345

# List lessons in a course
edstem lessons 12345

# View a thread with comments
edstem thread 67890

Usage

# Courses
edstem courses
edstem courses --archived
edstem courses --json

# Threads
edstem threads <course_id>
edstem threads <course_id> --sort top
edstem threads <course_id> --category "HW1"
edstem threads <course_id> --type question
edstem threads <course_id> --unanswered
edstem threads <course_id> --max 50 --json

# Thread detail
edstem thread <thread_id>
edstem thread <course_id>#<number>      # by course thread number
edstem thread <thread_id> --json
edstem thread <thread_id> --md -o thread.md
edstem thread <thread_id> --json --pretty
edstem thread <thread_id> --json --include-html
edstem thread <thread_id> --json --legacy-json

# Lessons
edstem lessons <course_id>
edstem lessons <course_id> --module "Week 1"
edstem lessons <course_id> --type python --status attempted
edstem lesson <lesson_id>
edstem lesson <lesson_id> --json
edstem lesson <lesson_id> --md -o lesson.md
edstem lessons read <course_id> Pre-Reading
edstem lessons read <course_id> Week 3 Workshop

# Activity
edstem activity                          # all courses
edstem activity <course_id>              # specific course
edstem activity --filter answer --json

# User
edstem user
edstem user --json

# Option 1: Environment variable
export ED_API_TOKEN="your-token-here"

# Option 2: Will prompt on first use and save automatically
edstem user

Thread JSON

edstem thread ... --json emits a compact thread shape by default. It hoists authors into a top-level users map, drops XML content unless --include-html is requested, trims default false/zero/empty fields, and adds an endorsement block for source-marked endorsed replies and staff activity.

• Use --pretty when a human needs to read the JSON in the terminal.
• Use --legacy-json when an existing consumer still expects embedded authors and the verbose legacy shape.

Markdown Export

Use --md or --format md on full-detail commands when you want a readable Markdown file instead of JSON:

edstem lesson 105199 --md -o lesson.md
edstem thread 29579#42 --md -o thread.md

Markdown output strips Ed XML into readable text and keeps lesson slides, thread answers, comments, nested replies, and visible source markers such as endorsed or anonymous replies.

Mark Lessons Read

Use lessons read when you want the CLI to visit lessons and push their slide status forward. Query words are matched case-insensitively against lesson titles and module names. For non-quiz slides the CLI calls the lesson completion endpoint. For quiz slides it records a view.

# Mark all pre-reading lessons in a course as read
edstem lessons read 29579 Pre-Reading

# Mark week 1 applied/workshop content as read
edstem lessons read 29579 Week 1 Workshop
edstem lessons read 29579 Week 1 Applied

# Add a delay between slide actions
edstem lessons read 29579 Applied --delay 0.3

# Export a machine-readable summary
edstem lessons read 29579 Pre-Reading --json

Configuration

Create config.yaml in your working directory:

fetch:
  count: 30

rateLimit:
  requestDelay: 1.0
  maxRetries: 3
  retryBaseDelay: 3.0
  maxCount: 100

• fetch.count is the default item count when --max is omitted

Development

# Install dev dependencies
uv sync --extra dev

# Lint + tests
uv run ruff check .
uv run pytest -q

Acknowledgements

This project builds on ideas and structure from
twitter-cli.
Thanks to the original project for the foundation and inspiration.