Go to file

Kaustubh Maske Patil 1fa8a0fa8b Change interface to accept arrow string with '-a' instead of arrow length		2024-07-20 15:26:55 +05:30
bin	Change interface to accept arrow string with '-a' instead of arrow length	2024-07-20 15:26:55 +05:30
lib	Change interface to accept arrow string with '-a' instead of arrow length	2024-07-20 15:26:55 +05:30
test	Initial commit	2024-07-20 03:37:17 +05:30
.gitignore	Initial commit	2024-07-20 03:37:17 +05:30
boks.opam	Change interface to accept arrow string with '-a' instead of arrow length	2024-07-20 15:26:55 +05:30
dune-project	Change interface to accept arrow string with '-a' instead of arrow length	2024-07-20 15:26:55 +05:30
LICENSE	Create LICENSE	2024-07-20 04:04:01 +05:30
README.md	Change interface to accept arrow string with '-a' instead of arrow length	2024-07-20 15:26:55 +05:30

README.md

boks

CLI for making ASCII boxes with text in OCaml.

Usage

To put something in a box,

$ boks moo
+---------+
|   moo   |
+---------+

To put multiple things in connected boxes,

$ boks apps dbms data
+----------+     +----------+     +----------+
|   apps   |<--->|   dbms   |<--->|   data   |
+----------+     +----------+     +----------+

Use -a to customize arrow style, -p to customize padding length.

e.g.

$ boks -a '--->' 'declarative query' 'optimized plan'
+-----------------------+    +--------------------+
|   declarative query   |--->|   optimized plan   |
+-----------------------+    +--------------------+

Installation

If you have dune installed,

$ git clone https://github.com/nikochiko/boks && cd boks
$ dune install

License

MIT. See LICENSE.