Pages on remixware.com

About

Mon, 01 Jan 0001 00:00:00 +0000

remixware.com is the home of Remixware, a free tool that finds code in your project that came from open source, names the licence it came with, and tells you what that licence asks of you. It runs on your own machine and reads your code there. It sends nothing anywhere unless you ask it to check with SCANOSS, and then only fingerprints of your files go out.

Why It Exists

Code moves between projects all the time, and it rarely comes with a note saying where it was before. Each copy carries the terms of the project it came from, and those terms don’t show in the code. An MIT helper needs its copyright line kept. A GPL function can force the whole program it lands in to go out under the GPL.

Contact

Mon, 01 Jan 0001 00:00:00 +0000

remixware.com would like to hear from:

Anyone trying Remixware out. What it found, what it missed, and what you used before.
Anyone who found a bug. A copy it didn’t report, a match it shouldn’t have made, or a licence it read wrong.
Anyone with an idea for a licence, a language or a report format it should handle.

Write to info@remixware.com.

Bug reports are also welcome on GitHub. It helps to include what remixware version prints, your operating system, and a small example that shows the problem. Please don’t send your company’s private code: two small files that show the same match are enough.

Download Remixware

Mon, 01 Jan 0001 00:00:00 +0000

The remixware command is one file with nothing else to install. Each archive below holds it with its license files and the manual. The links always point to the latest release.

System	Download
Linux, x86-64	remixware_linux_amd64.tar.gz
Linux, ARM64	remixware_linux_arm64.tar.gz
macOS, Apple silicon	remixware_darwin_arm64.tar.gz
macOS, Intel	remixware_darwin_amd64.tar.gz
Windows, x86-64	remixware_windows_amd64.zip

Checksums are in SHA256SUMS. Every release is listed on GitHub.

Install

Each archive holds the program next to its README and licence files, with no folder around them, so unpack it into an empty folder. On Linux or macOS, using the name of the archive you downloaded:

Quick Start

Mon, 01 Jan 0001 00:00:00 +0000

This page takes you from nothing to a first report in a few minutes. You need the remixware command (see Download) and a project to check.

1. Pick What to Compare With

Remixware compares your code with code you give it. It doesn’t come with a copy of all the world’s open source, so the first step is an index of the code you want to check against. Good first choices are the dependencies that already sit on your disk:

Reference

Mon, 01 Jan 0001 00:00:00 +0000

Every command, option, status and file format in Remixware 0.2. The README that ships with the program covers the same ground.

Commands

remixware index <folder>... [--out FILE]      fingerprint third-party code into an index
remixware scan [project] --index FILE         compare a project with indexes, list the matches
remixware check [project] --index FILE        the same, as a pass/fail gate for CI
remixware notice [project] --index FILE       write third-party notices for what you copied
remixware licenses                            list the licences Remixware knows
remixware version

scan, check and notice compare the project with --index files, with --from results files, with the SCANOSS service (--scanoss), or with any mix of them. The project defaults to the current folder. Flags can come before or after it, and remixware help <command> lists a command’s flags.