Articles in this section

Command Line GoodSync Job (GSYNC)

Return to top

GSYNC Command Line Reference

GSYNC is the command-line version of GoodSync. It can be used in batch files, scripts, automation tools, and Linux environments.

General command format:

gsync [profile-options] [run-options] [global-options] global-command | job-command

GSYNC runs jobs sequentially in the order they appear in the Job List.

Log output is written to stdout unless redirected.

gsync /runner models the behavior of the GoodSync GUI for Auto jobs:

  • Starts and runs all jobs that are in Auto Mode, such as On File Change jobs.
  • Does not display the GUI. Job results are available through global and job logs.
  • Does not use graphical resources because it runs as a command-line process.
  • To stop GSYNC Runner, send CTRL+C to its console.
  • If /runner is not specified, regular GSYNC options apply.

gsync /? or gsync /help - Lists all GSYNC commands.

On this page

Select a section below to jump directly to the corresponding command-line information.

Getting Started

Global Commands and Options

Job Commands and Options

Advanced Options

Profile Options

Use Profile Options to control which GoodSync profile, job list, and log settings are used when running GSYNC.

/profile=<folder-path> - Folder where jobs.tic and options.tic are located.

/lf=<folder> - Folder where the global log file is written.

/ll=<number> - Log detail level.Default: 2 - Actions.

Log detail levels:

  • 0 - Critical
  • 1 - Errors
  • 2 - Actions - Default
  • 3 - Details
  • 4 - Transaction
  • 5 - Debug

/jobs-file=<file-path> - Loads the job list from this file in TIC or TIX format.

/no-load-tic - Does not load Jobs, Groups, or Options before applying changes.

/no-save-tic - Does not save Jobs, Groups, or Options after applying changes.

Run Options

Use Run Options to control command output, progress, cleanup, locks, and Analyze comparison behavior when running jobs.

/progress - Displays progress messages when running a job.

/noprint - Does not print command-line arguments for verification.

/no-log-stamp - Does not add a timestamp to each log line.

/list-changes - Prints the list of changes detected by Analyze.

/cleanup - Cleans up old log and temporary files when GSYNC starts.

/override-locks - Overrides and deletes lock files during Analyze. Default: No.

/comp-cksums - Compares file checksums during Analyze. This option is slow.

/comp-bodies - Compares file bodies during Analyze. This option is very slow.

Global Commands

Use these commands to display help/version information, manage licensing and account actions, run GSYNC runner modes, and sync or list Jobs-Groups and Server Accounts.

/version or /license - Displays the GoodSync Version and License and exits.

/help - Displays this help message.

/check-ver - Checks the GoodSync version on www.goodsync.com.

/gs-account-enroll=Email - Enrolls this computer into the GoodSync Account identified by Email.

/manage-account - Opens the GoodSync website to manage your GoodSync account.

/buy-license - Opens the GoodSync website to purchase licenses.

/activate - Activates the license using the locally enrolled GoodSync Account.

/runner - Runs as Local Job Runner.

/cc-runner - Runs as Control Center Job Runner.

/sync-jobs-accts - Syncs Jobs-Groups and Server Accounts of this computer with GoodSync Account.

/list-jga - Lists all Jobs, Groups, and Server Accounts of this computer.

Gsync Runner Service

The GSYNC Runner Service runs Auto jobs without requiring the GoodSync GUI to remain open.

/auto-unattended=yes|no - Runs an Auto job in the gs-runner service.

When /auto-unattended=yes is enabled:

  • The job runs through the GoodSync Runner Service.
  • On Windows, the job can run even when the user is logged off.
  • The Runner Service is created when the first job is configured to run in Unattended Auto mode.
  • Do not start the Runner Service command manually. It is started by the operating system.
  • To move the job back to the GoodSync GUI, disable the Unattended option in Job Options.

Global Commands for Server Accounts

