Skip to main content
Linkspector can be installed using npm or downloaded as a binary from GitHub releases. Choose the method that works best for your workflow.

​
System Requirements

Before installing Linkspector, ensure your system meets the following requirements:
  • Node.js: Version 18.0.0 or higher (for npm installation)
  • Operating System: Linux, macOS, or Windows
  • Chrome/Chromium: Required for Puppeteer-based link checking (automatically installed with npm)
Linkspector uses Puppeteer to check links in Chrome’s headless mode, which requires sufficient system resources to run a headless browser instance.

​
Install with Package Manager

The recommended way to install Linkspector is using a package manager. This ensures you get automatic updates and easy version management. 
npm install -g @umbrelladocs/linkspector
The -g flag installs Linkspector globally, making the linkspector command available from anywhere in your terminal.
The first installation may take a few minutes as Puppeteer downloads a compatible version of Chromium.

​
Download Binary

If you prefer not to use npm or need to use Linkspector in an environment without Node.js, you can download pre-built binaries from GitHub releases.
1

Visit the releases page

Go to the Linkspector releases page on GitHub.
2

Download the binary

Download the binary for your operating system:
  • Linux: linkspector-linux-x64
  • macOS: linkspector-macos-x64 or linkspector-macos-arm64
  • Windows: linkspector-win-x64.exe
3

Make it executable

On Linux and macOS, make the binary executable:
chmod +x linkspector-linux-x64
4

Move to PATH

Move the binary to a directory in your PATH:
# Linux/macOS
sudo mv linkspector-linux-x64 /usr/local/bin/linkspector

# Windows (PowerShell as Administrator)
Move-Item linkspector-win-x64.exe C:\Windows\System32\linkspector.exe

​
Verify Installation

After installation, verify that Linkspector is installed correctly by checking the version: 
linkspector --version
You should see output similar to: 
0.4.8
You can also view the help information to see available commands: 
linkspector --help
Expected output: 
Usage: linkspector [options] [command]

🔍 Uncover broken links in your content.

Options:
  -V, --version        output the version number
  -h, --help          display help for command

Commands:
  check [options]     Check hyperlinks based on the configuration file.
  help [command]      display help for command
If you see “command not found” after installation, you may need to restart your terminal or update your PATH environment variable.

​
Update Linkspector

To update to the latest version of Linkspector: 
npm update -g @umbrelladocs/linkspector

​
Uninstall

To remove Linkspector from your system: 
npm uninstall -g @umbrelladocs/linkspector

​
Next Steps

Now that you have Linkspector installed, you’re ready to start checking links in your documentation:

Quickstart Guide

Get started with your first link check

Configuration

Learn how to configure Linkspector

Build docs developers (and LLMs) love

Get started for freeTalk to us