Router for Prompt

Simplifies defining commands, sub-commands and arguments.

Choose the module responsible for taking the command line arguments and use Prompt.Router, otp_app: :your_app at the top.

Then simply define your commands and arguments.

Exposes a main/1 function that is called with the command line args

arguments

Arguments

See arg/3

example

Example

defmodule My.CLI do
  use Prompt.Router, otp_app: :my_app

  command :checkout, My.CheckoutCommand do
    arg :help, :boolean
    arg :branch, :string, short: :b, default: "main"
  end

  command "", My.DefaultCommand do
    arg :info, :boolean
  end
end

defmodule My.CheckoutCommand do
  use Prompt.Command

  @impl true
  def process(arguments) do
    # arguments will be a map of the defined arguments and their values
    # from the command line input
    # If someone used the command and passed `--branch  feature/test`, then
    # `argmuments would look like `%{help: false, branch: "feature/test"}`
    display("checking out " <> arguments.branch)
  end
end

defmodule My.DefaultCommand do
  use Prompt.Command

  @impl true
  def init(arguments) do
    # you can implement the `c:init/1` callback to transform
    # the arguments before `c:process/1` is called if you want
    arguments
  end
  
  @impl true
  def process(arguments) do
    # arguments will have a key of `:leftover` for anything
    # passed to the command that doesn't have a `arg` defined.
    # IF someone called this with `--info --test something`, then then
    # arguments will look like `%{info: true, leftover: ["--test", "something"]}`
    display("showing info")
  end
end