2021-05-01 21:14:02 +12:00
# Installation
## Requirements
### Linux
2021-11-23 23:10:24 +13:00
If you use Snap, Flatpak or Appimage, you need to only install ffmpeg if you want to use Similar Videos tool.
2021-05-01 21:14:02 +12:00
2022-01-01 10:34:24 +13:00
For Czkawka GUI the lowest supported version of GTK is `3.24` which is the only required dependency(of course on Ubuntu, different distributions will probably require a little different set of dependences).
In app exists Similar Video tool which require `FFmpeg` to work, but is completelly optional and without it, only warning would be printed when trying to use this tool without installed ffmpeg.
2022-01-06 10:47:27 +13:00
Broken files finder by default don't check for music files, but it is possible to enable this feature and that require to have alsa lib installed(on Ubuntu this is `libasound2-dev` package)
2022-01-01 10:34:24 +13:00
2021-11-23 23:10:24 +13:00
#### Ubuntu/Debian/Linux Mint
2021-05-01 21:14:02 +12:00
```
2021-11-23 23:10:24 +13:00
sudo apt install libgtk-3-dev ffmpeg
2021-05-01 21:14:02 +12:00
```
2021-11-23 23:10:24 +13:00
#### Fedora/Rocky Linux
2021-05-01 21:14:02 +12:00
```
sudo yum install gtk3-devel glib2-devel
2021-11-23 23:10:24 +13:00
sudo dnf -y install https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm
sudo dnf -y install https://download1.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$(rpm -E %fedora).noarch.rpm
sudo dnf -y install ffmpeg
2021-05-01 21:14:02 +12:00
```
#### Void Linux (CLI only)
```
2022-01-24 21:28:11 +13:00
sudo xbps-install gcc pkg-config ffmpeg
2021-05-01 21:14:02 +12:00
```
### macOS
2021-11-25 23:15:31 +13:00
Currently, you need to manually install `GTK 3` libraries, `FFmpeg` and the Adwaita theme, because they are dynamically loaded from the OS.
2021-11-23 23:10:24 +13:00
One very straight-forward way to do this is by using [Homebrew ](https://brew.sh/ ).
Installation in the terminal:
2021-05-01 21:14:02 +12:00
```shell
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
2021-11-25 23:15:31 +13:00
brew install gtk+3 adwaita-icon-theme ffmpeg librsvg
2021-05-01 21:14:02 +12:00
```
After that, go to the location where you downloaded Czkawka and add the `executable` permission to this file.
```shell
chmod +x mac_czkawka_gui
```
At the end execute it:
```shell
./mac_czkawka_gui
```
2021-11-25 23:15:31 +13:00
**Warning**
2021-12-02 10:34:49 +13:00
Prebuilt binaries are available only for x86_64, so if you use ARM machine like e.g. Mac M1, you need to compile manually app or install special version of required libraries which can be done via this:
```shell
arch -x86_64 /usr/local/bin/brew install gtk+3 adwaita-icon-theme ffmpeg librsvg
```
2021-11-25 23:15:31 +13:00
2021-05-01 21:14:02 +12:00
### Windows
2021-07-03 04:39:44 +12:00
By default, all needed libraries are bundled with the app, inside `windows_czkawka_gui.zip` , but if you compile the app or just move `czkawka_gui.exe` , then you will need to install the `GTK 3`
2021-05-01 21:14:02 +12:00
runtime from [**here** ](https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer/releases ).
2021-11-23 23:10:24 +13:00
FFmpeg to be able to use Similar Videos, you can download and install from this [**link** ](https://ffmpeg.org/ ).
2021-05-01 21:14:02 +12:00
## Installation
### Precompiled binaries
Ready-to-go executables for Linux, Windows and macOS are available [**here** ](https://github.com/qarmin/czkawka/releases/ ).
2021-07-03 04:39:44 +12:00
If the app does not run when clicking the launcher, run it through a terminal.
2021-05-01 21:14:02 +12:00
You don't need to have any additional libraries for CLI Czkawka.
### Nightly Builds
Artifacts from each commit can be downloaded [**here** ](https://github.com/qarmin/czkawka/actions )
### Appimage
Appimage files are available in release page - [**GitHub releases** ](https://github.com/qarmin/czkawka/releases/ )
2022-01-01 10:34:24 +13:00
Available are 2 versions of Appimage:
- default - which bundle gtk theme
- alternative - which don't include any gtk specific libraries
2021-05-01 21:14:02 +12:00
### Cargo
2021-07-03 04:39:44 +12:00
The easiest method to install Czkawka is using the `cargo` command. To compile it, you need to get all the
2021-05-01 21:14:02 +12:00
requirements from the [compilation section ](Compilation.md ).
```
cargo install czkawka_gui
cargo install czkawka_cli
```
You can update the package with the same command.
### Snap
```
sudo snap install czkawka
```
2021-12-06 09:01:16 +13:00
By default, Snap can only access the files in your home directory. You have to allow Czkawka access to all the drives:
2021-05-01 21:14:02 +12:00
```
sudo snap connect czkawka:removable-media
```
The Snap store entry can be found [**here** ](https://snapcraft.io/czkawka ).
2022-01-01 10:34:24 +13:00
Fresh builds are available in edge branch, but they may be a little unstable.
2021-05-01 21:14:02 +12:00
### Flatpak
```
flatpak install flathub com.github.qarmin.czkawka
```
Flathub page with Czkawka can be found [**here** ](https://flathub.org/apps/details/com.github.qarmin.czkawka )
#
#
**Unofficial packages, which may not always provide the latest version of Czkawka.**
### PPA - Debian/Ubuntu (unofficial)
```
sudo add-apt-repository ppa:xtradeb/apps
sudo apt-get update
sudo apt-get install czkawka
```
2021-11-23 23:10:24 +13:00
alternatively you can use instruction from this [xtradeb site ](https://xtradeb.net/wiki/how-to-install-applications-from-this-web-site/ )
2021-05-01 21:14:02 +12:00
### AUR - Arch Linux Package (unofficial)
Czkawka is also available in Arch Linux's AUR from which it can be easily installed.
```
2021-11-23 23:10:24 +13:00
yay -Syu czkawka-gui
yay -Syu czkawka-cli
2021-05-01 21:14:02 +12:00
```
or
```
yay -Syu czkawka-gui-bin
yay -Syu czkawka-cli-bin
```
2022-01-01 10:34:24 +13:00
[**Packages info** ](https://aur.archlinux.org/packages/?O=0&SeB=nd&K=czkawka&outdated=&SB=n&SO=a&PP=50&do_Search=Go )
2021-05-01 21:14:02 +12:00
### Docker image (unofficial)
2021-05-04 01:44:42 +12:00
Czkawka docker image is available [**here** ](https://github.com/jlesage/docker-czkawka )
2021-11-25 23:15:31 +13:00
### Chocolatey (unofficial)
2022-01-24 21:28:11 +13:00
Windows Chocolatey binaries are available [**here** ](https://community.chocolatey.org/packages/czkawka )