p/json-rpc-shell
1
1
Fork 0
Code Issues 8 Pull Requests Projects 1 Releases 3 Wiki Activity
A shell for running JSON-RPC 2.0 queries
57 Commits 1 Branch 3 Tags 763 KiB
C 95%
CMake 3.3%
Perl 1.7%
46b926d9e5
Go to file
Přemysl Janouch 46b926d9e5 Add ability to pipe output from calls
2016-01-21 09:26:29 +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 Rewrite the input layer 2015-12-25 23:38:40 +01:00
config.h.in Rewrite the input layer 2015-12-25 23:38:40 +01:00
json-rpc-shell.c Add ability to pipe output from calls 2016-01-21 09:26:29 +01:00
LICENSE Add JSON syntax highlighting 2016-01-21 07:34:03 +01:00
README.adoc Rewrite the input layer 2015-12-25 23:38:40 +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

Supported transports

  • HTTP

  • HTTPS

  • WebSocket

  • WebSocket over TLS

WebSockets

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

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

Building and Running

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 project’s 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: