On This Page
package sihl-core
On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
A module to register and run CLI commands.
A CLI command is the entry t a Sihl app. Services contribute their own set of commands, making every Sihl app and the available commands per Sihl app dynamic and dependent on the set of active services.
type fn = string list -> unit Lwt.tA function that takes a list of strings as argument and does some side effect.
A CLI command has a unique name, an optional help text that shows the usage, a description that gives background information and the actual CLI function.
Running commands
Call run commands args in the main Sihl app executable to pass command line arguments to all registered commands. This is the main entry point to a Sihl app. An optional list of arguments args can be passed, if None is passed, it reads the arguments from Sys.argv.
Utilities
val sexp_of_t : t -> Sexplib0.Sexp.tsexp_of_t t converts the command t to an s-expression
val pp : Stdlib.Format.formatter -> t -> unitpp formats the command t as an s-expression
On This Page