Troubleshooting and FAQ¶
This page answers common questions about CompareCraft.
Files show as different but their contents are the same¶
In Folder Compare, files are compared by size and timestamp by default. Two files with the same contents count as different when their timestamps differ by more than the tolerance (2 seconds), for example after a copy that did not keep the original timestamps.
- To check the contents of particular files, select them and choose Actions > Compare Contents…. See Compare contents.
- To always compare contents, open Session > Session Settings…, go to the Comparison tab and turn on Compare contents. See Comparison criteria.
- If the timestamps differ by exactly one hour or by whole hours, turn on Ignore daylight saving time differences or Ignore timezone differences in the same tab.
Files show as the same but they are different¶
Folder Compare does not open files unless you ask it to compare contents. Two files with the same size and timestamp count as the same, even if their contents differ. Turn on Compare contents as described above, or use Actions > Compare Contents… with Binary comparison.
Text Compare shows differences in blue¶
Blue differences are unimportant: by default, differences in whitespace and character case are unimportant. They are still differences, so the files are not identical. To make them count as important, click ⚙ Rules and clear the corresponding boxes. See Comparison rules.
Line endings and encodings¶
Text Compare compares the text of each line. A file with Windows line endings (CRLF) and a file with Unix line endings (LF) show no line differences if the text is the same. The encoding and line ending of each file are shown below its path. See Encodings and line endings.
Because the files differ byte by byte, a binary comparison still reports them as different. Quick compare on the Home view tells you whether files are "binary same" or only "the same according to comparison rules".
A text file opens as binary¶
CompareCraft treats a file as binary when it contains a zero byte in its first 8 KB, unless the file starts with a UTF-16 byte order mark. Such files open in Hex Compare when CompareCraft chooses the viewer automatically. If one of the files in a Text Compare looks binary, a banner offers Open in Hex Compare.
To force a viewer, start the comparison from the matching card on the Home view, or, in Folder Compare, right-click the file and choose the viewer from the Open With submenu.
Large files¶
Hex Compare aligns files of up to 256 MB. Larger files are always compared byte by byte by position, and a banner says so. See Alignment.
Windows or macOS warns about the download¶
The downloads are not code-signed yet.
- On Windows, if SmartScreen warns you, choose More info, then Run anyway.
- On macOS, the first time you start CompareCraft, right-click it in Applications and choose Open.
Script or quick compare output does not appear on Windows¶
On Windows, the comparecraft program has no console, so the output of scripts and quick compares is not shown. Use the console version, ccomp.exe, which is installed next to comparecraft. It takes the same arguments, prints its output to the console and returns the result as its exit code. See Console Program.
ccomp looks for comparecraft in its own folder and then on the PATH. If it cannot find it, set the environment variable COMPARECRAFT_GUI to the full path of the CompareCraft program.
A new comparison opens in the existing window¶
CompareCraft runs as a single instance. When it is already running, a comparison started from the command line or a file manager opens as a new tab in the existing window, and the command returns immediately. To wait until the comparison window is closed, for example in a build script or a version control tool, use ccomp.
File-manager context menu commands are missing¶
First enable the desired commands under Tools > Options > Startup > File manager integration.
File and folder actions have separate checkboxes. Check any provider-availability warnings on that page;
the file manager needs the native provider from the updated CompareCraft package. GNOME Files also needs
nautilus-python (python3-nautilus on Debian). See File manager integration.
Restart the file manager after installing or updating a native provider. Thunar can keep its background daemon running after all windows are closed, so opening another window may still use the old process. Finish any file operations, then run:
This closes all Thunar windows, exits the daemon, and opens a fresh process that discovers the installed provider. If the updated package is already installed, no rebuild or reinstall is needed. Later changes to the selected left file or folder are read when the context menu opens and do not require restarting Thunar.
The menu also depends on the selection: one file or folder offers the matching Select Left action; two files offer Compare and Merge; two folders offer Compare and Sync. Only enabled actions appear. A mixed selection or more than two items offers no CompareCraft actions.
Finder extension is missing or does not show actions¶
The native Finder integration is experimental and requires macOS 12 or later. Install the complete
CompareCraft.app in Applications, not just its command-line executable. Open the app and apply the desired
actions under Tools > Options > Startup > File manager integration, then enable CompareCraft in System
Settings's Finder Extensions section. Its location varies by macOS version; search Settings for Extensions.
Options reports missing bundles or shared App Group access failures. Source builds are ad-hoc signed by default; a successful compile is not proof that macOS authorizes extension loading. Use matching, authorized signing and App Group entitlements for the host and extension. Do not disable Gatekeeper, SIP, or sandboxing.
Check registration with pluginkit -m -A -D -i dev.comparecraft.app.finder. If needed, register the installed
extension with pluginkit -a /Applications/CompareCraft.app/Contents/PlugIns/CompareCraftFinder.appex and then
enable it in Settings. If an older build is cached, toggle the extension off/on; do not restart Finder during
file operations. Remove duplicate app copies from test locations.
Test inside your home directory or a mounted volume under /Volumes, using a selection supported by the
menu rules above. An inaccessible/deleted staged item is hidden. If a right-item action never appears, check
Console for CompareCraft Finder or sandbox messages, particularly App Group or bookmark failures.
Native signing, sandbox access, host launching and interactive Finder behavior still need community testing.
Reset the settings¶
- Choose Tools > Restore Factory Defaults… to reset all options, colors, shortcuts and presets. Your sessions are kept.
- If CompareCraft does not start properly, close it and delete
settings.jsonfrom the settings folder.
See Settings and Data Locations for where the settings folder is.
A keyboard shortcut does not work¶
Shortcuts belong to a view, and many commands are only available when something is selected. Press Shift+F1 to see the shortcuts of the current view. If you have changed shortcuts, check the Toolbars, Shortcuts page of the Options, which warns when a shortcut is assigned to more than one command.
Features that are not available yet¶
The following are not implemented yet:
- folder merge and three-way folder compare
- source-control integration
- media, registry and version-information compare; picture metadata compare
- archives as folders; FTP/SFTP and cloud locations
Report a problem¶
Report bugs and suggest features in the CompareCraft issue tracker. Include your operating system, the CompareCraft version (Help > About CompareCraft) and the steps to reproduce the problem.