Skip to content
pkuinfoPublic

About

CLI anything

Resources

Stars

15 stars

Watchers

1 watching

Forks

Latest commit

 

History

34 Commits

Folders and files

Repository files navigation

PKU CLI

Your campus life, from the terminal.

crates.io License Rust

A unified command-line toolkit for Peking University services — treehole, courses, campus card, elective, credential management, and WeChat article crawler.

Getting Started · Tools · Claude Code Integration · Architecture


Getting Started

Prerequisites

You need a Rust toolchain (rustup recommended).

Linux additionally needs system libraries used by two transitive -sys crates:

Package Used by Purpose
pkg-config build system locate the libs below
OpenSSL dev headers (libssl-dev / openssl-devel) openssl-sys ← reqwest's native-tls HTTPS to PKU services
D-Bus dev headers (libdbus-1-dev / dbus-devel) libdbus-sys ← keyring's Linux Secret Service backend store/read IAAA credentials
C toolchain (build-essential / gcc) linker for the above compile native code

One-liners:

# Debian / Ubuntu
sudo apt install -y pkg-config libssl-dev libdbus-1-dev build-essential

# Fedora / RHEL
sudo dnf install -y pkg-config openssl-devel dbus-devel gcc

# Arch
sudo pacman -S --needed pkgconf openssl dbus base-devel

Note

At runtime, info-auth store on Linux talks to a running Secret Service (GNOME Keyring, KWallet, KeePassXC, …). On a headless server without one, fall back to env vars: export PKU_USERNAME=… PKU_PASSWORD=….

macOS and Windows need no extra system packages — native-tls uses Security framework / SChannel and keyring uses Keychain / Credential Manager. Just install the Rust toolchain.

Install

cargo install pku-cli --locked

One command installs the unified pku binary with access to all tools:

pku treehole login -p        # Login to treehole
pku course courses --all     # List all courses
pku card info                # Campus card balance
pku elective show            # View course selections
pku auth store               # Store IAAA credentials
pku spider search "北大"      # Search WeChat articles

Tip

You can also install tools individually if you only need specific ones:

cargo install pku-treehole pku-course pku-campuscard pku-elective pku-auth pkuinfo-spider

First-time Setup

1. Store your IAAA credentials once (encrypted in your OS keychain):

info-auth store

2. Login to any service — credentials resolve automatically:

treehole login -p
course login -p
campuscard login -p
elective login -p

Note

Passwords are never exposed in CLI arguments, environment variables, or logs. The info-auth store command uses interactive input and stores credentials in the OS keychain (macOS Keychain / GNOME Keyring / Windows Credential Manager).

Tools

Treehole — 北大树洞

Anonymous forum client with full read/write support.

treehole list                    # Browse latest posts
treehole search "关键词"          # Full-text search
treehole show 12345              # View post + replies
treehole post -t "Hello world"   # Create a post
treehole score                   # View your grades
treehole schedule                # This week's schedule

Course — 教学网 (Blackboard Learn)

Course management, assignments, lecture recordings, and tools for teaching assistants.

course courses --all             # List all courses
course assignments               # Pending assignments
course videos                    # Lecture recordings
course submit                    # Submit homework (interactive)
course browse                    # Interactive course browser
course ta --help                 # TA tools: post files, create assignments, grade (writes need --yes)

Campuscard — 校园卡

Campus card balance, payments, transaction history.

campuscard info                  # Card info & balance
campuscard pay                   # Show payment QR code
campuscard bills --month 2026-03 # Transaction history
campuscard stats                 # Monthly spending breakdown
campuscard recharge -a 100       # Top up 100 yuan

Elective — 选课网

Course selection with automated retry and CAPTCHA handling.

elective show                    # Current selections
elective list                    # Available courses
elective set                     # Pick target courses (interactive)
elective launch -t 15            # Auto-select loop, 15s interval

Disk — 北大网盘

Browse and download PKU Netdisk files (read-only): personal, shared and department libraries.

disk ls                          # All document libraries
disk ls 个人/课件                 # Browse a folder
disk download 个人/课件 -o ./out  # Download a folder, keeping its structure

