Differences

This shows you the differences between two versions of the page.

--- command_line [2018/06/25 23:54] – dmitry
+++ command_line [2022/10/05 17:48] (current) – [Installation and configuration] dmitry
@@ Line 1: / Line 1: @@
-===== Running EasyMorph from the command line =====
+===== Running EasyMorph projects from the command line =====
+To execute EasyMorph projects (.morph files) from the command line use the standalone Command-Line Worker (CLW) utility.
-It is possible to execute EasyMorph projects (.morph files) from the command line. This can be used for scheduling EasyMorph projects using Windows Task Scheduler or other 3rd party tools. Project execution in the command line mode is activated by using the **/c** key.
-**Examples**
-Run project from the command line without parameters:
-  morph.exe /c myproject.morph
-Project [[parameters]] can be defined from the command line as well. If a project parameter is not defined from the command line than it keeps its default value. If a parameter name or parameter value contains spaces then it must be wrapped in double quotes.
-  morph.exe /c myproject.morph /param:Year=2015 /param:"File name"="C:\My Documents\input.csv"
-Generate report:
+==== Features ====
-  morph.exe /c /report myproject.morph
+  * Support for project parameters
+  * Notifications about project failures by email or using a webhook
+  * Logging
+  * Running projects synchronously or asynchronously (fire & forget)
+  * Support for file repositories as well as Server-hosted
+  * Licensed per installation, can be used by any Windows user that has access to the machine
+==== Installation and configuration ====
+Download the utility from the [[https://easymorph.com/download/all-downloads.html|"All downloads"]] page and run it. The utility installer creates two executables:
+  * morph-cmd.exe - the command-line utility itself
+  * Morph.Cmd.Config.exe - the configurator tool with a GUI
+To configure CLW, run the configuration utility first. Note that CLW doesn't come with a pre-installed connector repository. Use an existing one from your EasyMorph Desktop or EasyMorph Server.
+==== Syntax ====
-Generate report (using parameters):
+Run project without parameters:
-  morph.exe /c /report myproject.morph /param:Year=2015 /param:"File name"="C:\My Documents\input.csv"
+  morph-cmd.exe myproject.morph
-Override default location of the license key (from the configuration file):
+Project [[parameters]] can be defined from the command line as well. If a project parameter is not defined from the command line then it keeps its default value. If a parameter name or parameter value contains spaces then it must be wrapped in double quotes.
-  morph.exe /c myproject.morph /key:"C:\EasyMorph.key"
+Run project with parameters:
-**Documentation**
+  morph-cmd.exe myproject.morph /param:Year=2015 /param:"File name"="C:\My Documents\input.csv"
+Run project asynchronously without parameters:
+  morph-cmd.exe /runasync myproject.morph
 Generate documentation from the command line (the project is not run, only documentation is generated):
-  morph.exe /document myproject.morph
+  morph-cmd.exe /document myproject.morph
+==== Logs ====
-Option /document can be combined with /c for project execution.
+Errors that occurred during command-line execution are written into a project log file with the same name as the project (e.g. myproject.log). The project log files are created in the same directory as projects.
-**Logs**
+Fatal (system errors) are written into the application log morph-cmd.log located in ''C:\ProgramData\EasyMorph\Command Line Worker''.
-Errors occurred during command-line execution are written into log file with the same name as the project (e.g. myproject.log). Log files are created in the same directory as projects.
+The project log directory can be specified using option ''/projectLogPath'', for instance:
-Fatal (system errors) are written into EasyMorph.log located in C:\Users\<username>\AppData\Local\EasyMorph.
+  morph-cmd.exe myproject.morph /projectLogPath:"C:\logs\easymorph"
+In this case, all project logs will be written into the specified directory.