RESTX SHELL - Command Line Interface for RestX projects
RESTX Shell is a command line interface (CLI) for managing restx projects, from bootstrapping to daily usages like adding a dependency.
It's licensed under the very commercial friendly Apache License 2, and is actively maintained by a community of developers.
You can get more details about RESTX from the web site at http://restx.io/
Here you will find the build instructions if you want to build RESTX Shell yourself, and why not contribute to the project.
RESTX Shell requires Java 7.
You can build it using either Maven 2+ or EasyAnt.
easyant test package
To test current version of the shell, build it then :
- Move to
- Run the
local-install.shscript which will install a development
restx-shelldistribution into your
- Create a
RESTX_OPTSenvironment variable with debug properties, such as :
and run the
export RESTX_OPTS="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8001"
restx-package/target/restx/restxexecutable : you will then be able to debug a running shell.
The sources for module descriptors are the
md.restx.json files located in each module, and the
restx.build.properties for the dependencies version.
Maven poms and EasyAnt Ivy files are generated from these files using
restx build generate pom + build generate ivy.
RESTX Shell is decomposed in a set of modules, each one following the traditional Java project layout (main sources in
src/main, test sources in
The main modules are
RESTX Shell is a plugin-oriented shell with currently 3 main plugins :
Here is a brief summary of each module:
restx-shell: The pluggable shell.
restx-shell-manager: Plugin to manage the shell: install plugins, upgrade shell version.
restx-build: The very simple tool which generates POM / Ivy files from
restx-core-shell: Plugin providing RESTX core support in the shell: app comilation and running, ...
restx-build-shell: Plugin prodividing build support in the shell, especially to generate POM/Ivy files from
restx-specs-shell: Plugin providing RESTX specs based HTTP mock server.
restx-package: assembly module to package the shell
Contributions are welcome, fork the repo, push your changes to a branch, build & debug it then send a Pull Request.
To be sure the PR will be merged please discuss it on the google group before, or create an issue on GitHub to initiate the discussion.