GitHub - spring-attic/spring-cloud-cli: Spring Cloud CLI features · GitHub
Skip to content You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert This repository was archived by the owner on Apr 21, 2026. It is now read-only. Branches Tags Open more actions menu Latest commit History 541 Commits 541 Commits Folders and files Name Name Last commit message Last commit date .circleci .circleci .github .github .mvn .mvn docs docs spring-cloud-cli-integration-tests spring-cloud-cli-integration-tests spring-cloud-cli spring-cloud-cli spring-cloud-launcher spring-cloud-launcher .gitignore .gitignore .settings.xml .settings.xml Guardfile Guardfile LICENSE.txt LICENSE.txt README.adoc README.adoc mvnw mvnw mvnw.cmd mvnw.cmd pom.xml pom.xml Repository files navigation Spring Cloud CLI project is no longer maintained See blog post or release notes for more information Spring Boot CLI provides Spring Boot command line features for Spring Cloud .
You can write Groovy scripts to run Spring Cloud component applications (e.g. @EnableEurekaServer ). You can also easily do things like encryption and decryption to support Spring Cloud Config clients with secret configuration values. With the Launcher CLI you can launch services like Eureka, Zipkin, Config Server conveniently all at once from the command line (very useful at development time). Installation To install, make sure you have Spring Boot CLI (2.0.0 or better): $ spring version Spring CLI v2.2.3.RELEASE E.g. for SDKMan users $ sdk install springboot 2.2.3.RELEASE $ sdk use springboot 2.2.3.RELEASE and install the Spring Cloud plugin $ mvn install $ spring install org.springframework.cloud:spring-cloud-cli:2.2.0.RELEASE Important Prerequisites: to use the encryption and decryption features you need the full-strength JCE installed in your JVM (it’s not there by default).
You can download the "Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files" from Oracle, and follow instructions for installation (essentially replace the 2 policy files in the JRE lib/security directory with the ones that you downloaded). Building Basic Compile and Test To build the source you will need to install JDK 17. Spring Cloud uses Maven for most build-related activities, and you should be able to get off the ground quite quickly by cloning the project you are interested in and typing $ ./mvnw install Note You can also install Maven (>=3.3.3) yourself and run the mvn command in place of ./mvnw in the examples below.
If you do that you also might need to add -P spring if your local Maven settings do not contain repository declarations for spring pre-release artifacts. Note Be aware that you might need to increase the amount of memory available to Maven by setting a MAVEN_OPTS environment variable with a value like -Xmx512m -XX:MaxPermSize=128m . We try to cover this in the .mvn configuration, so if you find you have to do it to make a build succeed, please raise a ticket to get the settings added to source control.
The projects that require middleware (i.e. Redis) for testing generally require that a local instance of [Docker]( https://www.docker.com/get-started ) is installed and running. Documentation The spring-cloud-build module has a "docs" profile, and if you switch that on it will try to build asciidoc sources from src/main/asciidoc . As part of that process it will look for a README.adoc and process it by loading all the includes, but not parsing or rendering it, just copying it to ${main.basedir} (defaults to ${basedir} , i.e. the root of the project).
If there are any changes in the README it will then show up after a Maven build as a modified file in the correct place. Just commit it and push the change. Working with the code If you don’t have an IDE preference we would recommend that you use Spring Tools Suite or Eclipse when working with the code. We use the m2eclipse eclipse plugin for maven support. Other IDEs and tools should also work without issue as long as they use Maven 3.3.3 or better.
Activate the Spring Maven profile Spring Cloud projects require the 'spring' Maven profile to be activated to resolve the spring milestone and snapshot repositories. Use your preferred IDE to set this profile to be active, or you may experience build errors. Importing into eclipse with m2eclipse We recommend the m2eclipse eclipse plugin when working with eclipse. If you don’t already have m2eclipse installed it is available from the "eclipse marketplace".
Note Older versions of m2e do not support Maven 3.3, so once the projects are imported into Eclipse you will also need to tell m2eclipse to use the right profile for the projects. If you see many different errors related to the POMs in the projects, check that you have an up to date installation. If you can’t upgrade m2e, add the "spring" profile to your settings.xml . Alternatively you can copy the repository settings from the "spring" profile of the parent pom into your settings.xml .
Importing into eclipse without m2eclipse If you prefer not to use m2eclipse you can generate eclipse project metadata using the following command: $ ./mvnw eclipse:eclipse The generated eclipse projects can be imported by selecting import existing projects from the file menu. Contributing Spring Cloud is released under the non-restrictive Apache 2.0 license, and follows a very standard Github development process, using Github tracker for issues and merging pull requests into master.
If you want to contribute even something trivial please do not hesitate, but follow the guidelines below. Sign the Contributor License Agreement Before we accept a non-trivial patch or pull request we will need you to sign the Contributor License Agreement . Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do.
Active contributors might be asked to join the core team, and given the ability to merge pull requests. Code of Conduct This project adheres to the Contributor Covenant code of conduct . By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io . Code Conventions and Housekeeping None of these is essential for a pull request, but they will all help.
They can also be added after the original pull request but before a merge. Use the Spring Framework code format conventions. If you use Eclipse you can import formatter settings using the eclipse-code-formatter.xml file from the Spring Cloud Build project. If using IntelliJ, you can use the Eclipse Code Formatter Plugin to import the same file. Make sure all new .java files to have a simple Javadoc class comment with at least an @author tag identifying you, and preferably at least a paragraph on what the class is for.
Add the ASF license header comment to all new .java files (copy from existing files in the project) Add yourself as an @author to the .java files that you modify substantially (more than cosmetic changes). Add some Javadocs and, if you change the namespace, some XSD doc elements. A few unit tests would help a lot as well — someone has to do it. If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
When writing a commit message please follow these conventions , if you are fixing an existing issue please add Fixes gh-XXXX at the end of the commit message (where XXXX is the issue number). Checkstyle Spring Cloud Build comes with a set of checkstyle rules. You can find them in the spring-cloud-build-tools module. The most notable files under the module are: spring-cloud-build-tools/ └── src ├── checkstyle │ └── checkstyle-suppressions.xml (3) └── main └── resources ├── checkstyle-header.txt (2) �
The rest of this page is on the live site.