Installation

Installation Guide

This guide covers the installation of the Compose for Desktop Wizard desktop client on all supported platforms.

System Requirements

Minimum Requirements

• Java: 17 or later

Java Installation

The desktop client requires Java 17 or later. Check your Java version:

java -version

If Java is not installed or version is below 17, download from Oracle.

Quick Java Installation

Ubuntu/Debian:

sudo apt update
sudo apt install openjdk-17-jre

Windows: Download installer from Oracle and follow the setup wizard.

Desktop Client Installation

Linux Installation

Option 1: Debian Package (Recommended)

Download the .deb file from the release page:

# Download and install
wget https://github.com/zahid4kh/compose-for-desktop/releases/download/1.0.1/composefordesktop_1.0.1_all.deb
sudo dpkg -i composefordesktop_1.0.1_all.deb

# Fix dependencies if needed
sudo apt install -f

Features of DEB installation:

• System-wide installation
• Desktop menu integration
• Application launcher icon
• Automatic file associations
• Clean uninstall via package manager

To launch after installation:

composefordesktop
# Or from your applications menu

To uninstall:

sudo apt remove composefordesktop

Option 2: JAR File

For other Linux distributions or manual installation:

# Download JAR file
wget https://github.com/zahid4kh/compose-for-desktop/releases/download/1.0.1/composefordesktop-1.0.1.jar

# Run
java -jar composefordesktop-1.0.1.jar

Windows Installation

1. Download composefordesktop-1.0.1.jar from releases
2. Open Command Prompt or PowerShell
3. Navigate to download location
4. Run the application:

java -jar composefordesktop-1.0.1.jar

macOS Installation

1. Download composefordesktop-1.0.1.jar from releases
2. Navigate to download location
3. Run the application:

java -jar composefordesktop-1.0.1.jar

Troubleshooting Installation

Java Not Found

Error: java: command not found or Java not installed

Solution: Install Java 17+ and ensure it's in your system PATH:

# Check Java installation
which java
java -version

# On Linux set JAVA_HOME
export JAVA_HOME=/usr/lib/jvm/java-17-openjdk
export PATH=$JAVA_HOME/bin:$PATH

Updates

To update to a newer version:

1. DEB Package: Download and install new .deb file (will upgrade existing installation)
2. JAR File: Download a new JAR file and replace the old one
3. Check for updates: Visit the release page for the latest version

Uninstallation

Linux (DEB Package)

sudo apt remove composefordesktop

Linux/Windows/macOS (JAR File)

Simply delete the downloaded JAR file and any created shortcuts.

---

Need help? Check the Troubleshooting guide or create an issue on GitHub.