README.md

Imandra HTTP API Client

Query Imandra via HTTP. See also https://github.com/aestheticIntegration/bs-imandra-client for a sample client implementation and OCaml API types.

Installation

This repository uses Nix and Nix flakes for system-level dependencies.

To install dependencies and build the project, please clone this repository and run:

make opam-install-deps
make all

Getting Started

Please first install Imandra. This should provide a binary imandra-http-api.

With imandra-http-api running on localhost at port 3000, tests can be run using make tests.

Usage

With the server running on port 3000 as above, one can interact with the server using endpoints via functions defined in the imandra_http_api_client.mli interface file.

Here is an example of using the eval string to evaluate the expression let foo x = x + 1 and then shutting down the server:

 let response =
    Log.debug (fun k -> k "Sending query to server...");
    let req : Api.Request.eval_req_src =
      { src = "let f x = x + 1"; syntax = Iml }
    in
    let* result = Client.eval config req in
    (match result with
    | Ok _ -> Log.app (fun k -> k "Got ok response")
    | Error _ -> Log.app (fun k -> k "Got error response"));
    let* _ = Client.shutdown config () in
    Lwt.return ()

Other examples can be found in the tests/ directory.