Install spring-cli

Linux and macOS

Run the installer to download the binary for your operating system and CPU:

curl -fsSL https://raw.githubusercontent.com/josecamporivas/springboot-cli/refs/heads/main/install.sh | sh

The installer verifies the release asset against its published SHA-256 checksum and installs it to ~/.local/bin by default. It supports Linux and macOS on x64 and ARM64.

The installer requires curl and either sha256sum or shasum for checksum verification.

If prompted, or if spring-cli is not found, add the install directory to your PATH:

export PATH="$HOME/.local/bin:$PATH"

To choose a release or install directory, set SPRING_CLI_VERSION and/or SPRING_CLI_INSTALL_DIR:

curl -fsSL https://raw.githubusercontent.com/josecamporivas/springboot-cli/refs/heads/main/install.sh \
  | SPRING_CLI_VERSION=v1.0.0 SPRING_CLI_INSTALL_DIR="$HOME/bin" sh

The installer adds a leading v to SPRING_CLI_VERSION when it is omitted. Replace v1.0.0 with the release tag you want to install.

Windows

Download spring-cli-v<version>-windows-x64.exe from GitHub Releases. Add its directory to your user PATH; you can rename the downloaded file to spring-cli.exe for convenience.

Verify the installation

Open a new terminal and run:

spring-cli --version
spring-cli --help

The native CLI does not need Bun, Node.js, or a JVM installed. You will need a supported JDK to build or run the Spring Boot projects it creates.

Build the CLI from source

If you prefer to compile the executable yourself, install Bun, clone the repository, and build:

git clone https://github.com/josecamporivas/springboot-cli.git
cd springboot-cli
bun install
bun run build

The command creates a spring-cli executable in the repository root. See shell completions to enable tab completion after installation.