BetterDiscord CLI
A cross-platform command-line interface for installing, updating, and managing BetterDiscord.
Features
- 🚀 Easy installation and uninstallation of BetterDiscord
- 🔄 Support for multiple Discord channels (Stable, PTB, Canary)
- 🖥️ Cross-platform support (Windows, macOS, Linux)
- 📦 Available via npm for easy distribution
- ⚡ Fast and lightweight Go binary
Installation
Via npm
npm install -g @betterdiscord/cliVia Homebrew/Linuxbrew
brew install betterdiscord/tap/bdcliVia winget (Windows)
winget install betterdiscord.cliVia Go
go install github.com/betterdiscord/cli@latestDownload Binary
Download the latest release for your platform from the releases page.
Commands
Install
Install BetterDiscord to your Discord installation.
By Channel
Auto-detect Discord installation based on the release channel:
bdcli install --channel stable # Install to Discord Stable (default)
bdcli install --channel ptb # Install to Discord PTB
bdcli install --channel canary # Install to Discord CanaryBy Custom Path
Specify a custom path to any Discord installation:
bdcli install --path /path/to/Discord
# Or using short flag:
bdcli install -p /path/to/DiscordNotes
- If neither
--pathnor--channelis specified, it defaults to the Stable channel - The
--pathand--channelflags are mutually exclusive
Uninstall
Remove BetterDiscord from your Discord installation.
By Channel
bdcli uninstall --channel stable # Uninstall from Discord Stable (default)
bdcli uninstall --channel ptb # Uninstall from Discord PTB
bdcli uninstall --channel canary # Uninstall from Discord CanaryBy Custom Path
Specify a custom path to any Discord installation:
bdcli uninstall --path /path/to/Discord
# Or using short flag:
bdcli uninstall -p /path/to/DiscordNotes
- If neither
--pathnor--channelis specified, it defaults to the Stable channel - The
--pathand--channelflags are mutually exclusive
Version
Display version information about the CLI:
bdcli versionOutput example:
BetterDiscord CLI v1.0.0
Commit: abc123def456
Built: 2025-02-15T10:30:00ZCompletion
Generate shell completion scripts for bash, zsh, or fish:
bdcli completion bash # Generate bash completion
bdcli completion zsh # Generate zsh completion
bdcli completion fish # Generate fish completionTo enable completions, source the output in your shell configuration file.
Help
Get help information about the CLI or any command:
bdcli --help # Show general help
bdcli [command] --help # Show help for a specific commandAvailable Commands
A cross-platform CLI for installing, updating, and managing BetterDiscord.
Usage:
bdcli [flags]
bdcli [command]
Available Commands:
completion Generate shell completions
help Help about any command
install Installs BetterDiscord to your Discord
uninstall Uninstalls BetterDiscord from your Discord
version Print the version number
Flags:
-h, --help help for bdcli
Use "bdcli [command] --help" for more information about a command.Supported Platforms
The CLI is available for multiple platforms and architectures:
- Windows (x64, ARM64, x86)
- macOS (x64, ARM64/M1/M2)
- Linux (x64, ARM64, ARM)
Common Use Cases
First Time Installation
Install from stable channel (recommended):
bashbdcli installOr install to a specific channel:
bashbdcli install --channel ptb
Using Multiple Discord Installations
You can manage multiple Discord installations by specifying custom paths:
# Install to your custom Discord location
bdcli install --path /opt/discord-custom
# Later, uninstall from the same location
bdcli uninstall --path /opt/discord-customVerify Installation
After installing, you can verify the version of the CLI:
bdcli versionTroubleshooting
Discord Installation Not Found
If you get an error like "could not find a valid Discord installation":
- Check if Discord is installed at the default location for your platform
- Use custom path if Discord is installed elsewhere:bash
bdcli install --path /your/custom/discord/path
Mutually Exclusive Flags
You cannot use both --path and --channel in the same command. Choose one:
# ✅ Correct
bdcli install --channel stable
# ✅ Correct
bdcli install --path /custom/path
# ❌ Not allowed
bdcli install --channel stable --path /custom/path