> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flumeirc.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> How to install Flume on your system

## From Source

Requires [Rust](https://rustup.rs/) 1.75+.

```bash theme={null}
git clone https://github.com/FlumeIRC/flume.git
cd flume
cargo install --path flume-tui
```

### With Python Scripting

Python scripting is an optional feature requiring Python 3.10+ development headers:

```bash theme={null}
cargo install --path flume-tui --features python
```

## Homebrew (macOS / Linux)

```bash theme={null}
brew install FlumeIRC/tap/flume
```

## Arch Linux (AUR)

```bash theme={null}
yay -S flume
```

## Nix

```bash theme={null}
nix profile install github:FlumeIRC/flume
```

Or try without installing:

```bash theme={null}
nix run github:FlumeIRC/flume
```

## Debian / Ubuntu

Add the Flume package repository:

```bash theme={null}
curl -fsSL https://pkg.flumeirc.io/gpg/flume-signing-key.asc | sudo gpg --dearmor -o /usr/share/keyrings/flume.gpg
echo "deb [signed-by=/usr/share/keyrings/flume.gpg] https://pkg.flumeirc.io/apt stable main" | sudo tee /etc/apt/sources.list.d/flume.list
sudo apt update && sudo apt install flume
```

Or install a `.deb` directly from the [Releases](https://github.com/FlumeIRC/flume/releases) page:

```bash theme={null}
sudo dpkg -i flume_1.2.5_amd64.deb
```

Available for both `amd64` and `arm64`.

## Fedora / RHEL / CentOS

### Fedora 39+ / RHEL 9+ (DNF5)

```bash theme={null}
sudo curl -o /etc/yum.repos.d/flume.repo https://pkg.flumeirc.io/rpm/flume.repo
sudo dnf install flume
```

### Fedora 38 and older / RHEL 8 / CentOS Stream (DNF4)

```bash theme={null}
sudo dnf config-manager --add-repo https://pkg.flumeirc.io/rpm/flume.repo
sudo dnf install flume
```

### RHEL 7 / CentOS 7 (Yum)

```bash theme={null}
sudo yum-config-manager --add-repo https://pkg.flumeirc.io/rpm/flume.repo
sudo yum install flume
```

### Manual install

Download an `.rpm` from the [Releases](https://github.com/FlumeIRC/flume/releases) page:

```bash theme={null}
sudo rpm -i flume-1.2.5-1.x86_64.rpm
```

Available for both `x86_64` and `aarch64`.

## FreeBSD

Build from the port files included in the repo:

```bash theme={null}
cd flume/packaging/freebsd
make install clean
```

<Note>
  A FreeBSD ports submission is planned. In the meantime, build from source or use the port Makefile above.
</Note>

## Pre-built Binaries

Download from the [GitHub Releases](https://github.com/FlumeIRC/flume/releases) page.

Available for:

* macOS (Apple Silicon, Intel)
* Linux (x86\_64, ARM64)
* Debian/Ubuntu (.deb)
* Fedora/RHEL (.rpm)