tsarr 1.12.0 → 2.1.0

package/README.md

@@ -7,31 +7,97 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
 [![CI](https://github.com/robbeverhelst/Tsarr/workflows/CI/badge.svg)](https://github.com/robbeverhelst/Tsarr/actions)
 
-**Type-safe TypeScript SDK for Servarr APIs (Radarr, Sonarr, etc.)**
+**Type-safe TypeScript SDK and CLI for Servarr APIs (Radarr, Sonarr, etc.)**
 
-Tsarr provides type-safe TypeScript clients for all Servarr APIs, generated from their Swagger/OpenAPI specifications. Perfect for building automation tools, scripts, and applications to manage your media servers.
+Tsarr provides type-safe TypeScript clients and a CLI for all Servarr APIs, generated from their Swagger/OpenAPI specifications. Use it as an SDK in your code or as a standalone CLI tool.
 
 ## Features
 
 - 🛡️ **Type-safe** - Generated from official Swagger/OpenAPI specs
 - ⚡ **Bun-optimized** - Leverages native fetch API
 - 📦 **Modular** - Separate clients for each Servarr app
+- 💻 **CLI included** - Manage all Servarr apps from the terminal
 
 ## Supported Servarr Apps
 
 - **Radarr** - Movie collection manager
-- **Sonarr** - TV series collection manager  
+- **Sonarr** - TV series collection manager
 - **Lidarr** - Music collection manager
 - **Readarr** - Book collection manager
 - **Prowlarr** - Indexer manager
+- **Bazarr** - Subtitle manager
 
 ## Installation
 
 ```bash
+# As a dependency (SDK)
 bun add tsarr
+
+# As a global CLI
+bun add -g tsarr
 ```
 
-## Quick Start
+## CLI
+
+### Setup
+
+```bash
+# Interactive setup wizard
+tsarr config init
+
+# Or configure manually
+tsarr config set services.radarr.baseUrl http://localhost:7878
+tsarr config set services.radarr.apiKey your-api-key
+
+# Or use environment variables
+export TSARR_RADARR_URL=http://localhost:7878
+export TSARR_RADARR_API_KEY=your-api-key
+```
+
+Config is stored in `~/.config/tsarr/config.json` (global) or `.tsarr.json` (local project). Environment variables take priority over config files.
+
+### Usage
+
+```bash
+tsarr <service> <resource> <action> [options]
+
+# Examples
+tsarr radarr movie list
+tsarr radarr movie search --term "Interstellar"
+tsarr sonarr series list
+tsarr prowlarr indexer list
+tsarr lidarr artist search --term "Radiohead"
+
+# Output formats
+tsarr radarr movie list --table    # Table (default in terminal)
+tsarr radarr movie list --json     # JSON (default when piped)
+tsarr radarr movie list --quiet    # IDs only
+
+# Diagnostics
+tsarr doctor                       # Test all configured connections
+
+# Shell completions
+tsarr completions bash >> ~/.bashrc
+tsarr completions zsh >> ~/.zshrc
+tsarr completions fish > ~/.config/fish/completions/tsarr.fish
+```
+
+### Available Commands
+
+| Service | Resources |
+|---------|-----------|
+| `radarr` | movie, profile, tag, queue, rootfolder, system, history, customformat |
+| `sonarr` | series, episode, profile, tag, rootfolder, system |
+| `lidarr` | artist, album, profile, tag, rootfolder, system |
+| `readarr` | author, book, profile, tag, rootfolder, system |
+| `prowlarr` | indexer, search, app, tag, system |
+| `bazarr` | series, movie, episode, provider, language, system |
+
+See the [CLI Guide](./docs/cli.md) for full documentation including all commands, scripting examples, and shell completions.
+
+## SDK
+
+### Quick Start
 
 ```typescript
 import { RadarrClient, SonarrClient, LidarrClient } from 'tsarr';
@@ -46,6 +112,15 @@ const movies = await radarr.getMovies();
 const status = await radarr.getSystemStatus();
 ```
 
+### Modular Imports
+
+```typescript
+// Import only what you need
+import { RadarrClient } from 'tsarr/radarr';
+import { SonarrClient } from 'tsarr/sonarr';
+import type { MovieResource } from 'tsarr/radarr/types';
+```
+
 ## Development
 
 Install dependencies:
@@ -75,8 +150,9 @@ bun run format
 
 ## 📖 Documentation
 
+- [CLI Guide](./docs/cli.md) - Complete CLI documentation with all commands and scripting examples
+- [SDK Usage Guide](./docs/usage.md) - SDK usage documentation with examples
 - [API Documentation](https://robbeverhelst.github.io/Tsarr/) - Auto-generated TypeScript API docs
-- [Usage Guide](./docs/usage.md) - Complete usage documentation with examples
 - [Examples](./docs/examples.md) - Real-world automation examples
 - [Examples Directory](./examples/) - Runnable example scripts
 
@@ -86,7 +162,7 @@ Perfect for building:
 - **Automation scripts** - Bulk movie imports, library maintenance, and media organization
 - **Management tools** - Custom dashboards, backup utilities, and monitoring scripts  
 - **Integration scripts** - Connect Servarr apps with other services and workflows
-- **CLI tools** - Command-line utilities for media server administration
+- **CLI usage** - Manage your media servers directly from the terminal
 
 ## Contributing
 

package/dist/cli/commands/bazarr.d.ts

@@ -0,0 +1,2 @@
+export declare const bazarr: import("citty").CommandDef<import("citty").ArgsDef>;
+//# sourceMappingURL=bazarr.d.ts.map

package/dist/cli/commands/bazarr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bazarr.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/bazarr.ts"],"names":[],"mappings":"AA6FA,eAAO,MAAM,MAAM,qDAKlB,CAAC"}

package/dist/cli/commands/config.d.ts

@@ -0,0 +1,2 @@
+export declare const config: import("citty").CommandDef<import("citty").ArgsDef>;
+//# sourceMappingURL=config.d.ts.map

package/dist/cli/commands/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/config.ts"],"names":[],"mappings":"AAmKA,eAAO,MAAM,MAAM,qDAWjB,CAAC"}

package/dist/cli/commands/doctor.d.ts

@@ -0,0 +1,16 @@
+export declare const doctor: import("citty").CommandDef<{
+    readonly json: {
+        readonly type: "boolean";
+        readonly description: "Output as JSON";
+    };
+    readonly table: {
+        readonly type: "boolean";
+        readonly description: "Output as table";
+    };
+    readonly quiet: {
+        readonly type: "boolean";
+        readonly alias: "q";
+        readonly description: "Output service names only";
+    };
+}>;
+//# sourceMappingURL=doctor.d.ts.map

package/dist/cli/commands/doctor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doctor.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/doctor.ts"],"names":[],"mappings":"AAyCA,eAAO,MAAM,MAAM;;;;;;;;;;;;;;EA2EjB,CAAC"}

package/dist/cli/commands/lidarr.d.ts

@@ -0,0 +1,2 @@
+export declare const lidarr: import("citty").CommandDef<import("citty").ArgsDef>;
+//# sourceMappingURL=lidarr.d.ts.map

package/dist/cli/commands/lidarr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lidarr.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/lidarr.ts"],"names":[],"mappings":"AAqHA,eAAO,MAAM,MAAM,qDAKlB,CAAC"}

package/dist/cli/commands/prowlarr.d.ts

@@ -0,0 +1,2 @@
+export declare const prowlarr: import("citty").CommandDef<import("citty").ArgsDef>;
+//# sourceMappingURL=prowlarr.d.ts.map

package/dist/cli/commands/prowlarr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prowlarr.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/prowlarr.ts"],"names":[],"mappings":"AA4FA,eAAO,MAAM,QAAQ,qDAKpB,CAAC"}

package/dist/cli/commands/radarr.d.ts

@@ -0,0 +1,2 @@
+export declare const radarr: import("citty").CommandDef<import("citty").ArgsDef>;
+//# sourceMappingURL=radarr.d.ts.map

package/dist/cli/commands/radarr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"radarr.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/radarr.ts"],"names":[],"mappings":"AA4IA,eAAO,MAAM,MAAM,qDAKlB,CAAC"}

package/dist/cli/commands/readarr.d.ts

@@ -0,0 +1,2 @@
+export declare const readarr: import("citty").CommandDef<import("citty").ArgsDef>;
+//# sourceMappingURL=readarr.d.ts.map

package/dist/cli/commands/readarr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readarr.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/readarr.ts"],"names":[],"mappings":"AAqHA,eAAO,MAAM,OAAO,qDAKnB,CAAC"}

package/dist/cli/commands/service.d.ts

@@ -0,0 +1,23 @@
+import type { ServarrClientConfig } from '../../core/types.js';
+export interface ActionArg {
+    name: string;
+    description: string;
+    required?: boolean;
+    type?: 'string' | 'number';
+}
+export interface ActionDef {
+    name: string;
+    description: string;
+    args?: ActionArg[];
+    columns?: string[];
+    idField?: string;
+    confirmMessage?: string;
+    run: (client: any, args: Record<string, any>) => Promise<any>;
+}
+export interface ResourceDef {
+    name: string;
+    description: string;
+    actions: ActionDef[];
+}
+export declare function buildServiceCommand(serviceName: string, description: string, clientFactory: (config: ServarrClientConfig) => any, resources: ResourceDef[]): import("citty").CommandDef<import("citty").ArgsDef>;
+//# sourceMappingURL=service.d.ts.map

package/dist/cli/commands/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/service.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAK/D,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAC5B;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,GAAG,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,SAAS,EAAE,CAAC;CACtB;AAED,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,GAAG,EACnD,SAAS,EAAE,WAAW,EAAE,uDAgIzB"}

package/dist/cli/commands/sonarr.d.ts

@@ -0,0 +1,2 @@
+export declare const sonarr: import("citty").CommandDef<import("citty").ArgsDef>;
+//# sourceMappingURL=sonarr.d.ts.map

package/dist/cli/commands/sonarr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sonarr.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/sonarr.ts"],"names":[],"mappings":"AA8GA,eAAO,MAAM,MAAM,qDAKlB,CAAC"}

package/dist/cli/completions.d.ts

@@ -0,0 +1,8 @@
+export declare const completions: import("citty").CommandDef<{
+    readonly shell: {
+        readonly type: "positional";
+        readonly description: "Shell type (bash, zsh, fish)";
+        readonly required: true;
+    };
+}>;
+//# sourceMappingURL=completions.d.ts.map

package/dist/cli/completions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"completions.d.ts","sourceRoot":"","sources":["../../src/cli/completions.ts"],"names":[],"mappings":"AA4NA,eAAO,MAAM,WAAW;;;;;;EA4BtB,CAAC"}