Use these commands to create, list, update, rename, delete, and authenticate Server Accounts from the command line.

/sa-list [prefix] - Lists Server Accounts, optionally limited to accounts starting with prefix.

/sa-create - Creates a new Server Account and populates it with ConnectOptions.

/sa-oauth - Performs Browser Authentication (OAuth2) and saves the results in the Server Account.

  • OAuth starting URL examples:
  • goodrive:// - Starts OAuth for Google All Drive.
  • gcp:// - Starts OAuth for Google Cloud Storage.
  • gteamdrive:// - Starts OAuth for Google Team Drive.
  • gdocs3:// - Starts OAuth for Google Docs.
  • dropbox:// - Starts OAuth for Dropbox.
  • box:// - Starts OAuth for Box.com.
  • msgraph:// - Starts OAuth for OneDrive, Office 365, and SharePoint.
  • pcloud:// - Starts OAuth for pCloud.

/sa-update AcctKey/AcctName ConnectOptions - Updates an existing Server Account with ConnectOptions.

/sa-rename AcctKey/AcctName NewAcctName - Renames a Server Account to NewAcctName.

/sa-delete AcctKey/AcctName - Deletes a Server Account by its Key or Name.

/encrypt-plain=clear-password - Generates an encrypted password from a plain-text password.

Global Options

Use these options to configure general GoodSync program behavior, including system tray settings, logging, job sorting, auto-job handling, proxy settings, and SMTP email settings.

General

/sort-jobs-alpha=yes|no - Sorts jobs alphabetically in the Job List view.

/system-tray=yes|no - Shows the system tray icon. Applies to Windows only.

/tray-on-close=yes|no - Sends GoodSync to the system tray when the application is closed. Applies to Windows only.

/compare-prog=<FilePath> - Uses the specified program to compare two files in diff style.

/warn-time-range=yes|no - Warns when file or folder modification time is out of range.

/group-log-lines=yes|no - Groups similar log lines.

/log-retain-days=NNN - Sets the number of days old logs are retained.

Auto

/auto-hide-mini-win=yes|no - Automatically hides the mini window when there is no job activity. Applies to Windows only.

/months-old-gens=NNN - Retains generation history for the specified number of months.

/parallel-auto-jobs=NNN - Sets the maximum number of Auto-mode jobs that can run in parallel.

/auto-jobs-quant=NNN - Sets the time interval, in seconds, for starting Auto jobs.

/encrypted-passwords - Saves connection passwords locally in encrypted form.

Filter

/exclude=<file-mask> - Excludes files and folders that match the specified mask.

/include=<file-mask> - Includes only files and folders that match the specified mask.

/exclude-empty=yes|no - Excludes empty folders.

/exclude-hidden=yes|no - Excludes hidden files and folders.

/exclude-system=yes|no - Excludes system files and folders.

Proxy

/proxy-auto=yes|no - Uses automatic proxy settings from Internet Options > Connections.

/proxy-host=hostname - Uses the specified proxy server.

/proxy-port=port - Sets the proxy server port.

/proxy-userid=<userid> - Sets the proxy user ID for authenticated proxies.

/proxy-passwd=<password> - Sets the proxy password.

/smtp-host=hostname - Sets the SMTP server used for post-analyze and post-sync emails.

SMTP

/smtp-port=port - Sets the SMTP server port.

/smtp-secure=yes|no - Uses SSL to connect to the SMTP server.

/smtp-starttls=yes|no - Uses STARTTLS to connect to the SMTP server.

/smtp-userid=<userid> - Sets the SMTP server user ID.

/smtp-passwd=<password> - Sets the SMTP server password.

/smtp-sender=<name-email> - Sets the sender email address and name.

Job Commands

Use these commands to analyze, sync, create, update, delete, or list GoodSync jobs from the command line.

analyze /all - Analyzes all jobs.
Example: gsync analyze /all

