@muhammedaksam/easiarr 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Muhammed Mustafa AKŞAM
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,173 @@
+# easiarr
+
+> **It could be easiarr.**
+
+[![npm version](https://img.shields.io/npm/v/@muhammedaksam/easiarr.svg)](https://www.npmjs.com/package/@muhammedaksam/easiarr)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
+[![Bun](https://img.shields.io/badge/Bun-000?logo=bun&logoColor=fff)](https://bun.sh/)
+[![CI](https://github.com/muhammedaksam/easiarr/workflows/CI/badge.svg)](https://github.com/muhammedaksam/easiarr/actions)
+
+> ⚠️ **Work In Progress** - This project is in early experimental development. Features may be incomplete, unstable, or change without notice.
+
+TUI tool for generating docker-compose files for the \*arr media ecosystem with 41 apps, TRaSH Guides best practices, VPN routing, and Traefik reverse proxy support.
+
+A terminal-based wizard that helps you set up Radarr, Sonarr, Prowlarr, and other \*arr applications with Docker Compose, following best practices from [TRaSH Guides](https://trash-guides.info/).
+
+## Features
+
+- 📦 **Quick Setup Wizard** - Get started in minutes with a guided setup flow
+- 🐳 **Docker Compose Generation** - Automatically generates optimized `docker-compose.yml`
+- ✅ **TRaSH Guides Compliant** - Follows best practices for folder structure and hardlinks
+- 🎮 **Container Control** - Start, stop, and restart containers directly from the TUI
+- ⚙️ **App Management** - Add or remove apps from your stack with ease
+- 💾 **Persistent Configuration** - Settings saved to `~/.easiarr/config.json`
+
+## Quick Start
+
+### Run directly with bunx (no installation required)
+
+```bash
+bunx @muhammedaksam/easiarr
+```
+
+### Or install globally
+
+```bash
+bun add -g @muhammedaksam/easiarr
+easiarr
+```
+
+### Or clone and run locally
+
+```bash
+git clone https://github.com/muhammedaksam/easiarr.git
+cd easiarr
+bun install
+bun run start
+```
+
+## Requirements
+
+- [Bun](https://bun.sh/) >= 1.0
+- [Docker](https://www.docker.com/) with Docker Compose v2
+
+## Supported Applications (41 apps across 10 categories)
+
+### Media Management (Servarr)
+
+- **Radarr** - Movie collection manager
+- **Sonarr** - TV series collection manager
+- **Lidarr** - Music collection manager
+- **Readarr** - Book collection manager
+- **Bazarr** - Subtitle manager for Sonarr/Radarr
+- **Mylar3** - Comic book collection manager
+- **Whisparr** - Adult media collection manager
+- **Audiobookshelf** - Audiobook and podcast server
+
+### Indexers
+
+- **Prowlarr** - Indexer manager for \*arr apps
+- **Jackett** - Alternative indexer manager
+- **FlareSolverr** - Cloudflare bypass proxy
+
+### Download Clients
+
+- **qBittorrent** - BitTorrent client
+- **SABnzbd** - Usenet downloader
+
+### Media Servers
+
+- **Plex** - Media server with streaming
+- **Jellyfin** - Free open-source media server
+- **Tautulli** - Plex monitoring and statistics
+- **Tdarr** - Audio/video transcoding automation
+
+### Request Management
+
+- **Overseerr** - Request management for Plex
+- **Jellyseerr** - Request management for Jellyfin
+
+### Dashboards
+
+- **Homarr** - Modern dashboard for all services
+- **Heimdall** - Application dashboard and launcher
+- **Homepage** - Highly customizable application dashboard
+
+### Utilities
+
+- **Portainer** - Docker container management UI
+- **Huntarr** - Missing content manager for \*arr apps
+- **Unpackerr** - Archive extraction for \*arr apps
+- **FileBot** - Media file renaming and automator
+- **Chromium** - Web browser for secure remote browsing
+- **Guacamole** - Clientless remote desktop gateway
+- **DDNS-Updater** - Dynamic DNS record updater
+
+### VPN
+
+- **Gluetun** - VPN client container for routing traffic
+
+### Monitoring
+
+- **Grafana** - Visual monitoring dashboard
+- **Prometheus** - Systems and service monitoring
+- **Dozzle** - Real-time log viewer for Docker containers
+- **Uptime Kuma** - Self-hosted monitoring tool
+
+### Infrastructure
+
+- **Traefik** - Reverse proxy and load balancer
+- **Traefik Certs Dumper** - Extracts certificates from Traefik
+- **CrowdSec** - Intrusion prevention system
+- **Headscale** - Open-source Tailscale control server
+- **Headplane** - Headscale web UI
+- **Tailscale** - VPN mesh network client
+- **Authentik** - Identity provider and SSO
+- **PostgreSQL** - Database server
+- **Valkey** - Redis-compatible key-value store
+
+## Configuration
+
+easiarr stores its configuration in `~/.easiarr/`:
+
+```bash
+~/.easiarr/
+├── config.json          # Your easiarr configuration
+├── docker-compose.yml   # Generated Docker Compose file
+└── backups/             # Configuration backups
+```
+
+## Development
+
+```bash
+# Install dependencies
+bun install
+
+# Run in development mode (with watch)
+bun run dev
+
+# Type check
+bun run typecheck
+
+# Lint
+bun run lint
+
+# Format
+bun run format
+
+# Run all checks (typecheck + lint + format:check)
+bun run check
+
+# Fix all issues (lint:fix + format)
+bun run fix
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Related Projects
+
+- [TRaSH Guides](https://trash-guides.info/) - Quality guides for Radarr, Sonarr, and more
+- [OpenTUI](https://github.com/opentui/opentui) - Terminal UI framework used by easiarr

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@muhammedaksam/easiarr",
+  "version": "0.1.0",
+  "description": "TUI tool for generating docker-compose files for the *arr media ecosystem with 41 apps, TRaSH Guides best practices, VPN routing, and Traefik reverse proxy support",
+  "module": "src/index.ts",
+  "type": "module",
+  "bin": {
+    "easiarr": "./src/index.ts"
+  },
+  "files": [
+    "src"
+  ],
+  "author": "Muhammed Mustafa AKŞAM <info@muhammedaksam.com.tr> (https://github.com/muhammedaksam)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/muhammedaksam/easiarr.git"
+  },
+  "bugs": {
+    "url": "https://github.com/muhammedaksam/easiarr/issues"
+  },
+  "homepage": "https://github.com/muhammedaksam/easiarr#readme",
+  "keywords": [
+    "arr",
+    "radarr",
+    "sonarr",
+    "prowlarr",
+    "docker",
+    "docker-compose",
+    "trash-guides",
+    "tui",
+    "opentui",
+    "cli",
+    "media-server"
+  ],
+  "scripts": {
+    "dev": "bun run --watch src/index.ts",
+    "build": "bun build src/index.ts --outdir dist --target bun",
+    "typecheck": "bun x tsc --noEmit",
+    "lint": "eslint src/",
+    "lint:fix": "eslint src/ --fix",
+    "format": "prettier --write src/",
+    "format:check": "prettier --check src/",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "check": "bun run typecheck && bun run lint && bun run format:check && bun run test",
+    "fix": "bun run lint:fix && bun run format",
+    "start": "bun run src/index.ts"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "@types/bun": "latest",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25.0.0",
+    "eslint": "^9.39.1",
+    "jest": "^30.2.0",
+    "jiti": "^2.6.1",
+    "prettier": "^3.7.4",
+    "ts-jest": "^29.4.6",
+    "typescript-eslint": "^8.49.0",
+    "yaml": "^2.8.2"
+  },
+  "peerDependencies": {
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@opentui/core": "^0.1.60"
+  },
+  "engines": {
+    "bun": ">=1.0"
+  }
+}

package/src/VersionInfo.ts

@@ -0,0 +1,12 @@
+import packageJson from "../package.json" with { type: "json" }
+
+const pkg = packageJson
+
+export const VersionInfo = {
+  version: pkg.version,
+  name: pkg.name,
+  description: pkg.description,
+  author: pkg.author,
+}
+
+export const getVersion = () => `v${VersionInfo.version}`

package/src/api/arr-api.ts

@@ -0,0 +1,198 @@
+/**
+ * *arr API Client
+ * Interacts with Radarr, Sonarr, Lidarr, Readarr, Whisparr APIs
+ */
+
+// Types for Root Folder API
+export interface RootFolder {
+  id?: number
+  path: string
+  accessible?: boolean
+  freeSpace?: number | null
+  unmappedFolders?: { name: string | null; path: string | null; relativePath: string | null }[]
+}
+
+// Types for Download Client API
+export interface DownloadClientConfig {
+  name: string
+  implementation: string
+  configContract: string
+  enable?: boolean
+  priority?: number
+  fields: { name: string; value: unknown }[]
+}
+
+export interface DownloadClient extends DownloadClientConfig {
+  id?: number
+}
+
+import type { AppId } from "../config/schema"
+
+// Get category name for an app
+function getCategoryForApp(appId: AppId): string {
+  switch (appId) {
+    case "radarr":
+      return "movies"
+    case "sonarr":
+      return "tv"
+    case "lidarr":
+      return "music"
+    case "readarr":
+      return "books"
+    case "whisparr":
+      return "adult"
+    default:
+      return "default"
+  }
+}
+
+// Get category field name for an app (different apps use different field names)
+function getCategoryFieldName(appId: AppId): string {
+  switch (appId) {
+    case "radarr":
+    case "whisparr":
+      return "movieCategory"
+    case "sonarr":
+      return "tvCategory"
+    case "lidarr":
+      return "musicCategory"
+    case "readarr":
+      return "bookCategory"
+    default:
+      return "category"
+  }
+}
+
+// qBittorrent download client config
+export function createQBittorrentConfig(
+  host: string,
+  port: number,
+  username: string,
+  password: string,
+  appId?: AppId
+): DownloadClientConfig {
+  const category = appId ? getCategoryForApp(appId) : "default"
+  const categoryField = appId ? getCategoryFieldName(appId) : "category"
+
+  return {
+    name: "qBittorrent",
+    implementation: "QBittorrent",
+    configContract: "QBittorrentSettings",
+    enable: true,
+    priority: 1,
+    fields: [
+      { name: "host", value: host },
+      { name: "port", value: port },
+      { name: "username", value: username },
+      { name: "password", value: password },
+      { name: categoryField, value: category },
+      { name: "recentMoviePriority", value: 0 },
+      { name: "olderMoviePriority", value: 0 },
+      { name: "initialState", value: 0 },
+      { name: "sequentialOrder", value: false },
+      { name: "firstAndLast", value: false },
+    ],
+  }
+}
+
+// SABnzbd download client config
+export function createSABnzbdConfig(host: string, port: number, apiKey: string, appId?: AppId): DownloadClientConfig {
+  const category = appId ? getCategoryForApp(appId) : "default"
+  const categoryField = appId ? getCategoryFieldName(appId) : "category"
+
+  return {
+    name: "SABnzbd",
+    implementation: "Sabnzbd",
+    configContract: "SabnzbdSettings",
+    enable: true,
+    priority: 1,
+    fields: [
+      { name: "host", value: host },
+      { name: "port", value: port },
+      { name: "apiKey", value: apiKey },
+      { name: categoryField, value: category },
+      { name: "recentMoviePriority", value: -100 },
+      { name: "olderMoviePriority", value: -100 },
+    ],
+  }
+}
+
+export type ApiVersion = "v1" | "v3"
+
+/**
+ * *arr API Client
+ */
+export class ArrApiClient {
+  private baseUrl: string
+  private apiKey: string
+  private apiVersion: ApiVersion
+
+  constructor(host: string, port: number, apiKey: string, apiVersion: ApiVersion = "v3") {
+    this.baseUrl = `http://${host}:${port}`
+    this.apiKey = apiKey
+    this.apiVersion = apiVersion
+  }
+
+  private async request<T>(endpoint: string, options: RequestInit = {}): Promise<T> {
+    const url = `${this.baseUrl}/api/${this.apiVersion}${endpoint}`
+    const headers = {
+      "X-Api-Key": this.apiKey,
+      "Content-Type": "application/json",
+      ...options.headers,
+    }
+
+    const response = await fetch(url, { ...options, headers })
+
+    if (!response.ok) {
+      throw new Error(`API request failed: ${response.status} ${response.statusText}`)
+    }
+
+    // Handle empty responses (DELETE returns empty body)
+    const text = await response.text()
+    if (!text) return {} as T
+
+    return JSON.parse(text) as T
+  }
+
+  // Root Folder methods
+  async getRootFolders(): Promise<RootFolder[]> {
+    return this.request<RootFolder[]>("/rootfolder")
+  }
+
+  async addRootFolder(path: string): Promise<RootFolder> {
+    return this.request<RootFolder>("/rootfolder", {
+      method: "POST",
+      body: JSON.stringify({ path }),
+    })
+  }
+
+  async deleteRootFolder(id: number): Promise<void> {
+    await this.request(`/rootfolder/${id}`, { method: "DELETE" })
+  }
+
+  // Download Client methods
+  async getDownloadClients(): Promise<DownloadClient[]> {
+    return this.request<DownloadClient[]>("/downloadclient")
+  }
+
+  async addDownloadClient(config: DownloadClientConfig): Promise<DownloadClient> {
+    return this.request<DownloadClient>("/downloadclient", {
+      method: "POST",
+      body: JSON.stringify(config),
+    })
+  }
+
+  async deleteDownloadClient(id: number): Promise<void> {
+    await this.request(`/downloadclient/${id}`, { method: "DELETE" })
+  }
+
+  // Health check
+  async isHealthy(): Promise<boolean> {
+    try {
+      await this.request("/system/status")
+      return true
+    } catch {
+      return false
+    }
+  }
+}

package/src/api/index.ts

@@ -0,0 +1 @@
+export * from "./arr-api"

package/src/apps/categories.ts

@@ -0,0 +1,14 @@
+import type { AppCategory } from "../config/schema"
+
+export const CATEGORY_ORDER: { id: AppCategory; short: string }[] = [
+  { id: "servarr", short: "Media" },
+  { id: "indexer", short: "Index" },
+  { id: "downloader", short: "DL" },
+  { id: "mediaserver", short: "Server" },
+  { id: "request", short: "Request" },
+  { id: "dashboard", short: "Dash" },
+  { id: "utility", short: "Utils" },
+  { id: "vpn", short: "VPN" },
+  { id: "monitoring", short: "Monitor" },
+  { id: "infrastructure", short: "Infra" },
+]

package/src/apps/index.ts

@@ -0,0 +1,2 @@
+export * from "./registry"
+export * from "./categories"