Civitai Link Desktop

Manage and interact with your StableDiffusion instance right from Civitai

Table of Content

• Recommended IDE Setup
• Project Setup
  • Install
  • Development
  • Build
• FAQ
• Contributing
• License

Recommended IDE Setup

• VSCode + ESLint + Prettier

Project Setup

Install

$ npm install

Development

$ npm run dev

Build

# For windows
$ npm run build:win

# For macOS
$ npm run build:mac

# For Linux
$ npm run build:linux

FAQ

What the Civitai Link Key? Where do I get it?

The Civitai Link Key is a short 6 character token that you'll receive when setting up your Civitai Link instance (you can see it referenced here in this Civitai Link installation video). The Link Key acts as a temporary secret key to connect your Stable Diffusion instance to your Civitai Account inside our link service.

Since Civitai Link is still in alpha, it is currently only available to Supporters as part of the Civitai Early Access program. You can get access to Civitai Link today by becoming a supporter 🥰 or you can wait until we've gotten it to a state that we're ready for a full release.

Filing an Issue

When filing an issue provide as much replication and detail as possible. It can also help if you paste your app logs into your issue.

on Linux: ~/.config/{app name}/logs/main.log
on macOS: ~/Library/Logs/{app name}/main.log
on Windows: %USERPROFILE%\AppData\Roaming\{app name}\logs\main.log

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the repository to your own GitHub account.
2. Create a new branch for your changes.
3. Make your changes to the code.
4. Commit your changes and push the branch to your forked repository.
5. Open a pull request on our repository.

Hop into the development channel in our Discord server and let's chat!

License

Apache License 2.0 - Please have a look at the LICENSE for more details.