Installation

jscpd is a self-contained native binary — no Node.js runtime required. Install via curl, PowerShell, npm, pip, cargo, Homebrew, or Nix.

Using curl (macOS & Linux)

One command installs the cpd binary for your platform:

curl -fsSL https://jscpd.dev/install.sh | bash

Using PowerShell (Windows)

Installs a native Windows executable — no Node.js, Git Bash, or WSL required:

irm https://jscpd.dev/install.ps1 | iex

By default it installs jscpd.exe (and the cpd.exe alias) to %USERPROFILE%\.local\bin, and prints the command to add that directory to your PATH. Both x64 and ARM64 are detected automatically.

To pass options, run the script rather than piping it:

&([scriptblock]::Create((irm https://jscpd.dev/install.ps1))) -Version 5.1.0 -Prefix C:\tools

Supported switches: -Version, -Prefix, -Force (overwrite an existing binary), -DryRun.

By default the shell installer puts jscpd (and the cpd alias) in ~/.local/bin, and prints the command to add that directory to your PATH. Install to a custom directory:

curl -fsSL https://jscpd.dev/install.sh | bash -s -- --prefix ~/.local/bin

Install a specific version:

curl -fsSL https://jscpd.dev/install.sh | bash -s -- --version 5.2.1

Both installers download from GitHub Releases (primary) and fall back to the npm registry. Between them they cover macOS (arm64/x64), Linux (x64 and arm64, glibc and musl), and Windows (x64 and ARM64 MSVC).

The shell installer verifies every download before it installs anything: release archives are checked against the checksums.txt published with the release, npm tarballs against the integrity hash the registry reports. A mismatch aborts the install. Pass --version for a reproducible install — without it the newest release is resolved at run time.

Using npm

The npm package installs a native binary for your platform:

npm install -g jscpd@5

Using cargo

If you have Rust installed, install directly from crates.io:

cargo install jscpd

This installs both the jscpd and cpd commands.

Using pip, pipx or uv

The PyPI package ships the same prebuilt binary as platform wheels, so Python projects can install jscpd without Node.js:

pip install jscpd
# or, isolated:
pipx install jscpd
uv tool install jscpd

Run without installing:

uvx jscpd /path/to/source

Installs both the jscpd and cpd commands. For a Node-free pre-commit hook, use language: python with additional_dependencies: ['jscpd==5.2.1'].

Using Homebrew

If you use Homebrew on macOS or Linux:

brew install jscpd

Using Nix

Install with Nix (installs both jscpd and cpd commands):

nix profile install github:kucherenko/jscpd

Or run without installing:

nix run github:kucherenko/jscpd -- /path/to/source

Using Docker

A multi-arch (amd64/arm64) distroless image is published to GitHub Container Registry with every release (v5.1.2+). Mount the project at /src:

docker run --rm -v "$PWD:/src" ghcr.io/kucherenko/jscpd

Tags: latest, 5, 5.1, and the exact version. The image contains only the static binary — --blame and --baseline-from-ref need git, which is not included. On Linux hosts, add --user "$(id -u):$(id -g)" so report files are owned by you rather than root.

Using npx (No Installation)

Run jscpd directly without installing (downloads the native binary on first run):

npx jscpd@5 /path/to/source

Using yarn

yarn global add jscpd@5

Using pnpm

pnpm add -g jscpd@5

Platform Binaries

Direct downloads are available for each platform:

Basic Usage

jscpd /path/to/source

jscpd --pattern "src/**/*.js"

jscpd /path/to/source --reporters html

Configuration

Create a .jscpd.json file in your project root:

{
  "threshold": 0,
  "reporters": ["html", "console"],
  "ignore": ["**/__snapshots__/**", "**/node_modules/**"],
  "absolute": true
}

Rust Crate API

jscpd provides Rust crates for programmatic integration:

[dependencies]
cpd-finder = "0.1"

use cpd_finder::orchestrate;

fn main() {
    let result = orchestrate(&["./src".into()], &Default::default());
    println!("Found {} clones", result.statistics.total_clones);
}

See Rust Crates for the full crate reference, or MCP Server to expose jscpd to AI assistants with jscpd --mcp.