Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This file documents all notable changes to https://github.com/devonfw/IDEasy[IDE

Release with new features and bugfixes:

* https://github.com/devonfw/IDEasy/issues/1558[#1558]: Added installation log information to the "Select Project Folder" and exit dialogs and enhanced `windows-installer/README.adoc`.
* https://github.com/devonfw/IDEasy/issues/1056[#1056]: Improve MSI license display by generating formatted RTF from AsciiDoc
* https://github.com/devonfw/IDEasy/issues/2052[#2052]: Split issue statistics in 2 pie-charts
* https://github.com/devonfw/IDEasy/issues/822[#822] : Added Cwd path limit in shell
Expand Down
38 changes: 33 additions & 5 deletions documentation/setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,32 @@ Extract the contents of the downloaded archive (`ide-cli-*.tar.gz`) to a new fol

On MacOS please study link:mac-gatekeeper.adoc[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.
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 link:project.adoc[create a project].
As next step read the link:usage.adoc[usage].

=== Installation Logs (Windows MSI Installer)

The IDEasy MSI installer writes installation logs to:

----
%USERPROFILE%\.ide\logs
----

Each installation generates a new timestamped log file, for example:

----
install-2026-07-01_10-15-00.log
----

If the installation fails, check the most recent log file in this directory.
A note displaying the installation log location is also shown in the "Select Project Folder" dialog and in the exit dialog.

=== Tweak installation location

The easiest way is to use your $HOME directory as installation target (e.g. by extracting the download inside `~/Downloads`).
Expand Down Expand Up @@ -101,27 +121,35 @@ 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:
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

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}
```

In our example, if we wanted to download the mac version, the final URL would be https://central.sonatype.com/repository/maven-snapshots/com/devonfw/tools/IDEasy/ide-cli/2026.04.001-SNAPSHOT/ide-cli-2026.04.001-20260321.030716-2-mac-x64.tar.gz.

From there, we can download the artifact, extract and test it.
From there, we can download the artifact, extract and test it.
11 changes: 11 additions & 0 deletions windows-installer/Package.wxs
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,22 @@
<CustomAction Id="SetIDE_ROOT" Property="IDE_ROOT" Value="[ROOTDIRECTORY]projects" Execute="immediate" Return="check" />
<CustomAction Id="SetTEMP_FOLDER" Property="INSTALLFOLDER" Value="[IDE_ROOT]\_ide\tmp\ideasy" Execute="immediate" Return="check" />

<!-- On Exit-Dialog -->

<SetProperty
Id="WIXUI_EXITDIALOGOPTIONALTEXT"
Value="IDEasy installation logs are written to: [USERFOLDER].ide\logs"
Before="ExecuteAction"
Sequence="ui" />

<!-- Execution of install command-->
<SetProperty
Id="RunInstallAction"
Value='"[%SystemFolder]cmd.exe" /v:on /c "cd /d [INSTALLFOLDER] &amp;&amp; (if not exist "[%USERPROFILE]\.ide\logs" mkdir "[%USERPROFILE]\.ide\logs") &amp;&amp; set ts=%date:/=-%_%time::=-% &amp;&amp; set ts=!ts:,=-! &amp;&amp; bin\ideasy.exe -ftb --no-colors install &gt; "[%USERPROFILE]\.ide\logs\install-!ts!.log" 2&gt;&amp;1"'
Before="RunInstallAction"
Sequence="execute"
/>

<CustomAction
Id="RunInstallAction"
BinaryRef="Wix4UtilCA_X64"
Expand Down Expand Up @@ -72,5 +81,7 @@

<!-- Custom UI Reference -->
<ui:WixUI Id="WixUI_InstallDirCustom" InstallDirectory="INSTALLFOLDER" />


</Package>
</Wix>
3 changes: 3 additions & 0 deletions windows-installer/WixUI_IDEasySetup.wxs
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@
<Control Id="Cancel" Type="PushButton" X="304" Y="243" Width="56" Height="17" Cancel="yes" Text="!(loc.WixUICancel)">
<Publish Event="SpawnDialog" Value="CancelDlg" />
</Control>

<Control Id="InstallLogInfoText" Type="Text" X="20" Y="170" Width="320" Height="30" Transparent="no" NoPrefix="yes" Text="We will write an install log to: [USERFOLDER].ide\logs"/>

</Dialog>
</UI>
</Fragment>
Expand Down
Loading