Shelfarr
@kitquiet/shelfarrv2026.07.23.3
01README
Download client, acquisition provider, and settings configuration for Shelfarr (audiobook/ebook acquisition tool), via a companion admin shim since Shelfarr itself has no admin API — only session-cookie/CSRF-protected HTML forms. API key resolved from a vault at execution time.
02Models
@kitquiet/shelfarrv2026.07.23.3shelfarr.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| baseUrl | string | Base URL of the shelfarr-admin-shim companion service (not Shelfarr |
| apiKey | string | The shim's own API key (its SHIM_API_KEY, not any Shelfarr/Prowlarr/ |
fn upsert_download_client(name: string, client_type: enum, url: string, api_key?: string, username?: string, password?: string, download_path?: string, category?: string, priority: number, enabled: boolean)
Create or update a Shelfarr download client (idempotent — matches by name)
| Argument | Type | Description |
|---|---|---|
| name | string | Display name for the download client |
| client_type | enum | |
| url | string | Base URL of the download client |
| api_key? | string | |
| username? | string | |
| password? | string | |
| download_path? | string | |
| category? | string | |
| priority | number | |
| enabled | boolean |
fn upsert_acquisition_provider(name: string, url: string, api_key?: string, allow_private_network: boolean, supports_audiobooks: boolean, supports_ebooks: boolean, supports_comicbooks: boolean, priority: number, enabled: boolean)
Create or update a Shelfarr acquisition provider (idempotent — matches by name)
| Argument | Type | Description |
|---|---|---|
| name | string | Display name for the acquisition provider |
| url | string | Base URL of the provider (e.g. Prowlarr) |
| api_key? | string | |
| allow_private_network | boolean | |
| supports_audiobooks | boolean | |
| supports_ebooks | boolean | |
| supports_comicbooks | boolean | |
| priority | number | |
| enabled | boolean |
fn update_settings(settings: record)
Update one or more Shelfarr settings by key
| Argument | Type | Description |
|---|---|---|
| settings | record | A map of setting key to string value, e.g. |
fn health_check()
Verify the shelfarr-admin-shim is reachable and the API key authenticates, without changing anything
Resources
download_client(infinite)— A configured Shelfarr download client
acquisition_provider(infinite)— A configured Shelfarr acquisition provider (indexer source)
settings_update(1h)— Result of a Shelfarr settings update
health_check(1h)— Result of a shelfarr-admin-shim health check
03Previous Versions
2026.07.23.2
2026.07.23.1
04Stats
A
100 / 100
Downloads
0
Archive size
7.2 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms