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.
GSYNC does not display the GoodSync graphical interface and remains open until the requested job or action finishes. On Windows and Mac, GSYNC requires a GoodSync Personal license or higher.
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
- GSYNC Command Line Reference
- GSYNC Quick Start
- Command Syntax Guide
- Understanding Command Scope
- Common GSYNC Examples
- Safety and Security
- Profile Options
- Run Options
- GSYNC Runner Service
Global Commands and Options
- Global Commands
- Global Commands for Server Accounts
- Global Options
- Global Options: General
- Global Options: Auto
- Global Options: Filter
- Global Options: Proxy
- Global Options: SMTP
Job Commands and Options
- Job Commands
- Job Options
- Job Side URL and Connectoid Options
- ConnectOptions and Side Options
- Job General Options
- Job Filter Options
- Job Auto Options
- Conflict Options
Advanced Options
- Script Options
- Advanced Options Overview
- Sync Time Options
- Analyze Time Options
- Left/Right Side Folder Options
Automation and Support
GSYNC Quick Start
Use the following workflow to verify GSYNC, locate an existing job, review its proposed changes, and then run it.
Before you begin: Confirm that GoodSync is installed and licensed, and open Command Prompt, PowerShell, Terminal, or your preferred shell.
-
Confirm the installed GoodSync version and license:
gsync /version -
List the jobs available in the active GoodSync profile:
gsync job-list -
Analyze the job to review the proposed changes:
gsync analyze "Job Name" -
After reviewing the Analyze results, run the job:
gsync sync "Job Name"
Important: Run Analyze and review the proposed changes before the first Sync, especially when the job allows deletions, uses Move Mode, or runs in a one-way direction.
Command Syntax Guide
GSYNC requires options to be entered in the correct order. Profile Options come first, followed by Run Options, Global Options, the command, and its applicable Job Options.
gsync [profile-options] [run-options] [global-options] job-command [job-options]
For a Global Command that does not run a job, use:
gsync [profile-options] global-command
| Notation | Meaning |
|---|---|
| <value> | Replace the placeholder with an actual value. |
| [option] | The option is optional. |
| yes|no | Select one of the available values. |
| 1 or 2 suffix | Use 1 for the Left side and 2 for the Right side. |
| "Job Name" | Use quotation marks when a job name or path contains spaces. |
Important: Do not mix Job Options with Global Options or place Global Options before Profile Options. GSYNC enforces option order.
Understanding Command Scope
Each command or option applies to a particular area of GoodSync. Confirm the option scope before adding it to a command.
| Scope | Purpose |
|---|---|
| Profile | Selects the GoodSync profile, job list, and logging location. |
| Run | Controls output and behavior for the current GSYNC process. |
| Global | Controls GoodSync program-level actions and settings. |
| Job | Creates, updates, analyzes, syncs, or configures a specific job. |
| Connectoid | Defines a job folder URL, Server Account, or connection setting. |
| Side | Applies to the Left side with suffix 1 or the Right side with suffix 2. |
Common GSYNC Examples
List all available jobs:
gsync job-list
Analyze one existing job:
gsync analyze "Job Name"
Analyze and sync one existing job:
gsync sync "Job Name"
Analyze and sync all jobs:
gsync sync /all
Create a one-way local backup job: gsync job-new "Local Backup" /f1="file:///C:/Source" /f2="file:///D:/Backup" /dir=ltor /deletions=no /analyze
Create a two-way synchronization job: gsync job-new "Two-Way Sync" /f1="file:///C:/Folder A" /f2="file:///D:/Folder B" /dir=2way /analyze
Run a temporary job without saving it: gsync job-tmp "Temporary Backup" /f1="file:///C:/Source" /f2="file:///D:/Backup" /dir=ltor /analyze
Create a Linux local backup job: gsync job-new "Linux Backup" /f1="file:///home/user/Documents" /f2="file:///mnt/backup/Documents" /dir=ltor /deletions=no /analyze
Configure an existing job to run every day at 2:00 AM: gsync job-update "Backup Job" /on-schedule=sync /schedule-hour=2 /schedule-min=0
To process jobs configured for Auto Mode, start GSYNC using gsync /runner.
Safety and Security
Review the following considerations before using GSYNC in production scripts or unattended environments.
- Analyze before Sync: Run Analyze and review the proposed changes before the first Sync or after changing job options.
- Deletion options: /deletions=yes propagates deletions to the other side. Confirm the job direction and filters first.
- Move Mode: /move-mode=yes deletes source files after they are copied.
- Lock files: /override-locks=yes can override protection created by another active job. Use it only after confirming that no other GoodSync or GSYNC process is using the folders.
- State File behavior: /no-gsdata1=yes or /no-gsdata2=yes prevents GoodSync from using its normal State File folder on that side and can change how job history is tracked.
- Certificate validation: /bad-certs1=yes or /bad-certs2=yes disables normal SSL certificate validation for that side and should only be used in a controlled environment.
- Passwords: Passwords entered directly in a command may be visible in shell history, scripts, logs, or active process information.
- Profile selection: Confirm the active profile before updating or deleting jobs. The same job name may exist in another GoodSync profile.
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
/smtp-host=hostname - Sets the SMTP server used for post-analyze and post-sync emails.
/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=<full folder URL> - Full URL for the Left sync folder.
/f2=<full folder URL> - Full URL for the Right sync folder.
/u1=<account URL> - Left-side URL of a Server Account saved in Account Manager.
/u2=<account URL> - Right-side URL of a Server Account saved in Account Manager.
/n1=<AccountName> - Left Server Account name. Requires /u1.
/n2=<AccountName> - Right Server Account name. Requires /u2.
/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.
/userid1=<userid> /userid2=<userid> - Connection user ID for the Left or Right side.
/password1=<password> /password2=<password> - Connection password for the Left or Right side.
/time-trans1=yes|no /time-trans2=yes|no - Uses time translation when file modification time cannot be copied or set.
/bad-certs1=yes|no /bad-certs2=yes|no - Disables normal SSL certificate validation on the Left or Right side.
/useproxy1=yes|no /useproxy2=yes|no - Uses proxy settings on the Left or Right side.
/wininet1=yes|no /wininet2=yes|no - Uses WinInet instead of native sockets for DAV, S3, or FTP on the Left or Right side.
/utf8-1=yes|no /utf8-2=yes|no - Uses UTF-8 or ANSI file name encoding on the Left or Right side.
/temp-dest-file1=yes|no /temp-dest-file2=yes|no - Uses temporary files when copying to the Left or Right side.
/hostbased1=yes|no /hostbased2=yes|no - Uses Host-Based Addressing for S3 on the Left or Right side.
/reduced-redundancy1=yes|no /reduced-redundancy2=yes|no - Uses Reduced Redundancy for S3 on the Left or Right side.
/server-encrypt1=yes|no /server-encrypt2=yes|no - Uses Server-Side Encryption for S3 on the Left or Right side.
/accesspolicy1=<policy> /accesspolicy2=<policy> - Uses the specified S3 Access Policy on the Left or Right side.
/aws4-auth1=yes|no /aws4-auth2=yes|no - Uses AWS Signature Version 4 authentication on the Left or Right side.
/show-native1=yes|no /show-native2=yes|no - Exports or imports native Google Docs files on the Left or Right side.
/active1=yes|no /active2=yes|no - Uses active or passive FTP mode on the Left or Right side.
/mdtm1=yes|no /mdtm2=yes|no - Uses MDTM for FTP on the Left or Right side.
/mlsd1=yes|no /mlsd2=yes|no - Uses MLSD for FTP on the Left or Right side.
/implicit1=yes|no /implicit2=yes|no - Uses Implicit Mode for FTPS on the Left or Right side.
/listla1=yes|no /listla2=yes|no - Uses the LIST -la option for FTP on the Left or Right side.
/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.
/pk1=<file-path> /pk2=<file-path> - Specifies the SFTP private key or DAV/GSTP certificate path for the Left or Right side.
/can-otp1=yes|no /can-otp2=yes|no - Enables OTP support for GSTP on the Left or Right side. This option is non-persistent.
/otp1=value /otp2=value - Specifies the OTP value for the Left or Right side. 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.
/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
Use these options to control file handling during Analyze and Sync, including comparison methods, metadata, permissions, locked files, symbolic links, and side-specific folder behavior.
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-checksums1=yes|no /compare-checksums2=yes|no - Compares checksums when needed on the Left or Right side.
/compare-ext-attrs1=yes|no /compare-ext-attrs2=yes|no - Compares extended attributes on the Left or Right side.
/compare-attrs1=yes|no /compare-attrs2=yes|no - Compares attributes on the Left or Right side.
/compare-owner1=yes|no /compare-owner2=yes|no - Compares owner information on the Left or Right side.
/compare-acl1=yes|no /compare-acl2=yes|no - Compares ACL security information on the Left or Right side.
/no-gsdata1=yes|no /no-gsdata2=yes|no - Does not create or use the _gsdata_ folder on the Left or Right side.
/no-listdir1=yes|no /no-listdir2=yes|no - Does not perform ListDir and trusts the State File on the Left or Right side.
/temp-dest-file1=yes|no /temp-dest-file2=yes|no - Uses temporary files when copying to the Left or Right side.
/compress-type1=no|plain|deflate /compress-type2=no|plain|deflate - Sets the method used to compress file bodies on the Left or Right side.
/cipher-type1=no|zipcrypto|aes-256 /cipher-type2=no|zipcrypto|aes-256 - Sets the method used to encrypt file bodies on the Left or Right side.
/encrypt-files1=yes|no /encrypt-files2=yes|no - Encrypts file bodies on the Left or Right side.
/encrypt-paths1=yes|no /encrypt-paths2=yes|no - Encrypts file paths on the Left or Right side.
/encrypt-password1=str /encrypt-password2=str - Sets the encryption password for the Left or Right side.
/fat-like1=yes|no /fat-like2=yes|no - Treats the Left or Right side as a FAT-like file system.
/compress1=yes|no /compress2=yes|no - Uses NTFS compression on the Left or Right side.
/uncompress1=yes|no /uncompress2=yes|no - Removes NTFS compression on the Left or Right side.
Return and Exit Codes
GSYNC returns the exit code for the last job that ran. Automation scripts can use this value to determine whether the job completed, stopped, encountered an error, or finished with conflicts.
| Code | Result |
|---|---|
| 0 | Normal completion: Analyze found no changes or Sync completed successfully. |
| 1 | Analyze did not finish because it was stopped by the user. |
| 2 | Analyze did not finish because of a terminal error, such as a missing sync folder. |
| 3 | Analyze finished with non-terminal errors and possibly conflicts. |
| 4 | Analyze finished with conflicts but no errors. |
| 11 | Sync did not finish because it was stopped by the user. |
| 12 | Sync did not finish because of a terminal error, such as a missing sync folder. |
| 13 | Sync finished with non-terminal errors and possibly conflicts. |
| 14 | Sync finished with conflicts but no errors. |
| Negative value | An error occurred while starting GSYNC. |
Important: Review the job log even when a command completes. Some non-terminal conditions may only be recorded in the log.
Check the most recent exit code in Command Prompt:
echo %ERRORLEVEL%
Check the most recent exit code in PowerShell:
$LASTEXITCODE
Check the most recent exit code in macOS or Linux:
echo $?
Redirect command output to a Windows log file:
gsync sync "Job Name" > "C:\Logs\GoodSync.log" 2>&1
Redirect command output to a macOS or Linux log file:
gsync sync "Job Name" > "/var/log/goodsync.log" 2>&1
Troubleshooting GSYNC
| Issue | Recommended check |
|---|---|
| GSYNC command is not found | Confirm that GoodSync is installed and run GSYNC from its installation folder or add that folder to the system PATH. |
| Job is not found | Run gsync job-list, verify the exact job name, and confirm that the correct profile is loaded. |
| Path or job name contains spaces | Place the complete job name or path inside quotation marks. |
| Access denied | Confirm the permissions of the user or service account running GSYNC on both job folders. |
| Authentication fails | Verify the Server Account, user ID, password, private key, OAuth authorization, and side-specific option suffix. |
| Job is locked | Confirm that another GoodSync or GSYNC process is not already using the same sync folders before overriding a lock. |
| Unexpected changes are detected | Run Analyze only, review the direction, filters, deletion settings, State File options, and active profile before running Sync. |
| More log detail is needed | Increase the log detail using /ll=<number> and direct stdout to a log file. |
To view the command list available in the installed version, run gsync /help or gsync /?.
GSYNC Glossary
Analyze - Compares both job sides and determines the changes that Sync would perform.
Sync - Applies the actions determined during Analyze.
Job - A saved set of sync folders, direction, filters, and operating options.
Profile - The GoodSync configuration location containing jobs, Server Accounts, program options, and logs.
Left and Right sides - The two folders or file systems compared by a GoodSync job.
Server Account - A saved connection and authentication configuration for a supported file system.
Connectoid - The connection properties used to reach a local, network, or remote file system.
State File - GoodSync data used to track previous job state and determine changes between runs.
Runner - A background GSYNC process that starts and runs jobs configured for Auto Mode.
Auto Mode - Job settings that trigger Analyze or Sync based on events, schedules, timers, or folder availability.
stdout - Standard command output that can be displayed in the terminal or redirected to a file.
For the commands supported by the installed version of GoodSync, always use gsync /help as the version-specific reference.