Skip to content

Quick Actions

XternA edited this page Aug 21, 2024 · 10 revisions

Starting with version 1.6, introduces a new feature called Quick action.

Income Generator Application Manager
----------------------------------------

Quick action menu of common operations.

Usage: igm
Usage: igm [command]

[General]
  igm                  Launch the Income Generator tool.
  igm help             Display this help usage guide.

[Manage]
  igm start            Start all currently deployed applications.
  igm stop             Stop all currently deployed running applications.
  igm remove           Stop and remove all currently deployed applications.
  igm show             Show list of installed and running applications.
  igm deploy           Launch the install manager for deploying applications.

[Configuration]
  igm app              Enable or disable applications for deployment.
  igm setup            Setup credentials for applications to be deployed.
  igm view             View all configured application credentials.
  igm edit             Edit configured credentials and config file directly.
  igm limit            Set the application resource limits.

Quick action is a set of CLI commands that allows you manage and orchestrate the application stack without loading the Income Generator tool for commonly used operation.

It is not designed to replace using the tool UI, but useful for repeated tasks such as starting, stopping, change resource limits or redeploy the application stack with quick action commands.

To show the list of quick action commands, run the following:

igm help

When you invoke a command, everything that you were familiar with the tool will be the same.

How to Enable Quick Action Feature

For all existing users who already have the tool installed, you will need to update the current igm registered alias command to accept arguments for this feature to work after updating the tool, otherwise, you won't see the new command option.

ℹ️ New users who have downloaded the tool after v1.6 can ignore this as your registered igm command is already configured.

Windows

Step 1

Run igm and update the tool through the system menu.

Step 2

Remove the old registered igm command alias. Run the following command in the command line:

wsl -e sh -c "sed -i '/alias igm=/d' $HOME/.aliases; sed -i '/alias igm=/d' $HOME/.${SHELL##*/}rc"

This will remove the internal WSL igm command alias that has been registered so that the new one can be registered without conflict.

Step 3

Update the Windows bootstrap script, which will download the latest version and replace your current existing script.

curl -o %APPDATA%\IGM\igm.bat --create-dirs --ssl-no-revoke -L https://raw.githubusercontent.com/XternA/income-generator/main/start.bat

Step 4

Now run igm command, which will load Income Generator tool. The new alias should now be automatically registered.

Exist the tool, and run the following:

igm help

If you see the quick action menu, the feature is active.

Linux & macOS

Step 1

Run igm and update the tool through the system menu.

Step 2

Remove the old registered igm command alias. Run the following command in the command line:

Linux

sed -i '/alias igm=/d' $HOME/.aliases; sed -i '/alias igm=/d' "$HOME/.${SHELL##*/}rc"

macOS

sed -i '' '/alias igm=/d' "$HOME/.aliases"; sed -i '' '/alias igm=/d' "$HOME/.${SHELL##*/}rc"

This will remove the igm command alias that has been registered so that the new one can be registered without conflict.

Step 3

Register the new igm command alias.

echo "alias igm=\"sh -c 'cd ~/.income-generator; sh start.sh \\\"\\\$@\\\"' --\"" >> ~/."${SHELL##*/}rc"; source ~/."${SHELL##*/}rc"

Step 4

Now run igm command, which will load Income Generator tool. The new alias should now be automatically registered.

Exist the tool, and run the following:

igm help

If you see the quick action menu, the feature is active.