rawg-shell

Command Line interface to the RAWG Video Games Database API.

Installation and Configuration

Prerequisites

• Java Runtime Environment (JRE) or Java Development Kit (JDK) v11 or higher
• RAWG API key obtained from RAWG.

API Key Configuration

Once ontained, set an OS Environment variable RAWG_API_KEY with the value. If missing an exception will be thrown and the process will terminate.

For Windows

Use the Windows Advanced System Settings -> Environments Variables interface.

For Linux

Add the following to your startup scripts:

export RAWG_API_KEY={yourapikey}

Download latest release

Navigate to the following Releases Page. Download the latest rawg-shell.jar file to your computer.

Running executable jar locally

Launch command prompt and change directory to target with JAR file.

java -jar rawg-shell.jar

Commands

game describe {Title or ID}

Retrieve full game information based on RAWG ID or title.

game export -i {input-filename} -o {output-filename}

Retrieve game information on multiple titles. The input-file should have one game title per line. The output-filename will contain results in comma-seperated-value format.

game search {query}

Search for games using full query syntax. Results shown on console.

Core Technology Stack

Technology	Description	Use
Spring Boot	REST Microservices Framework	Runtime
Spring Framework	Core Framework	Runtime
Spring Shell	Command Shell Framework	Runtime
Feign	Feign REST Client	Runtime
Jayway JsonPath	Json Path Expression Library	Runtime

Building from Source

rawg-shell uses a Apache Maven-based build system.

In the instructions below, mvnw is invoked from the root of the source tree and serves as a cross-platform, self-contained bootstrap mechanism for the build.

Prerequisites

Git and the JDK 11.

Be sure that your JAVA_HOME environment variable points to the jdk-11 folder extracted from the JDK download.

Check out sources

git clone https://github.com/rmkellogg/rawg-shell.git

Compile and test; build all jars, distribution zips, and docs

Linux

./mvnw clean package

Windows

mvnw clean package

Compile and SKIP tests; build all jars, distribution zips, and docs

Linux

./mvnw clean package -DskipTests=true

Windows

mvnw clean package -DskipTests=true

Installation and Configuration from Source Code

The target folder will contain Javadocs, a Zip file with all source code and the executable JAR file.

This project requires that you have an API key obtained from RAWG. Follow the instructions above to configure your environment.

Running executable jar locally

java -jar rawg-shell.jar

License

rawg-shell is Open Source software released under the Apache 2.0 license.