scriptcat-userscript
Installation
SKILL.md
Writing ScriptCat userscripts
ScriptCat runs Tampermonkey-style userscripts and adds two kinds of its own: background scripts and scheduled scripts, which run in the extension's background sandbox instead of a web page. Most Tampermonkey knowledge carries over; the differences below are the ones that break scripts.
Authority. The API surface is scriptcat.d.ts — in this repository src/types/scriptcat.d.ts, otherwise
https://raw.githubusercontent.com/scriptscat/scriptcat/main/src/types/scriptcat.d.ts. Working examples live in
https://github.com/scriptscat/scriptcat/tree/main/example. The developer docs at https://docs.scriptcat.org/docs/dev/
can lag behind the types; when they disagree, trust the types.
1. Pick the script type
| The script must… | Type | Key metadata |
|---|---|---|
| Change, read or automate a web page | Page script | @match / @include, @run-at |
| Keep running while the browser is open, with no page (listeners, polling, a menu in the popup) | Background script | @background |
| Run on a schedule (check-in, sync, report, periodic fetch) | Scheduled script | @crontab <expr> |