Shoko
@magistr/shokov2026.05.25.1
01README
Shoko anime metadata server API — series, episodes, files, and metadata.
Model:
@magistr/shoko— wraps the Shoko Server REST v3 API. Authenticate for a long-lived API key, then read server status, dashboard stats, series, episodes, files, import folders, and queue state, and trigger maintenance actions (run import, rescan a folder, remove missing files, discover available actions from the live OpenAPI spec).
The API key is marked sensitive so it is stored via the vault rather than persisted in cleartext, and the status/action-discovery endpoints work without authentication.
02Release Notes
Merge pull request #5 from umag/extensions/jscad-stl-pair
extensions: add 15 more @magistr extensions + auto-discover CI
03Models
@magistr/shokov2026.05.25.1shoko.ts
fn authenticate(user: string, pass: string, device: string)
Exchange username/password for a long-lived apikey. Stash the returned key in your vault and put it in the model's globalArgs.apiKey afterward.
| Argument | Type | Description |
|---|---|---|
| user | string | |
| pass | string | |
| device | string |
fn status()
Get server init status (no auth required)
fn dashboard()
Fetch dashboard stats (series count, file size on disk, queue health, etc.)
Resources
status(infinite)— Server init status (does not require auth)
dashboard(infinite)— Dashboard stats (series count, missing episodes, etc.)
series(infinite)— Series listing or single series detail
files(infinite)— File listing (recognized, unrecognized, manually-linked, etc.)
episodes(infinite)— Episode listing (e.g., missing episodes per release management)
queue(infinite)— Queue overview (general, hasher, image, AniDB)
importFolders(infinite)— Configured import folders
actions(infinite)— Available action endpoints (Action/* in API)
task(infinite)— Result of a triggered action
auth(infinite)— Result of authenticate (apikey is sensitive — store in vault)
04Stats
A
100 / 100
Downloads
1
Archive size
10.5 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
Repository
https://github.com/umag/swamp-workspace05Platforms
06Labels