betterdiscordctl

A manager for BetterDiscord on Linux.

Installation

Packages

Manual

Requires curl, which you can install from your distro's
package manager, if it's not already installed.

You can then install as follows (# means that a command needs root, which
you can get by prefixing it with sudo):

$ curl -O https://raw.githubusercontent.com/bb010g/betterdiscordctl/master/betterdiscordctl
$ chmod +x betterdiscordctl
# mv betterdiscordctl /usr/local/bin

You can then keep betterdiscordctl up to date with one command:

# betterdiscordctl self-upgrade

Options

betterdiscordctl (mostly) follows the Fuchsia
command-line tools rubric's execution section and
CLI tool help requirements.

-V, --version

Displays the current version.
-h, --help

Displays usage information.
-v, --verbose

Increases the verbosity level, for progressively more debugging information.
-q, --quiet

Decreases the verbosity level, for progressively less debugging information.
-f, --d-flavors <d_flavors> (default :canary:ptb:development)

When scanning, looks for installations with the given suffixes (case
insensitive, both hyphenated and unhyphenated). Stable is '', as it has no
suffix. Note that no spaces follow colons. Your Discord flavor probably
doesn't have a space in it, so don't use any in here.

Flavors besides '' are only relevant to traditional Discord installations.
-m, --d-modules <d_modules>

Disregards scanning results and uses the specified modules directory (found
inside Discord's user-specific storage directory).
-D, --bd-remote-dir <bd_r_dir>

When installing BetterDiscord, use the specified local directory. Overrides
earlier --bd-remote-url or --bd-remote-github. '' keeps a previous
value.
-U, --bd-remote-url <bd_r_url>

When installing BetterDiscord, use the specified base URL. Overrides earlier
--bd-remote-dir or --bd-remote-github. '' keeps a previous value.

Works like --bd-remote-dir with files downloaded into BetterDiscord's data
directory.
-H, --bd-remote-github <bd_r_github> (default ~BetterDiscord/BetterDiscord#latest)

When installing BetterDiscord, use the specified GitHub repository, of form
[~<owner>][/<repo>][#<release>]. Defaults to upstream BetterDiscord.
Overrides earlier --bd-remote-dir or --bd-remote-url. Omitted parts keep
previous values (e.g. -H '~BetterDiscord' only changes the owner to
BetterDiscord, and -H '' changes nothing but still ensures the
configured GitHub repository will be used).

Works like --bd-remote-url with a GitHub repository release download base
URL.
--bd-remote-asar <bd_r_asar>

Instead of downloading betterdiscord.asar from a release, use the
specified BetterDiscord asar file name. This flag is mostly meant for quirky
tests of custom BetterDiscord builds.
-i, --d-install …
- traditional (default)
- flatpak
Automatically detect the default Flatpak directory for Discord.
- snap
Automatically detect the default Snap directory for Discord.
--flatpak-bin <flatpak> (default flatpak)

Calls this flatpak executable.
--snap-bin <snap> (default snap)

Calls this snap executable.
--self-upgrade-url <self_upgrade_url> (default https://github.com/bb010g/betterdiscordctl/raw/master/betterdiscordctl)

Use the specified URL for self-upgrading betterdiscordctl.

Commands

`status`

Displays information about your current BetterDiscord setup.

`install`

Installs BetterDiscord, managing what's necessary by default.

`reinstall`

Reinstalls BetterDiscord, removing the old files.

`uninstall`

Uninstalls BetterDiscord, removing the managed repository if used.

`self-upgrade`

Upgrades betterdiscordctl to the latest version available on GitHub.

If betterdiscordctl is installed from a package, self-upgrading may be
disabled, in which case the package's maintainer should keep it up to date.

Examples

betterdiscordctl --help

Lists options & commands.
betterdiscordctl -f ptb status

Shows the BetterDiscord status for the PTB flavor.
betterdiscordctl -f canary install

Installs BetterDiscord to the Canary flavor.
betterdiscordctl -i flatpak reinstall

Reinstalls BetterDiscord to a Discord installed via Flatpak.
betterdiscordctl -i snap uninstall

Uninstalls BetterDiscord from a Discord installed via Snap.

Files

$XDG_DATA_HOME/betterdiscordctl (fallback ~/.local/share/betterdiscordctl)

betterdiscordctl's machine-specific data directory. Currently unused and
not created on new installs.
$XDG_CONFIG_HOME/BetterDiscord (fallback ~/.config/BetterDiscord)

betterdiscord's normal data & configuration.
- With --flatpak, this will fall back to
  ~/.var/app/com.discordapp.Discord/config/BetterDiscord.
- With --snap, this will fall back to $SNAP_USER_DATA/.config.