Getting Started

Install

tuxcast needs Python 3.11 or newer, which every current distribution ships. It is published on PyPI; install it for your user with pipx:

pipx (recommended)

pipx install tuxcast

Installer script

curl -fsSL https://raw.githubusercontent.com/achedon12/tuxcast/main/install.sh | sh

The script installs from PyPI with pipx (or uv) and refuses to run as root. Read it first.

uv

uv tool install tuxcast

No pipx yet? sudo apt install pipx (Debian, Ubuntu), sudo dnf install pipx (Fedora) or sudo pacman -S python-pipx (Arch), then pipx ensurepath.

Update with pipx upgrade tuxcast, remove with pipx uninstall tuxcast.

Check your setup

tuxcast doctor

Each line is a check: ✔ fine, • worth knowing, ⚠ will probably bite you, ✖ broken. Warnings and failures come with a fix: line. Start from the top: display and audio problems explain many of the ones below.

Prefer clicking? tuxcast ui opens the same checks in a dashboard, with a button for each fix tuxcast can apply.

Fix what it found

The doctor says	Run
Your stream audio is a single mix	tuxcast audio setup
Discord is invisible to most Discord clients	tuxcast bridge discord --install
Stream Deck: no permission	tuxcast deck udev
Coming from Windows or macOS?	tuxcast convert MyProfile.streamDeckProfile
You stream over Wi-Fi	read the network guide

Then run tuxcast doctor again. When everything is green, you are ready to go live.

Next

• New to streaming on Linux? Read Streaming on Linux in 2026.
• Switching from Windows with a Stream Deck? Go to Stream Deck on Linux.

---

_{Generated from docs/getting-started.md. Edit it there: this page is overwritten at each change.}