/
Install Kickstarter

Install Kickstarter

If you are part of the Pinuts team, we recommend using the internal UM kickstarter instead: https://pinutswiki.atlassian.net/wiki/spaces/UMPRJ/pages/4225400846

This section describes how to install UM Kickstarter on Linux, MacOS or Windows with WSL2. https://pinutswiki.atlassian.net/wiki/spaces/UMDOC/pages/3941171205 covers Windows environments without WSL2.

Install JDK and gradle

You will need a laptop or desktop with Linux, MacOS or Windows with Windows subsystem for Linux) with at least the following software installed:

  • Oracle JDK or OpenJDK 17 or newer

  • gradle >= 7.3 and groovy 2, 3 or 4 which can be installed using SDKMAN

  • git command line tools

  • Visual Studio Code or any other programming editor / IDE of your choice; however, we recommend using VSCode

Of course, a windows machine with a Linux VM on top will do as well.

Install Pinuts Dev Tools / Scripts

Clone the following git repository:

git clone https://gitext.pinuts.de/um-public/devtools.git ~/.pinuts-devtools

... and include the ~/.pinuts-devtools/bin/ directory in your $PATH variable. There is a helper script to do just that in case you are using bash:

(cd ~/.pinuts-devtools && make bash)

Access to Pinuts maven repository

After having received your credentials for the Pinuts maven repository you should set some environment variables; e.g. in your ~/.bashrc file:

export PINUTS_MAVENREPO_USERNAME=<access-key-id> export PINUTS_MAVENREPO_PASSWORD=<secret-value>

umkickstarter

The freshly installed shell script ~/.pinuts-devtools/bin/umkickstarter creates a new directory (default: ./umkickstarter) and prepares the directory and file structure needed to start developing a new UM project:

umkickstarter my-um-app

Optionally you can pass the package name of an UM plugin that should be scaffolded as well:

umkickstarter my-um-app --name acme.myumapp

License

After having received your development UM license, copy the file to env/devel/cmsbs-conf/cmsbs.license.

Next steps…

Read more about the Kickstarter: Kickstarter.md

Note on Symlink Creation under Windows

When running Gradle tasks that create symbolic links (e.g. during UM setup), Windows may fail with the following error:

java.nio.file.FileSystemException: [...] Dem Client fehlt ein erforderliches Recht java.nio.file.FileSystemException: [...] A required privilege is not held by the client

This happens because by default, creating symbolic links requires administrative privileges. To resolve this:

  1. Enable Developer Mode:

    • Open Settings → Privacy & Security → For Developers and enable Developer Mode.

    • Log out and back in. Non-admin users can now create symlinks.

  2. or run your terminal as Administrator: Start PowerShell or CMD with elevated rights and rerun the Gradle build.

  3. Alternatively, grant your user account the right to create symbolic links:

    • Run secpol.msc → Local Policies → User Rights Assignment → Create symbolic links → add your user.