Similarity Helper / Docs / Getting started
GETTING STARTED / 02

Start with two projects,
finish with evidence.

Similarity Helper is a local CLI. Prepare Project A, Project B and a JSON configuration; the tool scans, parses and compares them on your machine, then writes reports locally.

No source uploadConfiguration-drivenDefault output: output

1. Prepare the projects

Place the repository or release bundle locally and confirm that start.py is available. The two iOS / Xcode projects can be separate projects or different versions of one project.

cd /path/to/SimilarityHelper
python3 start.py

Follow the CLI prompts to choose Project A, Project B and a configuration file. The homepage's copy-command button uses the same entry point.

2. Choose a configuration

Configuration controls file types and comparison rules. Start from an existing JSON example and adjust it for the projects at hand.

{ "exclude_dirs": ["Frameworks", "Demo"], "Pod_and_Framework_dirs": [] }

Useful options include:

  • Parser strategy: the example report uses the compiler parser.
  • Code types: .h, .m, .mm, .pch and .swift.
  • Resource types: layout, image, audio and video extensions.
  • Exclusions: directories such as Pods, build and DerivedData; hidden-file handling is configurable.
  • String threshold: min_compare_string_length sets the minimum length for string comparison.

3. Read the output

When the run finishes, reports are written to the configured output directory. The example configuration uses output; filenames include the run time and project names.

OutputBest forMain contents
HTMLBrowser reviewCategory summaries, totals, matching items, similarity and path relationships.
JSONAutomation and archivingOverall similarity, code comparison, resource comparison and structured fields.
LOGRun troubleshootingScan, parse, compare and write stages with timestamps.

4. Local processing and privacy

This is not an online upload service. Project paths, configuration and analysis results are processed locally; the public website only provides product documentation and a sanitized real-report snapshot.

Before sharing a report: check for absolute paths, internal domains or matching strings that should remain private. The public example already removes local absolute paths.