linenoise

Lightweight readline alternative
README

Benefits

  1. BSD licensed.

  2. No system dependencies, no need for readline on your machine.

  3. Related to 2, these bindings are self-contained, the source for
    linenoise is in this repo and compiled all together with the
    OCaml.

  4. Written in OCaml + C.

  5. Pretty cool hints feature, see the gif.

  6. Additional features compared to linenoise, such as history search

Installation

It is easy with opam

$ opam install linenoise

See the pretty
documentation here

Example code

This example is also included in the repo under examples:

let rec user_input prompt cb =
  match LNoise.linenoise prompt with
  | None -> ()
  | Some v ->
    cb v;
    user_input prompt cb

let () =
  (* LNoise.set_multiline true; *)
  LNoise.set_hints_callback (fun line ->
      if line <> "git remote add " then None
      else Some (" <this is the remote name> <this is the remote URL>",
                 LNoise.Yellow,
                 true)
    );
  LNoise.history_load ~filename:"history.txt" |> ignore;
  LNoise.history_set ~max_length:100 |> ignore;
  LNoise.set_completion_callback begin fun line_so_far ln_completions ->
    if line_so_far <> "" && line_so_far.[0] = 'h' then
      ["Hey"; "Howard"; "Hughes";"Hocus"]
      |> List.iter (LNoise.add_completion ln_completions);
  end;
  ["These are OCaml bindings to linenoise";
   "get tab completion with <TAB>, type h then hit <TAB>";
   "type quit to exit gracefully";
   "By Edgar Aroutiounian\n"]
  |> List.iter print_endline;
  (fun from_user ->
     if from_user = "quit" then exit 0;
     LNoise.history_add from_user |> ignore;
     LNoise.history_save ~filename:"history.txt" |> ignore;
     Printf.sprintf "Got: %s" from_user |> print_endline
  )
  |> user_input "test_program> "
Install
Published
15 Sep 2022
Maintainers
Sources
v1.4.0.tar.gz
md5=373cadced7663934b91c64c5bbdf9640
sha512=d510ffea00d792c63f23a363c5e564fa6c161a2eaffc391c5080325adb26f0bdedf998f11d10e98ec6edb96344e93ac835e5ea5aa683a5b36c9ff0d6d190ecee
Dependencies
odoc
with-doc
ocaml
>= "4.03.0"
dune
>= "1.1"
Reverse Dependencies
alba
>= "0.4.1"
beluga
>= "1.0"
gobba
>= "0.4.2"
links
>= "0.7"
ocamline
>= "1.2"
ogen
= "0.1.2" | >= "0.1.4"