Differences

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

--- sift:command_line [2026/02/13 17:42] – sgranger
+++ sift:command_line [2026/08/21 16:02] (current) – wikisysop
@@ Line 1: / Line 1: @@
-===== Sift Command Line =====
+====== Sift Command Line ======
-It is possible to run sift from the command line, this offers several advantages:
+Running Sift from the command line offers several advantages:
-  * With no need to update a GUI or plots the application will run much faster
+  * With no need to update a GUI or plots, the application will run much faster
-  * With experience it makes it possible to quickly execute commands
+  * With experience, it makes it possible to quickly execute commands
-  * Creating a bat file or python script it is possible to completely automate processing
+  * Creating a bat file or python script makes it possible to completely automate processing
@@ Line 38: / Line 38: @@
+----
 ===== Command Reference =====
 ----
@@ Line 290: / Line 291: @@
 ----
 Main function for building CMZ workspaces. Calls sub functions
+        ~ directory
+        ~ settingsFile
+        ~ preview
 === Parameters ===
 __**directory (DEFAULT) (REQUIRED) **__ \\
@@ Line 295: / Line 299: @@
   * **Data Type:** String (Directory)
   * **Default Value:** N/A
-<code> -BuildCMZ</code>
+__**settingsFile**__ \\
+A .xml file containing buildCMZ dialog settings saved from the GUI
+  * **Data Type:** String (File Path)
+  * **Default Value:** N/A
+__**preview**__ \\
+If passed Sift will provide a preview of the build it will run and ask the user if they wish to continue.
+  * **Data Type:** Boolean (True / False)
+  * **Default Value:** false
+<code> -BuildCMZ directory ".../../" settingsFile "/.../buildSettings.xml" preview</code>
 ----