Mail — 北大学生邮箱

Student mailbox (@stu.pku.edu.cn, NetEase Enterprise Mail): folders, list, read, search, attachments, contacts, send and reply. Logs in with your student ID and IAAA password (checked by the mail server itself, not via IAAA); a new machine needs one SMS code. Sending always previews first and only goes out with --yes.

mail login -p                    # SMS code once per machine
mail ls --unread                 # Unread mail in the inbox
mail read <mid>                  # Read (does not mark as read)
mail search 奖学金                # Full-text search
mail download <mid> -o ./out     # All attachments
mail send --to a@pku.edu.cn -s "Hi" --body "..."   # Preview; add --yes to send

Info Spider — 微信公众号爬虫

WeChat Official Account article crawler (standalone auth, not IAAA).

info-spider login                # WeChat QR code login
info-spider search "人民日报"     # Search official accounts
info-spider articles --name "X"  # List articles from an account
info-spider scrape <url>         # Convert article to Markdown

Claude Code Integration

PKU CLI is designed to work with Claude Code as an AI-powered campus assistant.

Install Skills

Via Clawhub (recommended):

npm i -g clawhub
clawhub install pku-treehole
clawhub install pku-course
clawhub install pku-campuscard
clawhub install pku-elective
clawhub install pku-info-spider
clawhub install pku-info-common
clawhub install pku-info-auth

Via Claude Code Plugin Marketplace:

/plugin marketplace add pkuinfo/pkucli
/plugin install pku-cli@pku-cli

Agent Prompt

Use this system prompt to enable Claude Code to manage your PKU services autonomously:

You have access to PKU CLI tools. Before using any tool, run `info-auth check`
to verify session status. If a session is expired or missing, run
`<tool> login -p` to auto-login using stored credentials.

Available tools:
- treehole: browse/post/search the PKU anonymous forum
- course: manage Blackboard Learn courses, assignments, videos
- campuscard: check balance, pay, view transaction history
- elective: automated course selection with CAPTCHA solving
- mail: student mailbox — read/search/download; send/reply preview unless --yes
- info-spider: crawl WeChat official account articles
- info-auth: manage IAAA credentials (store/check/clear)

Credentials are stored in the OS keyring. Never ask the user for passwords.
Use `info-auth store` only when no credentials exist.

Important

Run info-auth store interactively before giving Claude Code access. AI Agents cannot and should not handle password input — they only call <tool> login -p which reads from the OS keyring automatically.

Architecture

pku-cli                  Unified entry point — `pku` binary
pkuinfo-common (lib)     Shared: IAAA auth, OTP, session, credential resolution
  │
  ├── pku-treehole       Treehole anonymous forum
  ├── pku-course         Blackboard Learn
  ├── pku-campuscard     Campus card (Synjones)
  ├── pku-elective       Course selection
  └── pku-auth           Credential management

pkuinfo-spider           WeChat article crawler (standalone auth)

Auth Flow

All PKU services share a unified IAAA single-sign-on flow:

OS Keyring ──→ IAAA SSO ──→ Service callback ──→ Session persisted
                  │
                  ├── treehole:   JWT token
                  ├── course:     Blackboard session
                  ├── campuscard: Synjones JWT
                  └── elective:   Cookie session

Credential resolution order:

  1. OS Keyring — set by info-auth store
  2. Environment variables — PKU_USERNAME + PKU_PASSWORD
  3. Interactive prompt — fallback

Crates

Crate Type Description
pku-cli meta One install for all tools
pkuinfo-common lib IAAA auth & shared utilities
pku-treehole bin Treehole CLI
pku-course bin Blackboard Learn CLI
pku-campuscard bin Campus card CLI
pku-elective bin Course selection CLI
pku-auth bin Credential management
pkuinfo-spider bin WeChat article crawler
pku-disk bin PKU Netdisk CLI
pku-mail bin Student mail (@stu.pku.edu.cn) CLI

About

CLI anything

Resources

Stars

15 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages