A shell for running JSON-RPC 2.0 queries
Go to file
Přemysl Eric Janouch 6934550068
Arch Linux AUR Success Details
Alpine 3.19 Success Details
OpenBSD 7.3 Success Details
CMakeLists.txt: declare compatibility with 3.27
Sadly, the 3.5 deprecation warning doesn't go away after this.
2023-08-01 03:14:48 +02:00
cmake FindLibEV.cmake: synchronise 2021-10-30 01:56:48 +02:00
http-parser@ec8b5ee63f Bump http-parser 2020-10-13 04:35:42 +02:00
liberty@7a0cb13a1a Try harder to find ncursesw 2023-07-24 09:01:54 +02:00
.clang-format Add clang-format configuration 2021-10-30 02:59:33 +02:00
.gitignore Update .gitignore 2021-10-30 03:34:23 +02:00
.gitmodules Bump liberty 2018-06-24 04:16:05 +02:00
CMakeLists.txt CMakeLists.txt: declare compatibility with 3.27 2023-08-01 03:14:48 +02:00
LICENSE Fix libedit history behaviour 2022-09-04 15:22:46 +02:00
NEWS Update NEWS 2022-09-04 15:22:46 +02:00
README.adoc README.adoc: update package information 2023-07-01 22:01:16 +02:00
config.h.in Bump minimum CMake version to 3.0 2020-10-30 04:21:16 +01:00
json-format.pl json-format.pl: further fixes 2017-01-26 01:35:24 +01:00
json-rpc-shell.adoc Improve link detection suppression in man page 2022-09-30 14:49:51 +02:00
json-rpc-shell.c Fix libedit history behaviour 2022-09-04 15:22:46 +02:00
json-rpc-test-server.c json-rpc-test-server: add a "wait" method 2022-09-04 15:25:27 +02:00



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

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


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


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


Regular releases are sporadic. git master should be stable enough. You can get a package with the latest development version using Arch Linuxs AUR, or as a Nix derivation.


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

$ git clone --recursive https://git.janouch.name/p/json-rpc-shell.git
$ mkdir json-rpc-shell/build
$ cd json-rpc-shell/build
$ 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

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


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.