https://github.com/spacebanana420/yuuka
Fast build tool for Java Projects
https://github.com/spacebanana420/yuuka
build-tool cli development java jdk
Last synced: 3 months ago
JSON representation
Fast build tool for Java Projects
- Host: GitHub
- URL: https://github.com/spacebanana420/yuuka
- Owner: spacebanana420
- License: mit
- Created: 2024-09-13T18:09:39.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-24T18:21:21.000Z (11 months ago)
- Last Synced: 2025-07-24T23:07:11.515Z (11 months ago)
- Topics: build-tool, cli, development, java, jdk
- Language: Java
- Homepage:
- Size: 248 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Yuuka
Yuuka is a fast and lightweight build tool for building your Java projects from the CLI in a simple way. Yuuka implements the Java compiler and JAR management tool for building and packaging while it manages and cleans up your projects in a platform-agnostic way.
## Requirements
* Java 11 or newer
Yuuka currently requires that you have Java installed in your system (in your $PATH) to execute the Java compiler, JAR packager and Java runtime.
# Download and run
Download the [latest release](https://github.com/spacebanana420/yuuka/releases) and run it with `java -jar yuuka.jar`.
# How to use
With Yuuka, your projects should have a simple file structure such as:
```
/build # Mandatory, to store the compiled project
/lib # Optional, to store library JARs
/src # Mandatory, to store source code
/test # Optional, for writing and running tests
/build.yuuka # Optional, for configuring your project
/libs.yuuka # Optional, for fetching remote libraries
```
To start a new project, you can run `yuuka init` to create a new project structure.
To build your project and run it locally, you can run `yuuka build` and `yuuka run`. If you want to make an executable JAR, you can run `yuuka package`.
There are multiple CLI arguments that let you customize the build process, such as specifying the JAR name and main class, setting verbose or silent terminal output, setting the target Java release for your program, etc. Optionally, you can configure your projects declaratively from a build file too.
For the automatic main class detection to work, it's recommended that your main file is called "main.java", otherwise you can define the main class manually either from the CLI or in `build.yuuka`.
# Compile from source
### Using Yuuka
```
yuuka package
```
If you don't have Yuuka installed in your system, run instead:
```
java -jar yuuka.jar package
```
### Using Bash
```
mkdir build
bash build.sh
```
### In a Unix-like shell
```
mkdir build
javac src/yuuka/*.java src/yuuka/*/*.java -d build
cd build
jar cfe yuuka.jar yuuka/main yuuka/*.class yuuka/*/*.class
cd ..
```