The official website of PKU harness, a pluggable, keyless, unified agent harness on your phone: the open-source, AI-native app for campus life at Peking University. Download page, developer documentation, and the plugin marketplace.
| Landing and download | The project showcase (WebGL aurora, three.js plugin constellation, motion) and a download page that reads the latest APK, size, SHA-256 and release notes from GitHub Releases. |
| Developer docs | How the harness works and how to build plugins: concepts, the PLUGIN.md plugin language, remote (MCP) plugins, the SDK, PKU harness Cloud with an OpenAPI reference. Written for people and AI agents. |
| Plugin marketplace | Indexes GitHub repos the way skills.sh indexes skills: one repo can hold many plugins, each found by its PLUGIN.md. Every plugin page shows exactly what it may access, plus an install link, deep link and QR code. Anyone can submit a repo; a bot checks it and opens a pull request. |
Every docs page is also served as Markdown, so coding agents can read the docs directly:
| URL | Content |
|---|---|
/llms.txt |
Index of all pages |
/llms-full.txt, /llms-full.zh.txt |
All docs in one file (English, Chinese) |
/en/docs/<page>.md, /docs/<page>.md (Chinese), or Accept: text/markdown |
One page |
/marketplace.json, /marketplace/llms.txt |
The marketplace index |
/schema/plugin-manifest.v1.json |
JSON Schema for remote-plugin manifests |
Next.js 16 (App Router, Turbopack) · Fumadocs 16 · Tailwind CSS 4 · Motion · three.js / React Three Fiber · zod · Biome · bun. Several landing components are adapted from 21st.dev; each file credits its author.
Requirements: bun 1.4 or newer. This repo uses bun only (no npm, pnpm or yarn).
git clone https://github.com/pkuinfo/pkuharness-website
cd pkuharness-website
bun install
bun run dev # http://localhost:3000| Command | What it does |
|---|---|
bun run dev |
Development server |
bun run build / bun run start |
Production build and server |
bun run check |
Everything CI checks: Biome lint/format, types, unit tests |
bun run format |
Format with Biome |
bun run openapi |
Regenerate the Cloud API pages from openapi/cloud-v1.yaml |
bun run marketplace scan <owner/repo> |
Scan a GitHub repo for plugins, as the submit page does |
Tip
next dev can use several GB of RAM on machines with many cores. If memory is tight, cap it, e.g.
systemd-run --user --scope -p MemoryMax=4G bun run dev.
Optional environment variables (.env.local):
| Variable | Use |
|---|---|
NEXT_PUBLIC_SITE_URL |
Canonical URL for OG images, llms.txt and schema ids. Defaults to http://localhost:3000 |
GITHUB_TOKEN |
Raises GitHub API rate limits for releases and marketplace scans. Read-only; no scopes needed |
GITHUB_WEBHOOK_SECRET |
Secret of the release webhook on pkuinfo/pku-harness (/api/github-webhook). Refreshes the download page as soon as a release is published |
content/docs/ Documentation (MDX): page.mdx = Chinese, page.en.mdx = English
openapi/ OpenAPI 3.1 spec of the PKU harness Cloud wire protocol
data/sources.json Community repos indexed by the marketplace (edited by the submission bot)
scripts/marketplace.ts Marketplace CLI: scan, add, check (used by CI)
src/app/[lang]/ All pages, per language (zh at /, en at /en); llms*/ serve Markdown for agents
src/lib/messages/ UI strings for non-docs pages (en defines the shape, zh mirrors it)
src/components/ landing/, marketplace/, ui/ (adapted 21st.dev components), brand/
src/lib/marketplace/ Repo scanner, PLUGIN.md and JSON manifest schemas, index builder
deploy/ Production: Docker Compose, Caddy, deploy script (see deploy/README.md)
You don't need to edit this repo. Open pkuharness.com/marketplace/submit, paste your GitHub repo and follow the checks. See Publishing.
main is built into ghcr.io/pkuinfo/pkuharness-website by GitHub Actions and served by Docker behind
Caddy. Details, first-time setup and rollback are in deploy/README.md.
Contributions are welcome: docs fixes, new guides, translations, UI polish, marketplace features.
Read CONTRIBUTING.md first; good starting points are labelled
good first issue and
help wanted. By participating
you agree to the Code of Conduct. To report a vulnerability, see
SECURITY.md.
- Questions and ideas: GitHub Discussions
- Website, docs or marketplace problems: issues
- Where to ask what: SUPPORT.md
| Repo | |
|---|---|
| pkuinfo/pku-harness | The app (Expo / React Native, Android first) |
| pkuinfo/pku-harness-plugins | SDK, official plugins, marketplace registry |
| pkuinfo/pkucli | Reference implementations of PKU service protocols (Rust) |
MIT. PKU harness is a student community project and is not an official product of Peking University. The name and emblem of Peking University belong to the university.
The little-swallow mark and PKU harness wordmark are generated from the app repository.
See the identity system.
Run bun scripts/render-brand.ts --sync-related in the sibling pku-harness checkout to refresh
public/brand, public/icon.png and src/app/icon.png. Do not redraw the mark here.