analyze <job list> - Analyzes the listed jobs.
Example: gsync analyze "Job Name"

sync /all - Analyzes and syncs all jobs.
Example: gsync sync /all

sync <job list> - Analyzes and syncs the listed jobs.
Example: gsync sync "Job Name"

job <job name> [<job options>] - Creates a new job or updates an existing job.
Example: gsync job "Backup Job" /f1="file:///C:/Source" /f2="file:///D:/Backup" /dir=ltor

job-new <job name> [<job options>] - Creates a new job.
Example: gsync job-new "Backup Job" /f1="file:///C:/Source" /f2="file:///D:/Backup" /dir=ltor

job-tmp <job name> [<job options>] - Uses a temporary job that is not saved.
Example: gsync job-tmp "Temp Backup" /f1="file:///C:/Source" /f2="file:///D:/Backup" /sync

job-update <job name> [<job options>] - Updates an existing job.
Example: gsync job-update "Backup Job" /deletions=yes /worker-threads=4

job-delete <job name> - Deletes an existing job.
Example: gsync job-delete "Old Backup Job"

job-list - Lists available jobs.
Example: gsync job-list

Job Options

Use these options to run Analyze or Sync after a job has been created or updated.

/analyze - Analyzes the job after it has been created or updated.

/sync - Analyzes and syncs the job after it has been created or updated.

/autoclear - Removes the tree after a successful Sync, or after Analyze when there are no changes in Auto mode.

Job Side URL Connectoid Options

Use these options to define the left and right sides of a job.

/f1=<folder path> - Left folder to sync without using Account Manager.

/f2=<folder path> - Right folder to sync without using Account Manager.

/u1=<folder path> - Left Server Account URL when using Account Manager.

/u2=<folder path> - Right Server Account URL when using Account Manager.

/n1=<folder path> - Left Server Account Name when using Account Manager.

/n2=<folder path> - Right Server Account Name when using Account Manager.

/d1=<folder path> - Left folder path inside the Server Account when using Account Manager.

/d2=<folder path> - Right folder path inside the Server Account when using Account Manager.

Use quotes around paths that contain spaces.

Example: /f1="file:///C:/Source Folder" /f2="file:///D:/Backup Folder"

ConnectOptions and Side Options

These options can be used with Server Account commands or as side options in job commands.

/userid=<userid> - Connection user ID for authentication.

/password=<password> - Connection password for authentication.

/time-trans=yes|no - Uses time translation when file modification time cannot be copied or set.

/bad-certs=yes|no - Allows bad SSL certificates.

/useproxy=yes|no - Uses proxy settings for this connection.

/wininet=yes|no - Uses WinInet instead of native sockets. Applies only to WebDAV.

/utf8=yes|no - Uses UTF-8 or ANSI file name encoding.

/temp-dest-file1 - Uses temporary files when copying on this side.

/hostbased=yes|no - Uses Host-Based Addressing. Applies to S3.

/reduced-redundancy=yes|no - Uses Reduced Redundancy. Applies to S3.

/server-encrypt=yes|no - Uses Server-Side Encryption. Applies to S3.

/accesspolicy=policy - Uses the specified Access Policy. Applies to S3.

/aws4-auth=yes|no - Uses AWS Signature Version 4 authentication. Applies to S3.

/show-native=yes|no - Exports or imports native Google Docs files.

/active=yes|no - Uses active or passive FTP mode.

/mdtm=yes|no - Uses MDTM in FTP.

/mlsd=yes|no - Uses MLSD in FTP.

/implicit=yes|no - Uses Implicit Mode in FTPS.

/listla=yes|no - Uses the List -la option for FTP.

/move-level-only=yes|no - Allows MOVE to work at one folder level. Applies to FTP.

/tls-sess-reuse=yes|no - Requires TLS session reuse. Applies to FTPS.

/pk=<file-path> - Specifies the SFTP/DAV private key path.

