civitai-sync

civitai-sync is a tool to download and explore your Civitai creations.

• Download generations from the Civitai generator

• Download posts from your public profile

• Browse your creations offline, with the mini-website Explorer

• Data and media is saved in date-ordered folders.

• Auto-updates for new versions

Like it? Give a thumbs-up or review. ❤️

See comments below, and the discussion page for ideas and issues: https://civitai.com/articles/5676

The program comes in 2 parts:

• Command Line Interface (CLI). It runs in your computer terminal or command prompt

• Explorer, a mini-website to browse your creations.

Civitai saves your generations for 30 days, so use the tool regularly.
Read on for installation instructions.

Download the tool

1. Download the tool from this page. It's a zip file.

2. On your computer, Unzip (or “Extract”) the file. It will create a new folder; rename it “civitai-sync”. Move the folder wherever you want to keep it.

3. Install Node.js, download it from: https://nodejs.org — if you already have Node, it needs version 18 or above.

4. If you have a nice new shiny clickable Node.js icon on your desktop or menu, don’t click it. You don’t need to. That’s for something else. Do this:

Install the tool

If updating from an earlier version, see "Manual software update" below.

1. On Windows, double-click the "install_win" file to install. This will open a command prompt, install the software dependencies and then close. Or, install manually with the steps below.

2. On Linux, Mac, open your Terminal app.
   On Windows, your “Command Prompt”.

3. Inside the terminal, change directory (“cd”) to the unzipped “civitai-sync” folder. Ensure this matches the name and location on your system. For example:
cd Downloads/civitai-sync

   On Windows, use backslashes, not forward-slashes, e.g:
cd C:\Downloads\civitai-sync

4. Install the software dependencies by typing:
   npm run setup

Run the tool

Now you can run the program.

On Windows:

1. Double-click the "Civitai-Sync" file.

2. To add it as a Desktop shortcut icon, right-click on it > "Send to" > "Desktop (create shortcut)".

On Linux, Mac, or Windows:

1. In the terminal app, change directory ("cd”) to the program folder, as above.

2. Run it by typing:
   npm run cli

Manual software update (optional)

Since v4, software updates are automatically detected. When a new version is released, you will see an option to install the update.

If you want to manually upgrade:

1. Download the zip file, unzip it.

2. Copy the unzipped files into your existing “civitai-sync” program folder, overwriting the older files.

3. In the terminal app, change directory ("cd”) to the program folder.

4. Type: “npm run setup”.
On Windows, double-click on “install_win”.

Create an API key

For access to your account, you need a Civitai API key.

1. In Account Settings, see “API Keys” near the bottom of the page: https://civitai.com/user/account

2. Click “Add API key”. Name it, e.g. “civitai-sync”. Click “Save”.
   

3. You will be shown the key only once > Copy it.

4. In civitai-sync, choose "Set API key", and paste the key.

(To paste, right-click > "Paste", or press "Ctrl+V" or "Ctrl+Shift+V")

Password protection

You can set a password to encrypt your API key, e.g. if you are on a shared computer. You'll enter the password each time you run the program. Or press "Enter" for no password.

Start Downloading

If your API key is saved, you can choose "Download generations" and "Download posts".

See “Options” to change what is download and where it is saved.
Download Location: inside the program folder in "data" and "media"; you can change to another location.
Choose: to make folders for your ❤️ favorited and 👍 liked gens, or to download only data.

Latest: download your most recent creations.
Or download just “Favorite / Liked” gens.

Open the Explorer

☞ Click "Start Explorer"

Data

Data is saved directly from Civitai's API, as text files (in “JSON” format). Prompts and metadata are already embedded in the media metadata (e.g. "EXIF" format).

You can explore the generation parameters and details for images and videos, in the civitai-sync Explorer.

Multiple accounts

The program is normally run as:
npm run cli


To download from an alternative account, specify a unique name for it:

npm run cli bob

Change the download directory to be different for each account, unless you want the data and media for the accounts to be merged.

Problems? Thoughts? Get in touch

Make a comment, start a chat.
@monkeypuzzle