HELLO TOOLFORGE

Introduction

This project is an example implementation of a ToolForge tool in Java. It uses the ToolForge Maven plugin to generate its argument parser from its manifest and the toolforge4j library for QOL. It also uses the excellent Fabric8 Docker Maven plugin to build its Docker container for pushing into ToolForge.

This "Hello Toolforge" template is released FREE TO USE under the Apache 2.0 License for building ToolForge tools. Tool developers may choose their own licenses for their tools, including closed source.

Building

Simply running the following command will generate the required Docker image:

mvn clean compile install

Note that this example also includes GitHub actions for CI/CD.

Creating Your Own Tool

To adapt this example into a real tool, the user should:

1. Create a ToolForge account and create a new container. Call it whatever you like! Note the container's container location and ID.
2. Update the POM to reflect the tool's real GAV, SCM, ToolForge tool path, target package, main class, and so on.
3. Update the Dockerfile to reflect the container's name and environment.
4. Update the manifest to reflect the tool's inputs, outputs, and parameters.
5. Write the code to implement the tool.
6. Build, push, and run in ToolForge!