SUPYSONIC-CLI-FOLDER(1)

📦
version 0.7.9 · 4 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

💖 SUPYSONIC-CLI-FOLDER 💖

okay bestie, welcome to the Supysonic manual, section 1 — and this one is literally all about supysonic-cli-folder, the folder management commands. your library folders? the places your audio files live? yeah, this is the girl who runs that whole operation. ✨

🎀 NAME 🎀

supysonic-cli-folder — Supysonic folder management commands. that's it, that's the job. folder management. iconic behaviour honestly. 💅

🌸 SYNOPSIS 🌸

supysonic-cli folder --help

supysonic-cli folder list

supysonic-cli folder add <name> <path>

supysonic-cli folder delete <name>

supysonic-cli folder scan [--force] [--background | --foreground] <name>

🦋 DESCRIPTION 🦋

so the supysonic-cli folder subcommand is the one managing your library folders — aka the spots where all your audio files are chilling. it lets you list, add, delete and scan those folders. four verbs, zero drama. periodt. 👑

🍓 ARGUMENTS 🍓

  • list — list all the folders. that's it. a little folder roll call. 💖
  • add <name> <path> — add a brand new library folder called <name> that lives at <path>. two things to know, bestie: <name> has to be unique, and <path> has to point at a directory that actually exists. oh and — if supysonic-daemon is running, it will start listening for changes in this folder, but it will not scan files that are already sitting in there. so don't come for the daemon about files it never looked at, ok?? 😭
  • delete <name> — delete the folder called <name>. bye bye 🫶
  • scan [--force] [--background | --foreground] <name> — scan the folders you specify. if you don't give it any folder name at all, then all the registered folders get scanned. the whole collection. main character energy. 🌈

✨ OPTIONS ✨

  • -h, --help — shows help and exits. and here's the cute lil detail: depending on where this option shows up, it'll either list the available commands or display help for one specific command. it's giving context-aware. 💅
  • -f, --force — force a scan of already known files even if they haven't changed. when is this useful?? when an update to supysonic adds new metadata to audio files. so like, you're not being extra, you're being thorough. 🎀
  • --background — scan in the background. this one requires the supysonic-daemon to be running, so check that first bestie.
  • --foreground — scan in the foreground, which means it blocks the process while the scan is running. you're gonna sit there and wait. no multitasking. 🙈
heads up: if neither --background nor --foreground is provided, supysonic-cli will try to connect to the daemon to kick off a background scan, and if the daemon isn't available it falls back to a foreground scan. so it's got a plan B built in. slay.

💜 EXAMPLES 💜

wanna add a new folder to your music library? you can do something like this, bestie:

$ supysonic-cli folder add MyLibrary /home/username/Music

and once you've added a folder, you need to scan it:

$ supysonic-cli folder scan MyLibrary

and then — the payoff — the audio files residing in /home/username/Music will now appear under the MyLibrary folder on the clients. look at you go. 😭✨

🌟 SEE ALSO 🌟

  • supysonic-cli (1)
  • supysonic-cli-user (1)
  • supysonic-server (1)
  • supysonic-daemon (1)

go read those too, iykyk 🦋

👑 AUTHOR 👑

Louis-Philippe Véronneau, Alban Féron. legends fr fr. 💖

2013-2023, Alban Féron. all rights reserved, respectfully. 🎀

okay that's the whole page!! huge shoutout to Supysonic 0.7.9, dated Apr 15, 2025 — that's the version and the date this manual came from, so if you're on something older or newer, vibe check accordingly. mwah, go scan some folders bestie 💅🫶✨

📦 where this page comes from