https://github.com/upscayl/upscayl Skip to content Toggle navigation Sign in * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions For + Enterprise + Teams + Startups + Education By Solution + CI/CD & Automation + DevOps + DevSecOps Resources + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} upscayl / upscayl Public * Notifications * Fork 1.1k * Star 24.7k * Upscayl - Free and Open Source AI Image Upscaler for Linux, MacOS and Windows built with Linux-First philosophy. upscayl.org License AGPL-3.0 license 24.7k stars 1.1k forks Branches Tags Activity Star Notifications * Code * Issues 39 * Pull requests 2 * Discussions * Actions * Projects 1 * Wiki * Security * Insights Additional navigation options * Code * Issues * Pull requests * Discussions * Actions * Projects * Wiki * Security * Insights upscayl/upscayl This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main BranchesTags Go to file Code Folders and files Last Last Name Name commit commit message date Latest commit History 872 Commits .github .github build build common common docs docs electron electron export/build export/build flatpak flatpak models models renderer renderer resources resources scripts scripts ups ups .gitignore .gitignore .prettierignore .prettierignore .prettierrc .prettierrc 1080p_banner.jpg 1080p_banner.jpg 1080p_explainer.jpg 1080p_explainer.jpg COMPARISONS.MD COMPARISONS.MD LICENSE LICENSE README.md README.md Real-ESRGAN_LICENSE.txt Real-ESRGAN_LICENSE.txt download.jpg download.jpg mas-dev.json mas-dev.json mas.json mas.json news.md news.md next.config.js next.config.js notarize.js notarize.js org.upscayl.Upscayl.desktop org.upscayl.Upscayl.desktop package-lock.json package-lock.json package.json package.json postcss.config.js postcss.config.js screen1.png screen1.png tailwind.config.js tailwind.config.js to_upscale.jpeg to_upscale.jpeg tsconfig.json tsconfig.json update_upscayl_ncnn_binaries.sh update_upscayl_ncnn_binaries.sh upscayl.mp4 upscayl.mp4 View all files Repository files navigation * README * AGPL-3.0 license [237577889-] v2.9.9 is out! [68747470733a2f2f696d672e736] [209297095-a3db856f-b760-40b] [215301815-b9922b27-4e65-435] Upscayl [268787070-5c7b31a4-1c15-4bdf-aa0a-2fbedb781524] Free and Open Source AI Image Upscaler Upscayl lets you enlarge and enhance low-resolution images using advanced AI algorithms. Enlarge images without losing quality. It's almost like magic! Upscayl is a cross-platform application built with the Linux-first philosophy. This means that Linux users receive pre-release builds earlier, but Upscayl itself is available on all major desktop operating systems :) https://upscayl.org Screenshot Important You'll need a Vulkan compatible GPU to upscale images. Many CPU and iGPUs do not work but no harm in trying. Installation Linux [6874747073] [191270389-] [191269445-] [6874747073] [site-logo] Upscayl should be available on the software listings of most Linux operating systems. Your distro's Store app might also support the Flatpak or Snap version. Portable Method 1. Go to releases section 2. Download the upscayl-x.x.x-linux.AppImage file. 3. Right Click AppImage -> Go to Permissions tab -> Check 'allow file to execute' and then double click the file to run Upscayl. You can also choose to install using other formats like RPM (Fedora), DEB (Debian/Ubuntu based), and ZIP (Any x86 Linux OS). macOS (MacOS 12 and later) [6874747073] 1. Go to releases section 2. Download the upscayl-x.x.x-mac.dmg file. 3. Double click dmg, drag Upscayl icon into Applications folder. 4. Open Finder, click 'Applications' tab in the left sidebar. Find Upscayl and right click on it. Select 'Open'. 5. In the window that appears, press 'Open' yet again. Homebrew brew install --cask upscayl Windows (Windows 10 and later) 1. Go to releases section 2. Download the .exe file. 3. Double click exe file, wait for installation, profit. Wiki - Tutorials and Guides Check out our Wiki here. * Try out even more new models! * Convert your own models * Compatibility List * Troubleshooting [?][?] Results Check out Upscayl before/after comparisons here. Roadmap You can track all the progress here: https://github.com/orgs/upscayl/ projects/1 * Fix bugs * Make the whole world use FOSS (WIP ) Development I recommend using Volta: https://volta.sh for installing Node.js. Download and install volta, then do: volta install node. Running Note If you are not willing to install git, you can skip the first line, download the source zip and extract it to upscayl instead and carry on with the rest of the instructions. git clone https://github.com/upscayl/upscayl cd upscayl # INSTALL DEPENDENCIES npm install # RUN THE DEVELOPMENT SERVER LOCALLY ## YOUR LOGS WILL NOW APPEAR IN THE TERMINAL npm run start [?] Building # INSTALL DEPENDENCIES npm install # PACKAGE THE APP npm run dist # PUBLISH THE APP, MAKE SURE TO ADD GH_TOKEN= IN SHELL # ONLY DO THIS IF YOU'RE A MAINTAINER npm run publish-app FAQ * How does Upscayl work? + Upscayl uses AI models to enhance your images by guessing what the details could be. It uses Real-ESRGAN and Vulkan architecture to achieve this. Our backend is fully open-source under the AGPLv3 license. * I don't see a drastic change in my upscaled image. Why is that? + Upscayl can enhance low resolution images and images that are pixelated but it cannot de-blur or do focus adjustment on your image. If your image is out-of-focus or totally blurred, Upscayl is not the right tool for it. Please use images that are similar to the examples we've given here. * Is there a CLI available? + The CLI tool is called upscayl-ncnn. * Do I need a GPU for this to work? + Yes, unfortunately. NCNN Vulkan requires a Vulkan-compatible GPU. Upscayl won't work with most iGPUs or CPUs. But hey, no harm in trying ;) o @Wyrdgirn has contributed a workaround for Windows and Linux in #390! Nobody knows how to manipulate the macOS and Haiku frameworks... * How can I contribute? + You can report issues, fix code and add features by submitting PRs, or donate! * What's the GPU ID for? + It is for selecting which GPU to use. The specific procedure is detailed in the Wiki. o Note that for Windows systems, if Upscayl is not set to performance mode, the system may override this setting. * Where do I find more models? + More models can be taken from here: https://github.com/ upscayl/custom-models Upscayl uses Real-ESRGAN-ncnn-vulkan binaries to upscale images. Donate [154570688-] Credits * Real-ESRGAN for their wonderful research work. Real-ESRGAN: Copyright (c) 2021, Xintao Wang * @JanDeDinoMan, @xanderfrangos, @Fdawgs, @keturn for their code contributions * @aaronliu0130 for providing community support :) * Foolhardy for their Remacri model. * Kim2091 for their Ultrasharp and Ultramix Balanced model. * @NicKoehler for their amazing logo :) Copyright (c) 2023 - Upscayl By Nayam Amarshe and TGS963 Made with & [?] About Upscayl - Free and Open Source AI Image Upscaler for Linux, MacOS and Windows built with Linux-First philosophy. upscayl.org Topics electron image ai upscale topaz gigapixel gigapixel-images esrgan image-upscaling upscalerimage upscayl Resources Readme License AGPL-3.0 license Activity Custom properties Stars 24.7k stars Watchers 137 watching Forks 1.1k forks Report repository Releases 24 2.10.0 Latest Feb 29, 2024 + 23 releases Contributors 21 * @NayamAmarshe * @aaronliu0130 * @TGS963 * @Danik1601 * @dependabot[bot] * @yevgeniyakimenko * @xanderfrangos * @AyliasTheCoder * @illright * @JanDeDinoMan * @wenbin-collab * @MrPenguin07 * @keturn * @yoavain + 7 contributors Languages * TypeScript 89.7% * Python 3.7% * CSS 3.7% * JavaScript 2.0% * Shell 0.9% Footer (c) 2024 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact * Manage cookies * Do not share my personal information You can't perform that action at this time.