Seed4J CLI

Description

Seed4J CLI is a command-line interface tool that helps you apply and manage Seed4J modules. It provides a modular approach to application generation, allowing you to select specific modules and features for your project. Visit Seed4J to learn more about it.

Quick Start

You need to clone this project and go into the folder:

git clone https://github.com/seed4j/seed4j-cli
cd seed4j-cli

Install seed4j command in your bin folder:

./mvnw clean package && echo "java -jar \"/usr/local/bin/seed4j.jar\" \"\$@\"" | sudo tee /usr/local/bin/seed4j > /dev/null && sudo chmod +x /usr/local/bin/seed4j && JAR_SOURCE=$(ls target/seed4j-cli-*.jar | head -n 1) && [ -n "$JAR_SOURCE" ] && sudo mv "$JAR_SOURCE" /usr/local/bin/seed4j.jar || echo "No JAR file found in target directory"

Then you can follow the Commands Guide

Prerequisites

Java

You need to have Java 21:

• JDK 21

Node.js and NPM

Before you can build this project, you must install and configure the following dependencies on your machine:

Node.js: We use Node to run a development web server and build the project. Depending on your system, you can install Node either from source or as a pre-packaged bundle.

After installing Node, you should be able to run the following command to install development tools. You will only need to run this command when dependencies change in package.json.

npm install

Local environment

Start up

./mvnw

Install CLI Command

./mvnw clean package

echo "java -jar \"/usr/local/bin/seed4j.jar\" \"\$@\"" | sudo tee /usr/local/bin/seed4j > /dev/null

# Make the script executable
sudo chmod +x /usr/local/bin/seed4j

# Find the JAR file in the target directory and move it as seed4j.jar
JAR_SOURCE=$(ls target/seed4j-cli-*.jar | head -n 1)
if [ -n "$JAR_SOURCE" ]; then
  sudo mv "$JAR_SOURCE" /usr/local/bin/seed4j.jar
else
  echo "No JAR file found in target directory"
fi

Copy and paste the above script into a terminal to install the seed4j command.

You can use a single command:

./mvnw clean package && echo "java -jar \"/usr/local/bin/seed4j.jar\" \"\$@\"" | sudo tee /usr/local/bin/seed4j > /dev/null && sudo chmod +x /usr/local/bin/seed4j && JAR_SOURCE=$(ls target/seed4j-cli-*.jar | head -n 1) && [ -n "$JAR_SOURCE" ] && sudo mv "$JAR_SOURCE" /usr/local/bin/seed4j.jar || echo "No JAR file found in target directory"

Usage

After the installation, you can use the seed4j with help command to know the options:

seed4j --help

Documentation

• Commands Guide
• Hexagonal architecture
• Package types
• Assertions
• sonar