Skip to content

setup.adoc

Latest commit

 

History

History
127 lines (89 loc) · 6.46 KB

setup.adoc

File metadata and controls

127 lines (89 loc) · 6.46 KB
Table of Contents

Setup

Quick Install

The fastest way to install IDEasy is the following one-line command for bash (use git-bash on Windows):

bash -c "$(curl -fsSL https://raw.githubusercontent.com/devonfw/IDEasy/main/install.sh)"

This will auto-detect your OS and architecture, download the latest release, and run setup. If you prefer a manual installation feel free to read-one.

Prerequisites

We try to make it as simple as possible for you. However, there are some minimal prerequisites:

  • Unless you use the MSI installer for Windows, you need to have a tool to extract *.tar.gz files (tar and gzip). On Windows before Version 10 (1803) use 7-zip. On all other platforms this comes out of the box.

  • You need to have git.

    • On Windows you only need to download and install git for windows.

    • On Linux you might need to install the git in case it is not present (e.g. sudo apt-get install git or sudo yum install git-core)

    • On MacOS you only need to download and install git for mac.

Download

The latest release of IDEasy can be downloaded from here.

Install

Extract the contents of the downloaded archive (ide-cli-*.tar.gz) to a new folder and run setup in this folder (on windows double-click on setup.bat).

On MacOS please study Gatekeeper problem and workaround in order to use IDEasy.

On Linux, run ./setup to install. Your current terminal session will not recognize the ide command immediately. To enable it, run source ~/.bashrc (or your shell config). Alternatively, open a new terminal window to load the configuration automatically. For any other existing terminal sessions, you must run the source command manually in each.

Once installed, you want to create a project. As next step read the usage.

Tweak installation location

The easiest way is to use your $HOME directory as installation target (e.g. by extracting the download inside ~/Downloads). In case your $HOME path contains whitespaces or special characters or you want to have your installation on a different partition (e.g. with more disc-space), special care is required. On windows simply create top-level folder like projects on the drive you want to install to (e.g. D:) and extract and install from there. On Linux or Mac you should always install to ~/projects but you may create a projects folder on a partition of your choice and create a symlink to it:

mkdir projects
ln -s $PWD/projects ~/projects
cd ~/projects
tar xvfz ~/Downloads/ide-cli-*.tar.gz
source setup

Uninstall

To "uninstall" your IDEasy you only need to call the following command:

ide uninstall

Then you can delete the projects folder if there is no project data left that you need.

IDEasy is designed to be non-invasive to your operating system and computer. Therefore it is not "installed" on your system in a classical way. Instead you just create a folder and extract the downloaded archive to it. All the other software remain locally in your IDEasy folder. However, there are the following excuses (what is reverted by ide uninstall):

  • The ide alias is added to your shell config (~/.bashrc and ~/.zshrc, search for: alias ide=).

  • The completion is added to your shell config (~/.bashrc and ~/.zshrc, search for: _ide/completion).

  • The IDE_ROOT environment variable is added to your environment variables.

  • The $IDE_ROOT/_ide/bin folder is added to your PATH environment variable.

  • IDEasy will download all third party software to your ~/Downloads/ide folder to reduce redundant storage. You have to delete this folder manually as we do not want to be responsible for data-loss in case users manually put files here.

Testing SNAPSHOT releases

Whenever a story in IDEasy is completed by merging a PR, our github actions will build a new SNAPSHOT release and on success deploy it to maven central portal. In order to install and test the latest SNAPSHOT version use the following command:

ide upgrade --mode=snapshot

If you test the latest SNAPSHOT please also give feedback to bug or feature tickets to let us know if things are working or not. Thanks for your testing, support and help to make IDEasy better!

Note
 After you completed your test or the next official release has been shipped please do not forget to switch back to the stable release channel. 
ide upgrade --mode=stable

Downloading SNAPSHOT releases manually

It is also possible to download IDEasy SNAPSHOT releases manually - including for other platforms. This may be useful to verify if SNAPSHOT releases for other platforms include an expected file or not. However, please note that this is a manual process containing multiple steps:

First, identify the latest SNAPSHOT version by going to https://central.sonatype.com/repository/maven-snapshots/com/devonfw/tools/IDEasy/ide-cli/maven-metadata.xml. The latest version will be indicated by the <latest> tag. For example, if the file would include

<latest>2026.04.001-SNAPSHOT</latest>

the latest SNAPSHOT version would be 2026.04.001-SNAPSHOT.

Next, we add the latest identified version into the following URL:

https://central.sonatype.com/repository/maven-snapshots/com/devonfw/tools/IDEasy/ide-cli/${latest_version}/maven-metadata.xml

In our example, the URL would be https://central.sonatype.com/repository/maven-snapshots/com/devonfw/tools/IDEasy/ide-cli/2026.04.001-SNAPSHOT/maven-metadata.xml. On this page you can find the artifacts of the latest SNAPSHOT release for each platform supported by IDEasy.

Lastly, we obtain a download link of the SNAPSHOT version for our desired platform by constructing a final URL:

https://central.sonatype.com/repository/maven-snapshots/com/devonfw/tools/IDEasy/ide-cli/${latest_version}/ide-cli-${version.value}-${version.classifier}.${version.extension}

From there, we can download the artifact, extract and test it.