🖼️ A terminal frontend for Real-ESRGAN.
Go to file
2024-05-02 21:48:47 +03:00
.github/workflows ci(github): update build pipeline 2024-03-27 21:25:01 +03:00
imgs docs: add images 2023-08-29 12:50:13 +03:00
src refactor(main): remove warning for Windows users 2024-05-02 21:48:47 +03:00
.gitignore feat: make fancy output, add overwrite option for upscale, add some files to .gitignore, etc. 2023-08-18 10:38:19 +03:00
Cargo.lock chore: update version number 2024-05-02 21:46:39 +03:00
Cargo.toml chore: update version number 2024-05-02 21:46:39 +03:00
LICENSE repo: push sources 2023-03-26 10:04:11 +03:00
README.md docs: update README.md 2023-08-29 12:51:00 +03:00
rustfmt.toml feat: add rustfmt.toml and new commands 2023-08-17 15:13:31 +03:00

Resup

Resup is CLI front-end for realesrgan-ncnn-vulkan image upscaler written in Rust. It allows you quickly upscale your images directly in CLI.

Installation

Install Real-ESRGAN

Resup requires realesrgan-ncnn-vulkan to be installed. Check your distro repositories for their availability. If its not available in your distro repositories, download it from official repository.

Install Resup

Install with cargo

Use command below to install it from crates.io (make sure that you have installed Rust toolchain and C/C++ compiler).

cargo install resup

Install from releases

Go to release tab and download version that you want. Extract archive content and place executable in directory that exists in PATH variable.

Build from source

You can compile Resup manually. Clone this repository, install Rust toolchain and C/C++ compiler and run build with command below.

cargo build --release

Usage

To start upscale you can use upscale command with the path to your file:

resup upscale my_image.jpg

In this example, image will be saved as my_image-upscaled.png. You can specify name of output image manually with --output argument.

resup upscale my_image.jpg --output my_image.png

You can get full list of available models. Use list command for it:

resup list

Configuration

You can configure Resup for your system without need to edit configuration file. You can use Resup builtin commands for it.

  • model - Shows currently used model. To specify new, use this command and as argument provide name of model. Example: resup model realesrgan-x4plus-anime.
  • models-dir - Shows current path to directory with models. To specify new, use this command and as argument provide path to directory with models. Example: resup models-dir ~/esrgan/models.
  • executable - Shows current path to executable file. To specify new, use this command and as argument provide path to executable. Example: resup executable ~/esrgan/realesrgan-ncnn-vulkan.