Skip to content
lord-willard edited this page Jul 21, 2024 · 1 revision
Usage: igor [options]

Options:
  --admin                          Enables administrative mode
  --command <module:command>    Invokes a command of from a specified module directly
  --decrypt <text>               Decrypts the specified text
  --develop                     Enables development mode
  --encrypt <text>               Encrypts the specified text
  --help                        Show this help message and exit
  --update                      Performs a version check and updates if a later version is available
  --verbose                     Enable verbose mode

Examples:
  igor -encrypt MySecr3tPassw0rd
  igor --command module_admin:create_module 'my_new_module' 'New Module' ~/workspace/igor-modules/my_new_module

Administrative Mode

Usage: igor --admin

In administrative mode, the user is presented with a menu which allows the user to:

  • add

  • create

  • remove

a module to/from Igor workbench.

Command Execution

Usage: igor --command module_admin:create_module 'my_new_module' 'New Module' ~/workspace/igor-modules/my_new_module

The following usage informs Igor to execute the command create_module found within module_admin inclusive of the arguments required.

This usage pattern is only applied when executed from a non-interactive shell, such as crontab. Lastly it can also be seen as a shortcut, should the user be repeating the same selection over and over, this can save some time.

Development Mode

Usage: igor --develop

If development mode is enabled, Igor executes from within the calling directory and not the installed directory ~/.igor. This enables the developer to execute Igor from within the git source directory.

Update Igor

Usage: igor --update

Connects to GitHub to see if a later version is available, should that be the case, then Igor will request permission to download and install latest and continue upon permission granted.

Verbose Logging

Usage: igor --verbose

Clone this wiki locally