Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Install script

curl -fsSL https://raw.githubusercontent.com/PndaMan/delune/main/install.sh | sh

install.sh is a POSIX shell script (tested under dash in CI) that:

  1. detects the platform: Linux or macOS, x86_64 or aarch64 (and the native build under Rosetta);
  2. finds the latest release, or the one you ask for;
  3. downloads it with retries and checks it against the release’s published SHA-256 (it refuses to install anything that doesn’t match);
  4. makes sure the programs run on this machine before replacing anything;
  5. installs delune and delune-tui by copying next to the target and renaming, so an interrupted install never leaves half a program;
  6. starts delune setup on a first install.

Running it again upgrades: it skips a version that’s already installed, restarts a running user service after an upgrade, and leaves your settings alone.

Options

Pass options after sh -s --:

curl -fsSL https://raw.githubusercontent.com/PndaMan/delune/main/install.sh | sh -s -- --version v0.1.0 --no-setup
OptionEnvironment variableWhat it does
--version <tag>DELUNE_VERSIONInstall this release (v0.1.0 or 0.1.0). Default: the latest.
--bin-dir <dir>DELUNE_BIN_DIRInstall here. Default: ~/.local/bin (or $XDG_BIN_HOME), /usr/local/bin as root.
--no-setupDELUNE_NO_SETUP=1Don’t start delune setup afterwards.
--forceDELUNE_FORCE=1Reinstall even if this version is already there.
-y, --yesDELUNE_YES=1Don’t ask questions (use sudo without asking if the folder needs it).
--mirror <url>DELUNE_DOWNLOAD_BASEDownload the release files from here instead of GitHub.
--uninstallRemove the programs and your user service. Your data is kept.
--dry-runShow what would happen without changing anything.
-h, --helpShow the options.

NO_COLOR turns colours off.

Root and sudo

The script never needs root for the default folder. If you choose a folder you can’t write to (like /usr/local/bin as a normal user), it asks before using sudo, and only uses it for creating, copying and renaming the programs.

Reading it first

Piping to a shell runs whatever the URL serves. To look before you run:

curl -fsSLO https://raw.githubusercontent.com/PndaMan/delune/main/install.sh
less install.sh
sh install.sh

Where things go
Programs~/.local/bin/delune, ~/.local/bin/delune-tui
Data~/.local/share/delune (or /var/lib/delune as root)
Service~/.config/systemd/user/delune.service
Client settings~/.config/delune/tui.toml

If ~/.local/bin isn’t on your PATH, the script prints the line to add to your shell’s profile.

When there’s no release yet

Until the first release is tagged, the script says so and points to building from source.