https://github.com/spring-attic/spring-cli
A CLI focused on developer productivity
https://github.com/spring-attic/spring-cli
Last synced: 6 months ago
JSON representation
A CLI focused on developer productivity
- Host: GitHub
- URL: https://github.com/spring-attic/spring-cli
- Owner: spring-projects
- License: apache-2.0
- Created: 2022-05-09T23:06:33.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-27T03:24:10.000Z (over 1 year ago)
- Last Synced: 2025-03-27T15:56:21.685Z (10 months ago)
- Language: Java
- Homepage:
- Size: 2.65 MB
- Stars: 108
- Watchers: 7
- Forks: 43
- Open Issues: 70
-
Metadata Files:
- Readme: README.adoc
- Contributing: CONTRIBUTING.adoc
- License: LICENSE
Awesome Lists containing this project
README
= THIS REPOSITORY IS NO LONGER ACTIVELY MAINTAINED
= A CLI focused on developer productivity
* Note: this is a work in progress.
* https://docs.spring.io/spring-cli/reference/[Read the documentation] for info on *Installing* and *Getting Started*
== Build
NOTE: Use JDK17
Normal build without _native_:
```
./gradlew clean build
```
Which you can then run with:
```
java -jar build/libs/spring-cli-0.0.1-SNAPSHOT.jar
```
For native build:
```
./gradlew clean build nativeCompile -PspringCliNative=true
```
NOTE: You need to have `GRAALVM_HOME` pointing to your _graal_ installation
Which you can then run with:
```
build/native/nativeCompile/spring
```
TIP: There is a CI workflow which builds native binaries for linux, macos and windows.
Published artifacts in CI workflow will get removed daily so take it from
a latest run which is scheduled nightly.
=== Code Formatting
This project uses Spring Javaformat and is enabled by default.
Run individual tasks:
```
./gradlew checkFormat
./gradlew checkstyleMain
./gradlew checkstyleTest
./gradlew format
```
You can temporarily disable checks by setting property `springCliChecks` to `false`:
```
./gradlew build -PspringCliChecks=false
```
=== Building Documentation
```
./gradlew antora
```
Output is in `./docs/build/site/index.html`
For more information on the build see https://github.com/spring-projects-experimental/spring-cli/tree/docs-build[README in the docs-build branch].
=== Shell Completion
Shell completion for `bash` can be generated with `completion bash` command:
```
$ source <(spring completion bash)
```