UniKnow Developers

Build plugins for UniKnow

Give UniMind new tools, build your own panels and run background jobs — all in TypeScript with the UniKnow Plugin SDK. Package it as a single .uniplugin; once it passes review it lands in the Plugin Store, and students install it in one click.

Start building Read the docs

TypeScript SDKSandboxedEvery version human-reviewed

src/main.tsdue-countUniMind

1import { definePlugin, type PluginCommand } from '@uniflow/plugin-sdk'2 3const countDue: PluginCommand<{ days?: number }> = {4  action: 'count_due',5  description: 'Count assignments due in the next N days.',6  parameters: {7    type: 'object',8    properties: { days: { type: 'integer' } },9  },10  async run(args, ctx) {11    const list = await ctx.assignments!.list()12    const until = ctx.now().getTime() + (args.days ?? 7) * 86_400_00013    const due = list.filter((a) => Date.parse(a.dueDate) <= until)14    return { count: due.length }15  },16}17 18export default definePlugin({ commands: [countDue] })

New chat

All courses

Ask any question

Three things a plugin can do

The commands you declare go straight into UniMind's tool list. Read-only commands run directly; anything that changes data shows a confirmation card first, runs only after the student confirms, and can be undone.
A UI that opens as a tab — React or plain TypeScript. Same design tokens and Tailwind preset as the app, with light and dark mode for free.
Declare a background command and the app runs it on a schedule (every 30 minutes or longer) while your plugin is enabled — for example, refreshing a calendar feed every 6 hours.

How plugin commands work

Over-the-shoulder view of a student at a desk by the window at blue hour, laptop glowing

From idea to Store

One command to scaffold, hot reload on every save, pack and submit from the console.

Three steps

1 / 3

Scaffold

The generator sets up plugin.json, commands, a panel, English and Chinese strings, and tests. Pick plain TypeScript or React + Tailwind.

$ npx uniflow-plugin init my-timer$ cd my-timer && npm install

2 / 3

Build live

Every save rebuilds. In UniKnow, open Plugins › Developer › Load plugin in development and pick dist/ — edits hot-reload and your commands show up in UniMind right away.

$ npm run dev # rebuilds on save$ npm test

3 / 3

Pack & submit

Upload the package in the Developer Console, fill in your store page and banner, and submit for review. Once approved it goes live for every user under Plugins in the sidebar.

$ npm run pack# → my-timer-1.0.0.uniplugin

10-minute quickstart Publishing & asset specs

The SDK is coming to npm soon. Until then, the quickstart shows how to run the same commands from a local copy of the SDK.

Safe by default

Everything a plugin touches goes through the app, and students always know what it can do.

Sandboxed

Your code runs in an isolated-origin iframe and Web Worker. CSP blocks all network requests and external resources — the only way out is ctx.

Least privilege

Declare only the permissions you need from 12. Anything you didn't declare simply doesn't exist on ctx, and the install dialog explains each one in plain words, color-coded by risk.

Students stay in control

Every write that the model starts needs a tap on a confirmation card that honestly describes what will happen — and every step can be undone.

Human review

The UniKnow team reviews every version before it ships: new permissions, the command descriptions UniMind sees, and whether confirmation cards tell the truth.

How every version ships

From submission to the update landing on students' machines, every step is on record.

Security model & review guidelines

1Submit .uniplugin
2Automated checks (same rules as install)
3Human review
4Listed in the Store
5One-click update for users

Learn from the official plugins

Flashcards, Exam Planner and Calendar sync are standard SDK projects with the same layout init gives you. The guide walks through how each one is built.

Official plugins guide