This instruction is outdated and will be removed in one of next version, please look at README.md files in each module folder for more up to date instructions.
If you use Snap, Flatpak or Appimage, you need to only install ffmpeg if you want to use Similar Videos tool.
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).
@ -18,38 +21,51 @@ Broken files finder by default don't check for music files, but it is possible t
Main Czkawka GUI dependency - GTK 4 is only available on newer systems like e.g. Ubuntu 22.04, so if you have problems with running app on older systems, you may like to use older Czkawka versions, upgrade OS or install flatpak package which use its own set of dependencies.
Sadly this doesn't work for all users, so feel free to update this part of documentation(look at https://github.com/qarmin/czkawka/issues/689 and https://github.com/qarmin/czkawka/issues/637 for more info)
Sadly this doesn't work for all users, so feel free to update this part of documentation(look at <https://github.com/qarmin/czkawka/issues/689> and <https://github.com/qarmin/czkawka/issues/637> for more info)
#### Generate App Bundle (macOS)
To generate an app bundle on macOS, you can use the provided script `./misc/create_app_bundle.sh`. This script will create an `.app` bundle with the necessary structure and copy the executable and icon files into the correct locations.
1. Install `librsvg` with Homebrew: `brew install librsvg`
2. Run the script: `./misc/create_app_bundle.sh`
3. The `.app` bundle will be in `./target/release`
4. Move the bundle to Applications: `mv ./target/release/Czkawka.app /Applications`
Now, you can launch Czkawka from your Applications folder or via Spotlight search.
### Windows
By default, all needed libraries are bundled with the app except libheif library which allows to scan/use heif files, 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 4`
runtime from [**here**](https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer/releases).
FFmpeg to be able to use Similar Videos, you can download and install from this [**link**](https://ffmpeg.org/).
## Installation
### Precompiled binaries
Ready-to-go executables for Linux, Windows and macOS are available [**here**](https://github.com/qarmin/czkawka/releases/).
If the app does not run when clicking the launcher, run it through a terminal.
You don't need to have any additional libraries for CLI Czkawka.
@ -102,27 +136,35 @@ linux_czkawka_gui
>**Note** This requires that the `$PATH` environment variable contains `~/.local/bin/`.
### 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/)
Available are 2 versions of Appimage:
- default - which bundle gtk theme
- alternative - which don't include any gtk specific libraries
### Cargo
The easiest method to install Czkawka is using the `cargo` command. To compile it, you need to get all the
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
```
By default, Snap can only access the files in your home directory. You have to allow Czkawka access to all the drives:
```
@ -134,17 +176,21 @@ The Snap store entry can be found [**here**](https://snapcraft.io/czkawka).
Fresh builds are available in edge branch, but they may be a little unstable.
### 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 update
@ -154,12 +200,16 @@ sudo apt-get install czkawka
alternatively you can use instruction from this [xtradeb site](https://xtradeb.net/wiki/how-to-install-applications-from-this-web-site/)
### AUR - Arch Linux Package (unofficial)
Czkawka is also available in Arch Linux's AUR from which it can be easily installed.