⭐ GitHub

⚙️ Installation

How to install and set up ProofScan on your system

System Requirements

Before installing ProofScan, ensure your system meets these requirements:

  • Node.js - version 18.0.0 or higher
  • npm - version 9.0.0 or higher (comes with Node.js)
  • Operating System - macOS, Linux, or Windows (WSL recommended)
💡 Checking Your Version

Run these commands to check your current versions:

node --version
npm --version

Installation via npm

The easiest way to install ProofScan is via npm:

Global Installation (Recommended)

Install ProofScan globally to use it from anywhere:

npm install -g proofscan

After installation, verify it worked:

pfscan --version

Local Installation

To install ProofScan in a specific project:

npm install proofscan

Then use it with npx:

npx pfscan --version

Installation from GitHub

To install the latest development version directly from GitHub:

Clone and Build

git clone https://github.com/proofofprotocol/proofscan.git
cd proofscan
npm install
npm run build
npm link
⚠️ Development Installation

This method installs the latest code from GitHub, which may include unreleased features or bugs. Use the npm installation for production environments.

Initial Configuration

After installation, initialize your ProofScan configuration:

1. Initialize Config File

pfscan config init

This creates a configuration file at:

  • Linux: ~/.config/proofscan/config.json
  • macOS: ~/Library/Application Support/proofscan/config.json
  • Windows: %APPDATA%\proofscan\config.json

2. View Configuration

Check your current configuration:

pfscan config show

3. Edit Configuration

Open the config file in your default editor:

pfscan config edit

Verify Installation

Test that ProofScan is working correctly:

1. Check Version

pfscan --version

Should output something like: 0.11.2

2. View Help

pfscan --help

Should display the main help menu with available commands.

3. List Connectors

pfscan connectors ls

Should show an empty list (you haven't added any connectors yet).

Troubleshooting

Command Not Found

If you get "command not found" errors:

  • Ensure npm's global bin directory is in your PATH
  • Try closing and reopening your terminal
  • On macOS/Linux, check npm config get prefix
  • Add npm's bin directory to PATH: export PATH="$(npm config get prefix)/bin:$PATH"

Permission Errors

If you get permission errors during installation:

  • Linux/macOS: Don't use sudo npm install -g
  • Instead, configure npm to use a different directory: npm permissions guide
  • Windows: Run your terminal as Administrator

Node Version Issues

If ProofScan doesn't work due to Node.js version:

  • Update Node.js to the latest LTS version from nodejs.org
  • Or use a version manager like nvm (Linux/macOS) or nvm-windows

Next Steps

Now that ProofScan is installed, you're ready to start using it: