From 15a929d2ef16f5135f19ddcd590c0a84b5dff126 Mon Sep 17 00:00:00 2001 From: soulis-1256 Date: Wed, 5 Aug 2026 14:05:14 +0300 Subject: [PATCH] Use lowercase assemblrr as the product name Rename display branding and prose from Assemblrr to assemblrr for a consistent identity across docs, CLI messages, and source comments. --- README.md | 4 ++-- bin/cli.sh | 2 +- bin/configure.sh | 2 +- bin/docker-install.sh | 2 +- bin/setup.sh | 2 +- branding.conf | 2 +- docs/api-reference.md | 4 ++-- docs/uninstall.md | 2 +- lib/api.sh | 2 +- lib/arr.sh | 2 +- lib/branding.sh | 4 ++-- lib/compose.sh | 2 +- lib/core.sh | 2 +- lib/jellyfin.sh | 2 +- lib/prompts.sh | 2 +- lib/seerr.sh | 2 +- lib/vpn.sh | 2 +- platform/linux/bootstrap.sh | 2 +- platform/windows/bootstrap-dev.ps1 | 4 ++-- platform/windows/bootstrap.ps1 | 2 +- 20 files changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 2b12a0d..761b12a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ > [!NOTE] > **Developer’s note — vision & roadmap** -> Assemblrr is infrastructure for self-hosted media *automation* (install, wire services, operate the stack). It does **not** provide media, indexers, or content. What you request, download, and host is entirely your responsibility and must comply with the laws that apply to you. +> assemblrr is infrastructure for self-hosted media *automation* (install, wire services, operate the stack). It does **not** provide media, indexers, or content. What you request, download, and host is entirely your responsibility and must comply with the laws that apply to you. > > Future directions and ideas shall be discussed with the community **[here](https://github.com/soulis-1256/assemblrr/discussions/1)** @@ -129,7 +129,7 @@ Live integration mutates a running stack — requires `ASSEMBLRR_ALLOW_LIVE_TEST ## Acknowledgments -Originally inspired by [YAMS](https://yams.media/) ([rogsme/yams](https://github.com/rogsme/yams)); Assemblrr has since been rewritten and expanded into its own project. +Originally inspired by [YAMS](https://yams.media/) ([rogsme/yams](https://github.com/rogsme/yams)); assemblrr has since been rewritten and expanded into its own project. ### License GNU General Public License v3.0 diff --git a/bin/cli.sh b/bin/cli.sh index 0825864..bdec4e0 100644 --- a/bin/cli.sh +++ b/bin/cli.sh @@ -1,7 +1,7 @@ #!/bin/bash set -euo pipefail -# Assemblrr CLI — manages your media server +# assemblrr CLI — manages your media server # This file is installed to ~/.local/bin/ during setup # Source shared library (safe_source, find_install_directory, logging, colors) diff --git a/bin/configure.sh b/bin/configure.sh index 44fbcaa..c51f783 100644 --- a/bin/configure.sh +++ b/bin/configure.sh @@ -1,7 +1,7 @@ #!/bin/bash set -euo pipefail -# Assemblrr Service Auto-Configuration +# assemblrr Service Auto-Configuration # Configures Radarr, Prowlarr, and related services after initial deployment # Called by setup.sh after containers start, or via: assemblrr configure # Uses jq for JSON parsing diff --git a/bin/docker-install.sh b/bin/docker-install.sh index e118f1f..9e05fde 100644 --- a/bin/docker-install.sh +++ b/bin/docker-install.sh @@ -22,7 +22,7 @@ else log_success() { echo -e "\033[0;32m$1\033[0m"; } load_branding() { APP_NAME="assemblrr" - APP_DISPLAY_NAME="Assemblrr" + APP_DISPLAY_NAME="assemblrr" APP_CLI_NAME="assemblrr" } fi diff --git a/bin/setup.sh b/bin/setup.sh index 2d35bdf..5e31efa 100644 --- a/bin/setup.sh +++ b/bin/setup.sh @@ -11,7 +11,7 @@ if [ -f "$SCRIPT_DIR/../lib/core.sh" ]; then elif [ -f "$SCRIPT_DIR/lib/core.sh" ]; then APP_ROOT="$SCRIPT_DIR" else - echo -e "\033[0;31mError: lib/core.sh not found. Re-run setup from a complete Assemblrr tree.\033[0m" >&2 + echo -e "\033[0;31mError: lib/core.sh not found. Re-run setup from a complete assemblrr tree.\033[0m" >&2 exit 1 fi diff --git a/branding.conf b/branding.conf index cfdeb07..d365ac3 100644 --- a/branding.conf +++ b/branding.conf @@ -2,7 +2,7 @@ # Change these values to rebrand the entire project APP_NAME="assemblrr" -APP_DISPLAY_NAME="Assemblrr" +APP_DISPLAY_NAME="assemblrr" APP_DESCRIPTION="Your one-click media server" APP_CLI_NAME="assemblrr" APP_NETWORK_NAME="assemblrr_network" diff --git a/docs/api-reference.md b/docs/api-reference.md index 84cf64b..a5b44e5 100644 --- a/docs/api-reference.md +++ b/docs/api-reference.md @@ -1,6 +1,6 @@ -# Assemblrr API Reference +# assemblrr API Reference -This document aggregates the official API documentation for all services used by Assemblrr. +This document aggregates the official API documentation for all services used by assemblrr. ## Media Services diff --git a/docs/uninstall.md b/docs/uninstall.md index 93c7d4f..825dda0 100644 --- a/docs/uninstall.md +++ b/docs/uninstall.md @@ -1,6 +1,6 @@ # Uninstall & Complete Removal -Assemblrr installs entirely into your home directory by default, uses no system +assemblrr installs entirely into your home directory by default, uses no system packages, and needs no sudo to remove. Everything it creates is listed below, so you can always verify what belongs to it — and remove it completely, by hand, even if the installation itself is broken. diff --git a/lib/api.sh b/lib/api.sh index 41279d5..f38d3ad 100644 --- a/lib/api.sh +++ b/lib/api.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Assemblrr API helpers — sourced by configure.sh +# assemblrr API helpers — sourced by configure.sh # Provides: jq helpers, API request wrappers, API key discovery, wait_for_api # Requires: lib/core.sh already sourced (for logging), API_HOST and INSTALL_DIR set diff --git a/lib/arr.sh b/lib/arr.sh index 004a3fd..35e9ba2 100644 --- a/lib/arr.sh +++ b/lib/arr.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Assemblrr *arr service configuration — sourced by configure.sh +# assemblrr *arr service configuration — sourced by configure.sh # Provides: set_arr_auth, qbit helpers, configure_arr_service, profile lookups, # configure_radarr, configure_sonarr, configure_prowlarr # Requires: lib/core.sh (logging), lib/api.sh (api_get/post/put/delete helpers), diff --git a/lib/branding.sh b/lib/branding.sh index 0c892a6..ce24d06 100644 --- a/lib/branding.sh +++ b/lib/branding.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Assemblrr branding loader — sourced by entry points that need branding +# assemblrr branding loader — sourced by entry points that need branding # Requires: lib/core.sh (for safe_source) if [ -n "${_ASSEMBLRR_BRANDING_SOURCED:-}" ]; then @@ -15,7 +15,7 @@ load_branding() { safe_source "$_branding_dir/branding.conf" else APP_NAME="assemblrr" - APP_DISPLAY_NAME="Assemblrr" + APP_DISPLAY_NAME="assemblrr" APP_CLI_NAME="assemblrr" APP_NETWORK_NAME="assemblrr_network" APP_BACKUP_PREFIX="assemblrr-backup" diff --git a/lib/compose.sh b/lib/compose.sh index 78ceb3c..5cd6d7a 100644 --- a/lib/compose.sh +++ b/lib/compose.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Assemblrr Docker Compose builder — sourced by entry points that manage containers +# assemblrr Docker Compose builder — sourced by entry points that manage containers # Requires: nothing beyond bash builtins if [ -n "${_ASSEMBLRR_COMPOSE_SOURCED:-}" ]; then diff --git a/lib/core.sh b/lib/core.sh index 371d4d7..d0f8650 100644 --- a/lib/core.sh +++ b/lib/core.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Assemblrr core library — sourced by all other lib modules and entry points +# assemblrr core library — sourced by all other lib modules and entry points # Provides: color codes, logging, safe_source, find_install_directory, # path utilities, directory helpers, dot_inline diff --git a/lib/jellyfin.sh b/lib/jellyfin.sh index 84d4dbe..1002edf 100644 --- a/lib/jellyfin.sh +++ b/lib/jellyfin.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Assemblrr Jellyfin configuration — sourced by configure.sh +# assemblrr Jellyfin configuration — sourced by configure.sh # Provides: configure_jellyfin, configure_jellyfin_xml_fallback, # configure_jellyfin_libraries, configure_jellyfin_notifications # Requires: lib/core.sh (logging), lib/api.sh (api_get/post helpers), diff --git a/lib/prompts.sh b/lib/prompts.sh index 4a8870e..ff43541 100644 --- a/lib/prompts.sh +++ b/lib/prompts.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Assemblrr setup prompts — sourced by setup.sh +# assemblrr setup prompts — sourced by setup.sh # Provides: interactive prompt functions for service configuration # Requires: lib/core.sh (logging, read_masked, expand_path, directory helpers), # SETUP_MODE, SUPPORTED_MEDIA_SERVICES, APP_DEFAULT_INSTALL_DIR, diff --git a/lib/seerr.sh b/lib/seerr.sh index aa71f8a..e90c77e 100644 --- a/lib/seerr.sh +++ b/lib/seerr.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Assemblrr Seerr & Recyclarr configuration — sourced by configure.sh +# assemblrr Seerr & Recyclarr configuration — sourced by configure.sh # Provides: configure_seerr, configure_recyclarr # Requires: lib/core.sh (logging), lib/api.sh (api_get/post helpers), # lib/arr.sh (lookup_radarr_profile, lookup_sonarr_profile), diff --git a/lib/vpn.sh b/lib/vpn.sh index 566be44..9c82a3b 100644 --- a/lib/vpn.sh +++ b/lib/vpn.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Assemblrr VPN helpers — sourced by entry points that handle VPN orchestration +# assemblrr VPN helpers — sourced by entry points that handle VPN orchestration # Requires: lib/core.sh (for logging, safe_source) # Guard against double-sourcing diff --git a/platform/linux/bootstrap.sh b/platform/linux/bootstrap.sh index bdbdfd3..902e833 100644 --- a/platform/linux/bootstrap.sh +++ b/platform/linux/bootstrap.sh @@ -1,7 +1,7 @@ #!/bin/bash set -euo pipefail -# Assemblrr Bootstrap Script +# assemblrr Bootstrap Script # Clones the repository and launches setup.sh # Usage (bash/zsh): bash <(curl -fsSL https://raw.githubusercontent.com/soulis-1256/assemblrr/main/platform/linux/bootstrap.sh) # Usage (fish): bash (curl -fsSL https://raw.githubusercontent.com/soulis-1256/assemblrr/main/platform/linux/bootstrap.sh | psub) diff --git a/platform/windows/bootstrap-dev.ps1 b/platform/windows/bootstrap-dev.ps1 index 4f373a6..cc172ff 100644 --- a/platform/windows/bootstrap-dev.ps1 +++ b/platform/windows/bootstrap-dev.ps1 @@ -1,4 +1,4 @@ -# Assemblrr Dev Bootstrap +# assemblrr Dev Bootstrap # Copies local project files to WSL2 and runs setup.sh # Alternative to bootstrap.ps1 — skips git clone, uses local files instead # Usage: @@ -25,7 +25,7 @@ $AppName = "assemblrr" function Show-Help { Write-Host "" - Write-Host "Assemblrr Dev Bootstrap" -ForegroundColor Cyan + Write-Host "assemblrr Dev Bootstrap" -ForegroundColor Cyan Write-Host "========================" -ForegroundColor Cyan Write-Host "" Write-Host "Copies local project files to WSL2 for development." -ForegroundColor White diff --git a/platform/windows/bootstrap.ps1 b/platform/windows/bootstrap.ps1 index de5e3ee..6acf190 100644 --- a/platform/windows/bootstrap.ps1 +++ b/platform/windows/bootstrap.ps1 @@ -1,4 +1,4 @@ -# Assemblrr Windows Bootstrap +# assemblrr Windows Bootstrap # Clones the repository, copies to WSL2, and launches setup.sh $ErrorActionPreference = "Stop"