package/dist/cli/config.d.ts

@@ -0,0 +1,26 @@
+import type { ServarrClientConfig } from '../core/types.js';
+export interface ServiceConfig {
+    baseUrl: string;
+    apiKey: string;
+    apiKeyFile?: string;
+    timeout?: number;
+}
+export interface TsarrCliConfig {
+    services: Record<string, ServiceConfig>;
+    defaults?: {
+        output?: 'json' | 'table' | 'quiet';
+    };
+}
+declare const SERVICES: readonly ["radarr", "sonarr", "lidarr", "readarr", "prowlarr", "bazarr"];
+declare const GLOBAL_CONFIG_PATH: string;
+declare const LOCAL_CONFIG_NAME = ".tsarr.json";
+export declare function loadConfig(): TsarrCliConfig;
+export declare function getServiceConfig(serviceName: string): ServarrClientConfig | null;
+export declare function saveGlobalConfig(config: TsarrCliConfig): void;
+export declare function saveLocalConfig(config: TsarrCliConfig): void;
+export declare function getConfigValue(key: string): string | undefined;
+export declare function setConfigValue(key: string, value: string, global?: boolean): void;
+export declare function getConfiguredServices(): string[];
+export declare function loadScopedConfig(scope: 'global' | 'local'): Partial<TsarrCliConfig>;
+export { SERVICES, GLOBAL_CONFIG_PATH, LOCAL_CONFIG_NAME };
+//# sourceMappingURL=config.d.ts.map

package/dist/cli/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/cli/config.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAE5D,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACxC,QAAQ,CAAC,EAAE;QACT,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;KACrC,CAAC;CACH;AAED,QAAA,MAAM,QAAQ,0EAA2E,CAAC;AAE1F,QAAA,MAAM,kBAAkB,QAAyC,CAAC;AAClE,QAAA,MAAM,iBAAiB,gBAAgB,CAAC;AAsExC,wBAAgB,UAAU,IAAI,cAAc,CA+B3C;AA0CD,wBAAgB,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,mBAAmB,GAAG,IAAI,CAsBhF;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAG7D;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAI5D;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAS9D;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,UAAO,GAAG,IAAI,CAoB9E;AAcD,wBAAgB,qBAAqB,IAAI,MAAM,EAAE,CAKhD;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAMnF;AAED,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/cli/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env bun
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/cli/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":""}