/can-otp=yes|no - Enables OTP support for GSTP. This option is non-persistent.

/otp=value - Specifies the OTP value received from the second factor. This option is non-persistent.

 

Job General Options

Use these options to configure the main job behavior, including sync direction, deletions, previous file versions, reconnect attempts, parallel threads, and speed limits. Additional information for 

/dir=2way|ltor|rtol - Sets the job direction: 2-way, left to right, or right to left.

/deletions=yes|no - Propagates deletions.

/fast-1way=yes|no - Enables Fast NoState NoLock 1-way mode.

/create-if-not-found=yes|no - Creates job sync folders if they are not found.

/balloon-msg=none|errors|changes - Shows balloon notifications never, on errors, or on changes.

/save-prev-version=yes|no - Saves deleted or replaced files to _gsdata_/saved. Only the last version is saved.

/cleanup-prev-version=yes|no - Cleans up previous file versions.

/days-prev-version=<number> - Sets the number of days to keep previous file versions.

/save-past-versions=yes|no - Saves deleted or replaced files to _gsdata_/history. Multiple versions are saved.

/cleanup-past-versions=yes|no - Cleans up past file versions.

/days-past-versions=<number> - Sets the number of days to keep past file versions.

/reconnect-secs=<number> - Sets the total number of seconds for reconnect attempts.

/run-parallel-threads=yes|no - Runs parallel threads during Sync.

/worker-threads=N - Sets the number of threads to run in parallel during Sync.

/speed-limit=<number> - Sets the file copy speed limit in Kb/sec.

Job Filter Options

Use these options to control which files and folders are included or excluded when a job is analyzed or synced.
 

/exclude=<file-mask> - Excludes files and folders that match the specified mask.

File masks can use patterns such as *.obj or \folder\file.

Several /exclude options may be provided. Their values are combined and separated by |.

/include=<file-mask> - Includes files and folders that match the specified mask.

File masks can use patterns such as *.obj or \folder\file.

Several /include options may be provided. Their values are combined and separated by |.

/exclude-empty=yes|no - Excludes empty folders.

/exclude-hidden=yes|no - Excludes hidden files and folders.

/exclude-system=yes|no - Excludes system files and folders.

 

Job Auto Options

Use these options to control when a job runs automatically, such as when files change, folders connect, GoodSync starts, a schedule is reached, or a timer runs.
 

/on-file-change=analyze|sync|no - Automatically analyzes or syncs when file changes are detected in local sync folders.

/onfilechange-delay=NNN - Sets the On File Change delay in seconds.

/on-folder-connect=analyze|sync|no - Automatically analyzes or syncs when a folder connects.

/on-start=analyze|sync|no - Automatically analyzes or syncs when GoodSync starts.

/autostart-delay=NNN - Sets the On Start delay in seconds.

/on-timer=analyze|sync|no - Automatically analyzes or syncs on a timer.

/timer-period=<NN> - Sets the timer period in minutes for /on-timer.

/on-logout=sync - Automatically syncs on logoff from the Windows account.

/on-schedule=analyze|sync|no - Automatically analyzes or syncs on a schedule.

/schedule-min=list-of-number-ranges (0 to 59) - Sets the schedule minute.

/schedule-hour=list-of-number-ranges (0 to 23) - Sets the schedule hour.

/schedule-day=list-of-number-ranges (1 to 31) - Sets the schedule day of the month.

/schedule-month=list-of-number-ranges (1 to 12) - Sets the schedule month.

/schedule-dow=list-of-number-ranges (0=Sun to 6=Sat) - Sets the schedule day of the week.

/auto-unattended=yes|no - Runs the Auto job in the gs-runner service.

/limit-changes=<NN> - Does not sync if the percentage of changed files is greater than NN.

/wait-for-locks=yes|no - Waits for lock files instead of producing an error.

/autoclear=yes|no - Automatically clears the sync tree after Sync.

