Spring Shell Utils

Spring Shell Utils library provides extra features to help develop Spring Shell applications.

License

License

Categories

Categories

Net
GroupId

GroupId

net.griffiti
ArtifactId

ArtifactId

spring-shell-utils
Last Version

Last Version

1.0.4
Release Date

Release Date

Type

Type

jar
Description

Description

Spring Shell Utils
Spring Shell Utils library provides extra features to help develop Spring Shell applications.
Project URL

Project URL

https://github.com/griffiti/spring-shell-utils
Source Code Management

Source Code Management

https://github.com/griffiti/spring-shell-utils

Download spring-shell-utils

How to add to project

<!-- https://jarcasting.com/artifacts/net.griffiti/spring-shell-utils/ -->
<dependency>
    <groupId>net.griffiti</groupId>
    <artifactId>spring-shell-utils</artifactId>
    <version>1.0.4</version>
</dependency>
// https://jarcasting.com/artifacts/net.griffiti/spring-shell-utils/
implementation 'net.griffiti:spring-shell-utils:1.0.4'
// https://jarcasting.com/artifacts/net.griffiti/spring-shell-utils/
implementation ("net.griffiti:spring-shell-utils:1.0.4")
'net.griffiti:spring-shell-utils:jar:1.0.4'
<dependency org="net.griffiti" name="spring-shell-utils" rev="1.0.4">
  <artifact name="spring-shell-utils" type="jar" />
</dependency>
@Grapes(
@Grab(group='net.griffiti', module='spring-shell-utils', version='1.0.4')
)
libraryDependencies += "net.griffiti" % "spring-shell-utils" % "1.0.4"
[net.griffiti/spring-shell-utils "1.0.4"]

Dependencies

compile (11)

Group / Artifact Type Version
org.springframework : spring-core jar 5.3.5
org.springframework : spring-beans jar 5.3.5
org.springframework.shell : spring-shell-core jar 2.0.1.RELEASE
org.springframework.shell : spring-shell-standard jar 2.0.1.RELEASE
org.springframework.shell : spring-shell-standard-commands jar 2.0.1.RELEASE
org.springframework.shell : spring-shell-table jar 2.0.1.RELEASE
org.jline : jline jar 3.19.0
org.jline : jline-terminal jar 3.19.0
de.vandermeer : asciitable jar 0.3.2
com.fasterxml.jackson.core : jackson-core jar 2.12.2
com.fasterxml.jackson.core : jackson-databind jar 2.12.2

Project Modules

There are no modules declared in this project.

Spring Shell Utils Maven Central

Introduction

Spring Shell Utils library provides extra features to help develop Spring Shell applications.

Features

  • Custom exit command with forced system exit. This is useful when shell commands include reactive code with unexpired threads.
  • Progress bar and counter utils for updating user during long running processes.
  • Progress services with managed threads for progress notifications during long running processes with non deterministic progress.
  • Shell helper for colored output, cursor and line control, and programmatic screen clearing.
  • Custom startup banner support.
  • Custom prompt support.
  • Many options can be configured via application.(yml|properties) file.

Getting Started

This project is built with maven and is published to Maven Central. To get started you can either include as a maven dependency or clone this repo and build locally.

Maven

Including as a maven dependency is the quickest and easiest way to get started. Just edit your pom.xml file and add the following to your dependencies section.

<dependencies>
  ...
  <dependency>
    <groupId>net.griffiti</groupId>
    <artifactId>spring-shell-utils</artifactId>
    <version>1.0.4</version>
  </dependency>
</dependencies>

Clone Locally

You can also clone this repo locally and build the package. You can then reference the jar file or install to your local maven repo.

git clone https://github.com/griffiti/spring-shell-utils.git
cd spring-shell-utils
mvn clean install -DskipTests

Project Origin

This project was inspired by the original work of Domagoj Madunic and the ag04-shell-utils project.

License

Spring Shell Utils is open source software released under the Apache 2.0 license.

Versions

Version
1.0.4
1.0.0