Keiko Tools

About

Keiko Tools is a collection of programs that help you manage Keiko or audit your servers' security. All tools are shipped inside the Keiko executable (keiko.jar).

Usage

To run a Keiko tool, simply run the Keiko executable just like you do it to start your server (proxy). But after -jar keiko.jar, instead of the path to the proxied executable (for example, spigot-1.16.5.jar), write tool:tool_name.

For example, to run Keiko tool with name clean (more information about it below), use:

java -jar keiko.jar tool:clean

Note that some tools expect additional arguments. Put those after tool name: ... tool:tool_name arg-1 arg-2 ... arg-N. For example,

java -jar keiko.jar tool:code /home/me/some-argument-file.jar

Available tools

Click on the tool name for more information and use cases.

• clean
• code

Notes

Running a Keiko tool is treated almost like an ordinary server startup (Keiko proxy). This means that:

• Keiko will check for updates,
• Keiko will generate its working directory if it did not exist yet and will install any missing configuration files,
• Keiko will use the configurations and caches from its working directory for standalone inspections and everything else, and
• all Keiko Tools logs will be saved just like ordinary Keiko logs.