// Docs

Scripting

The script language, every command it has, how arguments are passed, and how a Beyond Compare script is imported.

A script is a text file of commands, one per line, run without a window:

geecompare --script=nightly.gcs /srv/a /srv/b /var/log/compare

The arguments after the script become %1 … %9; %date%, %TEMP% and the other environment variables are expanded as well. A line ending in & continues on the next line, and # starts a comment. The script session (Home › Script) is the same language with an editor, a command reference, a run panel that shows each line as it executes, and the exit code it ended with.

A script

log verbose "%TEMP%/nightly.log"
option confirm:yes-to-all
option stop-on-error
criteria timestamp:2sec size crc
filter "*.dll;*.so;*.dylib;*.json;-*.pdb;-obj\;-.cache\"
load "%1" "%2"
expand all
select left.newer.files left.orphan.files
compare rules-based
copy left->right
sync create-empty mirror:left->right
folder-report layout:side-by-side options:display-mismatches,column-crc &
    output-to:"%3/folders.html" output-options:html-color

The commands

The session

Command Syntax What it does
load load <left> [<right>] [<centre>] Load two folders (or files, snapshots, saved connections) and start comparing
criteria criteria <criterion>… What counts as equal: timestamp[:2sec], ignore-dst, size, crc, binary, rules-based
filter filter "<include>;-<exclude>" Name filter, semicolons between, - for exclude
expand / collapse expand <selector>|all Unfold folders (which reads them) or fold them again
select select <selector>… Choose items: left.newer.files, right.orphan.folders, left.diff.files, …
compare compare binary|crc|rules-based Compare the contents of what is selected

Files

Command Syntax What it does
copy copy left->right Copy what is selected to the other side
copyto copyto left|right|all path:<how> "<target>" Copy to a third place (path:relative, path:base, path:flat)
move / moveto move left->right Move to the other side, or to a third place
delete delete <selector> Delete what is selected (to the Trash with option recycle-bin)
rename rename "<old>" "<new>" Rename one item
touch touch left->right Set times
attrib attrib [+-]r [+-]a [+-]h [+-]s <selector> DOS attributes (skipped on file systems without them)
sync sync [create-empty] update|mirror:<direction> Synchronise the two sides

Snapshots and reports

Command Syntax What it does
snapshot snapshot save-crc left output:"<file>" Write a file system snapshot (names, sizes, times, optionally CRCs)
folder-report folder-report layout:… options:… output-to:… A report of the folder comparison, optionally with a report per differing file
text-report, table-report, hex-report, picture-report … layout:… output-to:… A report of the selected files, in that session’s shape

Control

Command Syntax What it does
option option confirm:yes-to-all|stop-on-error|recycle-bin How the run behaves
log log normal|verbose [append:]"<file>" Write a log
# # <text> A comment

The run ends with an exit code: 0 when everything ran, 105–107 when the script could not be read, parsed or loaded, and the comparison codes when the script’s last comparison decides the answer.

Importing a Beyond Compare script

Beyond Compare scripts are converted, never run as they are. In a script session, choose “Import BC” and pick the .bcs file: the original is shown on the left, the converted script on the right, line by line, and each line is marked

  • Converted — the same command, the same meaning;
  • Adjusted, with the reason — ;IgnoreDST becomes the ignore-dst criterion, a fixed C:\logs path becomes %TEMP%, fixed paths in load become %1 and %2 (with the original values kept in a comment at the top), BC 3’s file-report becomes text-report;
  • Unsupported, with the reason — for example an FTP address written straight into a copyto: GeeCompare connects only to a saved remote connection, whose password is in the system keychain, so that line has to become a load of that connection.

“Keep unsupported lines as comments” decides whether those lines come along commented out. Importing replaces the editor’s content and can be undone.

Last updated: 2026-11-22