Skip to content
MambaMamba

Executor

In Mamba the tool that’s you use to create your CLI’s is called the Executor. It runs commands, gives them global flags and options and executes hooks. By default the help, dry-run and the verbose flags are registered. You can’t override them! They can only be appended to!

Command Execution is done through the execute method! It’s takes the arguments that are passed from main! Then selects a command and processes non-command arguments based on what was sent!

Before the execute function could be called you need to call create or fake. The create method is the one that makes what’s called the real executor. This executor is the one that’s responsible for executing the command as intended.

The fake one is the one that’s meant to give you a result based on success or failure! By catching and returning Execptions and returning the value from the selected command’s run()!

Create executor

Section titled “Create executor”
 Executor("my-cli", "This is a CLI meant ").create().execute();

This is the real executor! It’s job is to process arguments based on the diagram below!

flowchart TD
    A["Receive command-line arguments"] --> B["Apply default command paths"]
    B --> C["Validate the command path and inputs"]
    C --> D{"Show help or run a command?"}

    D -->|Show help| E["Format and write help"]
    D -->|Run command| F["Create a read-only command context"]
    F --> G["Run persistent pre-hooks<br/>from outer group to inner group"]
    G --> H{"Does the command use hooks?"}
    H -->|Yes| I["Read piped standard input<br/>and run the pre-hook"]
    H -->|No| J["Run the selected command"]
    I --> J
    J --> K["Write command output when present"]
    K --> L["Run the command post-hook"]
    L --> M["Run persistent post-hooks<br/>from inner group to outer group"]

    C -. "Validation failure" .-> N["Write the failure to standard error<br/>and mark the process as failed"]
    G -. "Hook or command failure" .-> N
    L -. "Post-hook failure" .-> N

Fake executor

Section titled “Fake executor”

This is the executor that’s meant to be used for testing.

It’s repsonsible for sending the selected command’s output or catching the exception then sending it! As a MambaSuccessResult when the command succeeds! The run()’s output is the value field! As a MambaFailureResult when the command fails! An Exception message are placed in the message getter.

Executor("my-cli", "This is a CLI meant ").fake().execute();
flowchart TD
    A["Receive test arguments"] --> B["Apply default command paths"]
    B --> C["Validate the command path and inputs"]
    C --> D{"Show help or run a command?"}

    D -->|Show help| E["Return formatted help as a success result"]
    D -->|Run command| F["Create a read-only command context"]
    F --> G["Run persistent pre-hooks<br/>from outer group to inner group"]
    G --> H{"Does the command use hooks?"}
    H -->|Yes| I["Read piped standard input<br/>and run the pre-hook"]
    H -->|No| J["Run the selected command"]
    I --> J
    J --> K["Prepare command output as a success result"]
    E --> L["Run the command post-hook"]
    K --> L
    L --> M["Run persistent post-hooks<br/>from inner group to outer group"]
    M --> N["Return the success result"]

    C -. "Validation failure" .-> O["Return a failure result"]
    G -. "Hook or command failure" .-> O
    L -. "Command post-hook failure" .-> P["End execution without a result"]
    M -. "Persistent post-hook failure" .-> P

Help

Section titled “Help”

Configuration

Section titled “Configuration”

The executor’s options configure what commands can execute and what what flags and options are can be sent to all commands. By default when help is used without any commands you get the help output!

Option Description
longDescription A longer description of the the CLI
flags global flags for all commands to consume
options global options for all commands to use
accessors global accessors for all commands to use
defaultCommandPath The path of the default command you want to execute
helpFormatter The help formatter that you want to use
context your own writable context

Default command

Section titled “Default command”

By default when you run a CLI created by Mamba without a command! You’ll get the help menu! You can configure the default command by just providing an array that’s a series of strings pointing to the command you want to execute. When provided the executor will check if the command exist’s! It will also make sure the path isn’t empty!