CliMate (CLI Mate v0.7.1)

View Source

This module is the base namespace for the :cli_mate application.

Most interactions with this library will be made through the CliMate.CLI module.

Deprecation for use CliMate

Including all CLI code in your own module is no longer supported and will be removedin a future release.

Please see https://github.com/lud/cli_mate?tab=readme-ov-file#migration-to-version-100

If you still want to extend the CLI module to add your own helpers, you can use the following:

require CliMate
CliMate.extend_cli()

This will import and re-export all the CLI exported functions into your module.

Summary

Functions

extend_cli()

Imports and re-exports all CliMate.CLI functions in the calling module.

Functions

extend_cli()

(macro)

Imports and re-exports all CliMate.CLI functions in the calling module.

This is useful if you want to define a module where all your CLI helpers reside, instead of calling, say, writeln("hello") from CliMate.CLI but fancy_subtitle("Hello!") from MyApp.CliHelpers.

Although, it will be easier to debug and provide useful documentation if you do call the functions from their origin module.