MintCLI

Short Description

MintCLI is a command-line tool designed for managing and automating tasks within the MintHCM system and related environments. This guide provides detailed instructions for using MintCLI, including available options and commands.

Getting Started

To launch the tool, navigate to the directory containing the MintCLI executable and run:

./MintCLI

This will display the general help message along with a list of available commands and options.

---

Global Options

• -h, --help Display help for a given command. If no command is specified, shows help for the list command.
• -q, --quiet Suppress all output messages.
• -V, --version Display the application version.
• --ansi / --no-ansi Force (or disable) ANSI color output in the console.
• -n, --no-interaction Run in non-interactive mode (no prompts for user input).
• -v, -vv, -vvv, --verbose Increase the verbosity of output messages:
  • 1 – normal output
  • 2 – more verbose output
  • 3 – debug mode

---

Available Commands

Command	Description
completion	Generate the shell completion script
help	Display help for a specific command
install	Install the MintHCM system
list	List all available commands
demodata:dump	Export demo data (Demo Data Dump)
demodata:install	Install demo data (Demo Data Install)
elasticsearch:reindex	Reindex the entire ElasticSearch database
elasticsearch:reindexModule	Reindex a selected ElasticSearch module

---

Usage Examples

• Display help:

./MintCLI --help

• Install MintHCM system:

./MintCLI install

• Install demo data:

./MintCLI demodata:install

• Export demo data:

./MintCLI demodata:dump

• Reindex ElasticSearch:

./MintCLI elasticsearch:reindex

• Reindex a specific ElasticSearch module:

./MintCLI elasticsearch:reindexModule

---

Additional Information

• MintCLI is intended for use in Linux environments, with appropriate permissions for system and database operations.
• If you encounter issues with command access or execution errors, verify your user permissions and environment configuration.

---

Command Reference

Below you will find a detailed description of each MintCLI command, including its purpose, expected behavior, and typical use cases.

install

./MintCLI install

Runs the MintHCM system installation process. When you execute ./MintCLI install, the installer will prompt you to enter essential configuration details, including:

• Database connection information (such as host, database name, user, and password)
• Elasticsearch connection details
• Administrator user credentials

If any of the provided information is invalid or incomplete, the system will display an error message and prompt you to correct the input. Only when all required data is entered correctly will the installation proceed.

Upon successful completion of the installation process, the MintHCM system will be fully configured and ready for use.