View on GitHub RESTX     the lightweight Java REST framework
Improve This Page

Install

Installing RESTX is very straightforward as soon as you have a Oracle Java 7 JDK properly installed on your machine.

Note that installing RESTX is not necessary to use it, you can also manually setup your Java app to use RESTX.

Windows

Installation can be done in 3 simple steps:

  • download the package (either as a zip or tar.gz, though we recommend zip for Windows)
  • unpack the package in the directory of your choice, preferably a directory without a space. Beware, the package has no root directory. Example of installation directory: c:\dev\tools\restx, c:\restx
  • add the directory to your PATH (HowTo)
  • open a terminal and run restx, you should be welcomed with a prompt like this one:
===============================================================================
== WELCOME TO RESTX SHELL - 0.34.1 - type `help` for help on available commands
===============================================================================

Linux / Mac OS

Super easy / Single command way

For the lucky Linux / MacOS users, you can just run this command in your terminal:

$ curl -Ls http://restx.io/install.sh | sh

View source

Then you should be able to run restx:

$ restx
===============================================================================
== WELCOME TO RESTX SHELL - 0.34.1 - type `help` for help on available commands
===============================================================================

Manual approach

if you prefer to stay in control of your installation, here are the installation instructions:

  • download the package (either as a zip or tar.gz, though we recommend tar.gz for Linux / Mac OS)
  • unpack the package in the directory of your choice. Beware, the package has no root directory.
  • create a symlink called restx to the restx script located in the installation folder OR add the directory to your PATH (Linux Mac OS X)

Here is an example of script to do that:

mkdir ~/.restx
curl --progress-bar --fail "http://repo1.maven.org/maven2/io/restx/restx-package/0.34.1/restx-package-0.34.1.tar.gz" | tar -xzf - -C ~/.restx
ln -s ~/.restx/restx /usr/local/bin/restx

Then you should be able to run restx:

$ restx
===============================================================================
== WELCOME TO RESTX SHELL - 0.34.1 - type `help` for help on available commands
===============================================================================