Command Line InterfaceΒΆ

getML can be launched via the command line. The command line interface is called getML on Linux, getml-cli on macOS and getML.exe on Windows.

Refer to the installation section, for instructions for how to set up the command line interface.

Some parameters can be set via command line flags. If you do not explicitly set them, the values from your config.json are taken instead. The config.json is located in $HOME/.getML/getml-VERSION on Linux and macOS. On Windows, it is located in the same directory as getML.exe. The most elegant way to edit your config.json is via the configuration view in the getML monitor:

The help menu can also be displayed by passing the flag -help or -h. The default values displayed in the help menu are the values in the config.json (therefore, they are not hard-coded).

-allow-push-notifications (boolean)

Whether you want to allow the getML monitor to send push notifications to your desktop.

-engine-port (integer)

The port of the getML engine. This is also the port that the Python API communicates with.

-http-port (integer)

The local port of the getML monitor. This port can only be accessed from your local computer.

-https-port (integer)

The remote and encrypted port of the getML monitor. This port can be accessed remotely, but it is encrypted.

-project-directory (string)

The directory in which to store all of your projects.

-stop (boolean)

Will shutdown the getML engine and monitor via the http-port. If no http-port is passed, then the default http-port (in the config.json) will be used.

-version (boolean)

Show the current version.