✅ Rewritten in TypeScript.
✅ Full upscalejs models support!
✅ Scale support (2x, 3x, 4x, and 8x!).
using upscalerjs
npm install upscaler-cli -gupscaler <img or dir> [options]
# example
upscaler align_landscape.png -m @upscalerjs/esrgan-medium -s 4x -o upscales/
Artist: stable-diffusion
Prompt: a fantastic alien landscape
Tip
If upscaling appears "stuck" - it's probably maxing out the nodejs memory limit trying to upscale the image.
Try a lower scale, or a different model to see if it improves result time.
| name | description | example |
|---|---|---|
| path/to/img | path to image/directory to upscale | upscaler alien_landscape.png |
| list, ls | list all supported upscale models and their respective supported scales | upscaler ls, upscaler ls |
| name | description | type | example |
|---|---|---|---|
| model | upscale model to use | string | -m @upscalerjs/esrgan-medium |
| output | output directory | string | -o upscales/ |
| scale | scale of upscale model to use | string | -s 4x |
| name | scale |
|---|---|
| @upscalerjs/esrgan-slim | 2x 3x 4x 8x |
| @upscalerjs/esrgan-medium | 2x 3x 4x 8x |
| @upscalerjs/esrgan-thick | 2x 3x 4x 8x |
| @upscalerjs/esrgan-legacy | div2kx2 div2kx3 div2kx4 gans |
| @upscalerjs/maxim-deblurring | 64 256 |
| @upscalerjs/maxim-dehazing-indoor | 64 256 |
| @upscalerjs/maxim-dehazing-outdoor | 64 256 |
| @upscalerjs/maxim-denoising | 64 256 |
| @upscalerjs/maxim-deraining | 64 256 |
| @upscalerjs/maxim-enhancement | 64 256 |
| @upscalerjs/maxim-retouching | 64 256 |
upscale an image using the default upscaling model
upscaler image.png| example | description |
|---|---|
upscaler ls |
list all available upscale models and their supported scales |
upscaler image.png |
upscale image using the default model and save to current directory |
upscaler image.png -o ./upscales |
upscale image using the default model and save to ./upscaels (directory ./upscales will be created if it doesn't exist) |
upscaler image.png -s 4x |
upscale image using the default model with a scale of 4 and save to current directory |
upscaleer -m @upscalerjs/esrgan-medium -s 8x |
upscale image using @upscalerjs/esrgan-medium model with a scale of 8 and save to current directory |