p
/
json-rpc-shell
1
1
Fork 0
Code Issues 8 Pull Requests Projects 1 Releases 2 Wiki Activity
A shell for running JSON-RPC 2.0 queries
230 Commits 1 Branch 2 Tags 756 KiB
C 95%
CMake 3.3%
Perl 1.7%
Go to file
Přemysl Eric Janouch 4938ee43bd
json-rpc-test-server: try to send a 408 
Also send "Connection: close" when we're closing the connection.

With HTTP/1.1 there come some responsibilities.

Surprisingly enough, the forward declaration is desirable
and the invocation a clean-up.
 		2020-10-15 04:59:01 +02:00
cmake Fix FindLibMagic.cmake 2016-01-16 06:37:56 +01:00
http-parser@ec8b5ee63f Bump http-parser 2020-10-13 04:35:42 +02:00
liberty@69101eb155 Support reading OpenRPC documents from a file 2020-10-13 21:48:24 +02:00
.gitignore Miscellaneous little changes 2015-02-26 22:56:52 +01:00
.gitmodules Bump liberty 2018-06-24 06:12:16 +02:00
CMakeLists.txt This software is no longer simple 2020-10-14 13:36:35 +02:00
LICENSE Update copyright years 2020-09-01 21:03:53 +02:00
NEWS Bump version, update NEWS 2020-10-13 16:03:19 +02:00
README.adoc json-rpc-test-server: add a simple co-process mode 2020-10-15 03:20:20 +02:00
config.h.in Rewrite the input layer 2015-12-25 23:38:40 +01:00
json-format.pl json-format.pl: further fixes 2017-01-26 01:35:24 +01:00
json-rpc-shell.adoc Add a backend for co-processes 2020-10-14 13:37:08 +02:00
json-rpc-shell.c WebSocket: send a User-Agent header 2020-10-15 04:30:48 +02:00
json-rpc-test-server.c json-rpc-test-server: try to send a 408 2020-10-15 04:59:01 +02:00

README.adoc

json-rpc-shell

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

This software was originally created as a replacement for a different one made by Vladimir Dzhuvinov, in order to avoid Java, but has evolved since.

Features

In addition to most of the features provided by its predecessor, you will 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

  • WebSocket (RFC 6455) can also be used as a transport rather than HTTP

  • even Language Server Protocol servers may be launched as a slave command

  • support for method name tab completion using OpenRPC discovery or file input

Documentation

See the man page for information about usage. The rest of this README will concern itself with externalities.

Packages

Regular releases are sporadic. git master should be stable enough. You can get a package with the latest development version from Archlinux’s AUR.

Building

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

Avoid libedit if you can, in general it works but at the moment history is acting up and I have no clue about fixing it. Multiline editing is also misbehaving there.

$ git clone --recursive https://git.janouch.name/p/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.

Test server

If you install development packages for libmagic, an included test server will be built but not installed which provides a trivial JSON-RPC 2.0 service with FastCGI, SCGI, WebSocket and LSP-like co-process interfaces. It responds to ping and date, supports OpenRPC discovery and it can serve static files.

Contributing and Support

Use https://git.janouch.name/p/json-rpc-shell to report bugs, request features, or submit pull requests. git send-email is tolerated. If you want to discuss the project, feel free to join me at ircs://irc.janouch.name, channel #dev.

Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9

License

This software is released under the terms of the 0BSD license, the text of which is included within the package along with the list of authors.