// Docs

The command line

Comparing, merging, reporting and running scripts from a terminal, and what every exit code means.

The command is geecompare. Install it on your PATH from Preferences › Integration (“Install the geecompare command”); on macOS and Linux it is a small launcher, on Windows the installer puts the program’s folder on the path.

Opening a comparison

geecompare <a> <b>                     # compare two files or folders
geecompare <a> <b> <base> -o <out>     # three-way merge, the result goes to out

With no --fv the session type comes from what the two sides are. These switches work with a window:

Switch What it does
--wait Return only when the window closes (this is what git difftool needs)
--readonly Both sides open read-only
--lefttitle=, --righttitle= Show these titles instead of the paths
--fv=<view> Force the session type: text, folder, table, hex, picture, textmerge, foldermerge, sync
--session=<name> Open a saved session by name

Without a window

Switch What it does
--quick[=rules|binary|crc|size|timestamp] Compare and return the exit code, print nothing. --qc is the same switch
--report=<settings> <a> <b> <out> Write a report of the comparison to <out>, using a saved report settings file
--automerge <a> <b> <base> -o <out> Merge and write the output; conflicts make it fail unless a side is favoured
--favor-left, --favor-right An automerge’s conflicts take that side (needs --automerge)
--script=<file> [%1 …] Run a script, headless; the arguments after it become %1…%9
--silent Print nothing while a script runs (only with --script)

A combination that cannot mean anything is refused with the reason instead of being guessed at: --silent without --script, --favor-left without --automerge, a report of a merge, --readonly on a merge, and so on.

Beyond Compare scripts (.bcs) are not run directly. Import them in a script session, where the converter shows what it changed; see scripting.

Exit codes

Code Meaning
0 Success
1 Binary same
2 Same by the rules
11 Binary different
12 Similar
13 Different by the rules
14 Conflicts
100 Unknown error
101 Conflicts, the merge result was not written
102 Could not wait for the main program
103 The GeeCompare main program is missing
104 Licence invalid or trial expired
105 The script file could not be read
106 Script syntax error
107 The script could not load a file or folder

Codes 1 and 2 (and 11, 12, 13) tell “same because the bytes are equal” from “same because the rules say so”, which is what makes --quick=rules useful in a build: a file that differs only in a comment or in line endings can be allowed through while a real change stops the build. GeeCompare is free and never returns 104; it is in the table because Beyond Compare’s scripts know it.

Examples

# Is anything different, ignoring what the rules call unimportant?
geecompare --quick=rules build/out dist/out || echo "differs ($?)"

# A nightly HTML report of two trees
geecompare --report=~/reports/folders.gcrs /srv/a /srv/b /tmp/report.html

# Resolve a merge without a window, keeping our side on conflicts
geecompare --automerge --favor-left mine.c theirs.c base.c -o merged.c

# Run a script with three arguments
geecompare --script=nightly.gcs /srv/a /srv/b /var/log/compare

Last updated: 2026-11-22