This page allows you to figure out the steps and programs needed to compile your own version of Cider.
Recommended / Required Development Utilities
pnpm (Optional, but highly recommended)
Have an Apple Developer Account and be a member of the Apple Developer Program. This is necessary to play music through the app.
Basic Command Line Knowledge
While not required, PNPM is recommended for compiling Cider, and you can install it by using:
npm install -g pnpm
To remind you again, if you don't have an Apple Developer account to sign the Cider binary after building, it WILL NOT work.
Open a command prompt window in the directory you'd like Git to clone to and enter the following command
Optionally, if you'd like to use the Development branch of Cider to test upcoming features switch your branch by moving your terminal into the directory and using git to checkout the branch by entering the following commands
If you'd like to update your repository in the future to keep up to date, use the command (Make sure you're in the directory, you originally cloned in)
git pull
Now for the fun part, by using pnpm, npm or yarn (we'll be using pnpm in this case) enter the following command to automatically obtain all required dependencies for installation.
This step could take a little while on some machines.
What is this for? MacOS doesn't like development Widevine DRM keys for some reason. Therefore, we need to sign our own production keys here. This can be done as follows:
Remember your account name and password because you will need it later.
Once in a while, you may need to re-authenticate the VMP account. If that is the case:
In Xcode: Under Xcode > Preferences (⌘,) > Accounts, you may add your Apple ID. With your team selected, the View Details... in the bottom right could find you the available certificates for generation/download.
After that, select all of the certificates in Keychain Access to generate as a .p12 file. Remember the file location and the .p12 password.
Generate the app-specific password of your Apple Developer account
You can set the environment variables permanently by edit the ~/.bash-profile file and add the above lines at the bottom of the file.
Electron-Packager doesn't like MacOS notarization. You need to manually patch the files in order for it to work properly:
This step takes a little while on the first compilation so bear with it as it does what it needs to do.
This will generate a universal signed and notarized binary. (Don't mind the "not working" command line, it works)
On some low-end machines this process could take up to ~20-30 minutes. (It will look like it hangs at the notarization part, don't exit it).
Your new Cider installation setup file is ready for you! You can find your setup executable in your cloned folder directory on your system in the subfolder dist/ and from there you'll see your new Setup file.
Congrats! You've successfully compiled your own build of Cider!
This page allows you to figure out the steps and programs needed to compile your own version of Cider.
Recommended / Required Development Utilities
pnpm (Optional, but highly recommended)
Basic Command Line Knowledge
While not required, PNPM is recommended for compiling Cider, and you can install it by using:
npm install -g pnpm
Open a terminal window in the directory you'd like Git to clone to and enter the following command
Optionally, if you'd like to use the Development branch of Cider to test upcoming features switch your branch by moving your terminal into the directory and using git to checkout the branch by entering the following commands
If you'd like to update your repository in the future to keep up to date, use the command (Make sure you're in the directory, you originally cloned in)
git pull
Now for the fun part, by using pnpm, npm or yarn (we'll be using pnpm in this case) enter the following command to automatically obtain all required dependencies for installation.
This step could take a little while on some machines.
This step takes a little while on the first compilation so bear with it as it does what it needs to do.
Compiling Cider for specific CPU architectures is a smart thing to do and you can do it by adding switches to the dist argument as displayed.
On some low-end machines this process could take up to ~10 minutes.
This command would build three separate packages of Cider, AppImage, .deb, and .snap packages
If you are on an arch-based Linux distribution and have an AUR helper (pacman/yay/paru/etc.), then you are in luck. Cider has 2 PKGBUILD's in the Arch User Repository.
Assuming you already have access to the AUR and have a friendly AUR helper (we will use yay for this example) enter the following command to automatically obtain all required dependencies for installation.
If you like to live on the bleeding edge, use the cider-git package, this will compile directly from the main branch.
Running this on Node.js 17 or later will fail. This is due to Node.js 17 no longer writing openssl_fips to config.gypi so it's not there in Node.js 17's process.config. It is suggested to downgrade to nodejs-lts-gallium to resolve this issue.
Your new Cider installation setup file is ready for you! You can find your setup executable in your cloned folder directory on your system in the subfolder dist/ and from there you'll see your new Setup files. Choose the installer that best matches your distro.
Congrats! You've successfully compiled your own build of Cider!
This page allows you to figure out the steps and programs needed to compile your own version of Cider.
Recommended / Required Development Utilities
Basic Command Line Knowledge
While not required, PNPM is recommended for compiling Cider, and you can install it by using:
npm install -g pnpm
You need windows-build-tools to be able to compile the native modules Cider uses for Windows. It should be installed with Node.js through the chocolatey package manager. If the installation fails you can install it using pnpm/npm in an administrator powershell/cmd window and entering:
pnpm install -g windows-build-tools
or
npm install -g windows-build-tools
Open a command prompt window in the directory you'd like Git to clone to and enter the following command
Optionally, if you'd like to use the Development branch of Cider to test upcoming features switch your branch by moving your terminal into the directory and using git to checkout the branch by entering the following commands
If you'd like to update your repository in the future to keep up to date, use the command (Make sure you're in the directory, you originally cloned in)
git pull
Now for the fun part, by using pnpm, npm or yarn (we'll be using pnpm in this case) enter the following command to automatically obtain all required dependencies for installation.
This step could take a little while on some machines.
This step takes a little while on the first compilation so bare with it as it does what it needs to do.
Compiling Cider for specific CPU architectures is a smart thing to do and you can do it by adding switches to the dist argument as displayed.
On some low-end machines this process could take up to ~5 minutes.
Your new Cider installation setup file is ready for you! You can find your setup executable in your cloned folder directory on your system in the subfolder dist/ and from there you'll see your new Setup file.
Congrats! You've successfully compiled your own build of Cider!
(Optional, but highly recommended)