A shell for running JSON-RPC 2.0 queries
Go to file
Přemysl Eric Janouch ed77188bfd Use TMPDIR as a fallback if set 2016-03-13 01:02:07 +01:00
cmake Convert to CMake, fix terminal resize behaviour 2014-11-18 22:06:25 +01:00
http-parser@5d414fcb4b Stubplement WebSockets 2015-03-29 00:37:12 +01:00
liberty@8b2e41ed8f Bump liberty, use newer configuration format 2015-12-13 22:54:14 +01:00
.gitignore Miscellaneous little changes 2015-02-26 22:56:52 +01:00
.gitmodules Stubplement WebSockets 2015-03-29 00:37:12 +01:00
.travis.yml Travis CI: Change IRC notification address 2015-04-03 00:19:34 +02:00
CMakeLists.txt Fix CMakeLists.txt 2016-03-10 21:08:24 +01:00
LICENSE Add JSON syntax highlighting 2016-01-21 07:34:03 +01:00
README.adoc Update README 2016-03-10 21:32:33 +01:00
config.h.in Rewrite the input layer 2015-12-25 23:38:40 +01:00
json-rpc-shell.c Use TMPDIR as a fallback if set 2016-03-13 01:02:07 +01:00

README.adoc

json-rpc-shell

json-rpc-shell is a simple shell for running JSON-RPC 2.0 queries.

This software has been created as a replacement for the following shell, which is written in Java: http://software.dzhuvinov.com/json-rpc-2.0-shell.html

Features

In addition to most of the features provided by Vladimir Dzhuvinovs shell you get the following niceties:

  • configurable JSON syntax highlight, which with prettyprinting turned on helps you make sense of the results significantly

  • ability to pipe output through a shell command, so that you can view the results in your favourite editor or redirect them to a file

  • ability to edit the input line in your favourite editor as well with Alt+E

Supported transports

  • HTTP

  • HTTPS

  • WebSocket

  • WebSocket over TLS

WebSockets

The WebSocket transport is rather experimental. As the JSON-RPC 2.0 spec doesnt say almost anything about the underlying transports, Ill shortly describe the way its implemented: every request is sent as a single text message. If it has an "id" field, i.e. its not just a notification, the client waits for a message from the server in response.

Theres no support so far for any protocol extensions, nor for specifying the higher-level protocol (the "Sec-Ws-Protocol" HTTP field).

Packages

Regular releases are sporadic. git master should be stable enough. You can get a package with the latest development version from Archlinuxs AUR, or from openSUSE Build Service for the rest of mainstream distributions. Consult the list of repositories and their respective links at:

Building and Usage

Build dependencies: CMake, pkg-config, help2man, liberty (included), http-parser (included)
Runtime dependencies: libev, Jansson, cURL, openssl, readline or libedit >= 2013-07-12,

$ git clone --recursive https://github.com/pjanouch/json-rpc-shell.git
$ mkdir json-rpc-shell/build
$ cd json-rpc-shell/build
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug
$ make

To install the application, you can do either the usual:

# make install

Or you can try telling CMake to make a package for you. For Debian it is:

$ cpack -G DEB
# dpkg -i json-rpc-shell-*.deb

Note that for versions of CMake before 2.8.9, you need to prefix cpack with fakeroot or file ownership will end up wrong.

Run the program with --help to obtain usage information.

Contributing and Support

Use this projects GitHub to report any bugs, request features, or submit pull requests. If you want to discuss this project, or maybe just hang out with the developer, feel free to join me at irc://anathema.irc.so, channel #anathema.

License

json-rpc-shell is written by Přemysl Janouch <p.janouch@gmail.com>.

You may use the software under the terms of the ISC license, the text of which is included within the package, or, at your option, you may relicense the work under the MIT or the Modified BSD License, as listed at the following site: