(QUICK NOTE: CivitAI seems to have changed their API so that it will require an API key for all model downloads, please see API Key Page for instructions)
Note v2 has some changes regarding the cli args of the program. Please read the README below or run civitdl --help
for the new arguments!
Uses CLI to batch download Stable Diffusion models, metadata (including description of model, author, base model, example prompts and etc.) and example images (default is 3) of checkpoints, loras, and TI models from civitai!
requirements.txt
pip3 install civitdl
# pip install civitdl # if pip3 is not found
git clone https://github.com/OwenTruong/civitdl.git # Clone the project
cd civitdl # CD into project directory
pip3 install . # Use pip if pip3 is not found
# Make sure you are in project directory # use pip if pip3 is not found
python3 -m build
pip3 install -r ./requirements.txt
pip3 install --upgrade dist/*.whl
To get started quickly, copy the command below.
civitdl 123456 ./models
123456
with your model of choice (it can be a civitai.com url or model id)../models
with the directory you wish to download the model to.Example with url:
civitdl https://civitai.com/models/123456 ./models
civitconfig --help
to check what options are available!/parent_dir/extra_data/
instead of to /parent_dir/
If you encounter similar warning on Linux/Windows while building and installing manually:
WARNING: The script civitdl is installed in '/home/OwenTruong/.local/bin' which is not on PATH.
Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
For Linux, please concat the path to your PATH env, example:
echo 'PATH="$HOME/.local/bin:"$PATH' >> ~/.bashrc
source ~/.bashrc
For Windows, this may help: https://www.computerhope.com/issues/ch000549.htm
If you are building from source and the following packages are not available setuptools, wheel, build
, please install them with pip install setuptools wheel build
Thanks for the interest in the project!
Please create an issue if you encounter any problem, bugs or if you have a feature request.
To debug things, it is recommended to run with --verbose
option.
civitdl 123456 ./models --verbose
To work on an issue:
This project is licensed under the Apache License 2.0 - see the LICENSE.md file for details