Conflict Options

/resolve-weak-conflicts=yes|no - Automatically resolves weak conflicts when one side has no generations.

/autoresolve=no|left|right|newer|stopsync - Sets the Auto-Resolve Conflicts option.

/rename-losing-file=yes|no - Renames the losing file in a conflict instead of deleting it.

Script Options

Use these options to run a program or send an email before or after a job Analyze or Sync operation.

/pre-analyze-action=<file-path> - Runs the specified program before Analyze.

/post-analyze-action=<email>|<file-path> - Sends an email or runs the specified program after Analyze.

/post-sync-action=<email>|<file-path> - Sends an email or runs the specified program after Sync.

 

Advanced Options

Sync Time Options

Use these options to control how files are handled during Sync, including file times, attributes, permissions, move behavior, locked files, and files that change after Analyze.

/do-not-sync-changed-files=yes|no - Does not sync files that changed after Analyze.

/wait-sync-after-analyze=seconds - Waits the specified number of seconds after Analyze before starting Sync.

/copy-create-time=yes|no - Copies file and folder creation time.

/copy-attrs=yes|no - Copies file and folder attribute bits, such as rwx.

/copy-ext-attrs=yes|no - Copies extended attributes. Applies to Mac only.

/copy-owner=yes|no - Copies file and folder owner information. This is not needed when /copy-acl is enabled.

/copy-acl=yes|no - Copies ACL security information, including owner and ACL.

/move-mode=yes|no - Deletes the source after copy to emulate Move.

/delete-empty-folders-on-move=yes|no - Deletes empty folders when using Move Mode.

/copy-locked=yes|no - Copies locked files using Shadow Copy Service.

/uber-unlocked=yes|no - Enables Uber-Unlocked mode, allowing deletion of files that are being read.

Analyze Time Options

Use these options to control how files are compared during Analyze, including checksums, move detection, symbolic links, required space estimates, and destination-side changes.

/compare-md5=yes|no - Compares all files using MD5 checksums during Analyze.

/detect-moves=yes|no - Detects file and folder moves and renames instead of processing them as Copy and Delete.

/ignore-changes-on-dest-side - Ignores changes on the destination side.

/est-req-space=yes|no - Estimates the required free space needed for Sync.

/links=ignore|copy-asis|drill-down - Sets how symbolic links are processed.

/copy-original-fs-names=yes|no - Keeps original file system names and does not change prohibited symbols. Applies to Mac-to-Mac jobs.

Left/Right Side Folder Options

Use these options to configure settings for the left or right side of a job, including comparison rules, State File behavior, temporary files, compression, encryption, and file system handling.

/compare-checksums=yes|no - Compares checksums when needed on the left or right side.

/compare-ext-attrs=yes|no - Compares extended attributes on the left or right side.

/compare-attrs=yes|no - Compares attributes on the left or right side.

/compare-owner=yes|no - Compares owner information on the left or right side.

/compare-acl=yes|no - Compares ACL security information on the left or right side.

/no-gsdata=yes|no - Does not create or use the _gsdata_ folder on the left or right side.

/no-listdir=yes|no - Does not perform ListDir and trusts the State File on the left or right side.

/temp-dest-file=yes|no - Uses temporary files when copying to the left or right side.

/compress-type=no|plain|deflate - Sets the method used to compress file bodies on the left or right side.

/cipher-type=no|zipcrypto|aes-256 - Sets the method used to encrypt file bodies on the left or right side.

/encrypt-files=yes|no - Encrypts file bodies on the left or right side.

/encrypt-paths=yes|no - Encrypts file paths on the left or right side.

/encrypt-password=str - Sets the encryption password for the left or right side.

/fat-like= - Treats this side as a FAT-like file system.

/compress=yes|no - Prefers compressed files on this side.

/uncompress=yes|no - Prefers uncompressed files on this side.

Related articles

Powered by Zendesk