A dedicated downloader for downloading AI model files, which can stably and reliably download your favorite models from Hugging Face, Model Scope and Civitai. It supports both command line and UI, and is currently only available on Windows.
English · 简体中文
Warning
The application is developed based on .NET 8, it is not a cross-platform application, and is currently only available on Windows. For users below Windows 10 19041, please use the command line instead of the UI.
Table of contents
The application, with aria2 at its core, offers two modes of use:
- Command line
- UI
This caters to the needs of different users.
Both the command line and UI have simple localization support (supporting en-US and zh-CN), and can switch automatically according to the current system language.
Tip
The UI is based on the Windows App SDK, which requires your system version to be Windows 10 19041 and above. It is highly recommended to download and install from the Microsoft Store.
I have to say, the sole motivation for building this tool was that I couldn't find a convenient, reliable download tool to download entire repositories from hugging face. Either there's no progress indication, or the robustness is too poor.
My technical skills aren't great, but aria2 has left a good impression on me in the past, so I chose to build a simple download tool based on it.
The download has the following features:
- Customizable download directory
- Support for resuming downloads
- Complete progress display
- Ability to operate on individual items, pause/resume/cancel (App only)
Both CLI and APP come with a built-in 1.3.7 aria2c.exe, no additional download required, trying to be as plug and play as possible.
| Framework | .NET 8 |
| UI Framework | Windows App SDK 1.5 |
| System Requirements | CLI: Windows 7 and above, APP: Windows 10 19041 and above |
Warning
CLI relies on .NET 8 framework, please make sure that .NET 8 Desktop Runtime or SDK is installed on your device.
You can download .NET SDK or .NET Desktop Runtime at Download .NET 8.0.
- Open PowerShell
- Enter the command
dotnet tool install --global RodelDownloader.CLI - After the installation is complete, enter the command
rodel-downloaderto enter the interactive command interface - You can also enter the command
rodel-downloader --helpto view detailed parameter definitions
The CLI defaults to an interactive mode to guide you through the download process.
After installation, you can simply enter rodel-downloader to access the interactive interface.
The basic download steps are as follows:
- Choose the model hosting service. Currently,
Hugging Face / HF-Mirror,Civitai, andModel Scopeare supported. - Enter the model ID you want to download. This model ID is usually provided by the hosting service.
- The CLI will search for the repository and download file list corresponding to the model ID. Once found, it will be listed and you can freely choose which files to download.
- Start downloading. The CLI will provide progress tips. You can wait for the download to complete or press
Ctrl+Cat any time to interrupt the download.
The following image uses the LLM-Research/Phi-3-mini-128k-instruct model from the Model Scope community as an example
The CLI also accepts another mode of operation, which is the regular parameter call.
When you need to use parameter calls, you must first disable the interactive mode, which is -n or --no-interaction.
After that, you need to provide the specified parameters.
--ignore-config (Default: false) Ignore the local configuration and use the default process for interaction.
--clean-up (Default: false) Kill all aria2c processes before starting the download.
--edit-config (Default: false) Edit the configuration file.
-n, --no-interaction (Default: false) Disable interaction and use the command-line parameters.
-m, --model-id The model ID to download.
-s, --service (Default: hf) The service to download the model from. Support hf | civitai | ms
--use-hf-mirror (Default: false) Use the hf-mirror (https://hf-mirror.com/) for downloading. Only available
when service is hf.
-t, --token (Default: ) The token to use for authentication.
-d, --save-dir (Default: ) The directory to save the model to.
-i, --include (Default: ) The files to include in the download.
-e, --exclude (Default: ) The files to exclude in the download.
--help Display this help screen.
--version Display version information.
Download the microsoft/Phi-3-mini-4k-instruct model from Hugging Face:
rodel-downloader -n -m "microsoft/Phi-3-mini-4k-instruct" -s hf --token "hf-xxxxxxxx" -d "C:\Models"Repeated input can be quite troublesome. The CLI supports using a configuration file to fix optional parameters, simplifying input each time it is called.
Enter the following command in the command line:
rodel-downloader --edit-configThe application will call the default editor to open the configuration file config.json (if it does not exist, create a new one), the specific parameters are as follows:
{
"hf_token": "",
"hf_save_folder": "",
"hf_backup_folders": {
"folder1": "path1",
"folder2": "path2"
},
"hf_uri_type": "{official} or {mirror}",
"civitai_token": "",
"civitai_save_folder": "",
"civitai_backup_folders": {
"folder1": "path1",
"folder2": "path2"
},
"ms_token": "",
"ms_save_folder": "",
"ms_backup_folders": {
"folder1": "path1",
"folder2": "path2"
}
}-
*_tokenThis is the access token for the corresponding service. Here,hfstands for Hugging Face, andmsstands for Model Scope. -
*_save_folderand*_backup_foldersThese are a pair of mutually exclusive properties, and the application prefers to use*_save_folder.- If the model you download will only be saved in a specific folder, fill in
*_save_folder, and the CLI will download the model of the corresponding service to this folder. - If you have multiple optional locations, such as downloading the models required for SD-WebUI (check point, lora...), you can fill in the corresponding paths into
*_backup_folders, wherekeyis the readable name of the folder path, andvalueis its absolute path. When running the CLI, you can choose from the defined folder list.
[!WARNING]
The "save folder" means the parent folder for storing the model. For
Hugging FaceandModel Scope, the application will create a subfolder with the same name as the model in this folder as the directory for storing model files.For example, if you specify
C:\MyFolderas the save folder, then after you download the Llama 3 8B model, the actual model file folder path isC:\MyFolder\Meta-Llama-3-8B.But for
Civitai, since it is usually a single file download, the application will not create a same-name subfolder, but directly download the model file to the specified storage directory. - If the model you download will only be saved in a specific folder, fill in
| Hugging Face | User Access Tokens |
| Civitai | Civitai's Guide to Downloading via API |
| Model Scope | Access Token, Model Scope Personal Center -> Access Token |
The application is based on aria2, so it has the ability to resume from breakpoints. The management and recovery of download progress is controlled by aria2.
If for some reason, you interrupt the download.
Recovery is also simple, just enter the same parameters as the last call.
Make sure your model ID, save path, and hosting service are the same as before.
Tip
The basis for resuming from a breakpoint is that you still have the files from the last download, and the binary files with the suffix .aria2 in the same directory, which save your download progress.
If the corresponding files are deleted, you need to download again.
You can directly download and install it from the Microsoft Store, and it can be automatically updated afterwards.
The first time you start the application, the application will guide you to do some configurations, including filling in the tokens of services such as Hugging Face, Civitai, Model Scope and the corresponding service save folders, etc.
Screenshot
Tip
If you don't need the corresponding service, just click Next to skip the configuration.
If you have previously used CLI and set up your own configuration file, then you can directly import the configuration at this step.
Screenshot
All initial configurations can be changed later on the application settings page.
Screenshot
After opening the application, you can switch different model hosting services in the navigation bar on the top right.
Click the Download Model button to pop up the download dialog box of the corresponding service.
Screenshot
Follow the prompts to enter the model's Id and select the save folder. You can also click Select Others to temporarily select a folder for storage.
Afterwards, you can view the file list of the corresponding repository, select the files you need to download, and click download.
Screenshot
The application will add download tasks one by one, and you can observe the download progress and download speed in real time on the interface.
Screenshot
You can pause or resume a task at any time.
Warning
Unlike regular downloaders, the application does not keep your history.
If you close a downloading task for some reason, don't worry, you can still resume the download progress, but you need to recreate the same download task (the same service, the same model ID, the same save path).
On this point, the application does have a record, when you create a download task again, the application will use your last download configuration.