Getting Started

Get up and running with Solana Privacy Scanner in just a few minutes.

Installation

Install Globally (Recommended)

npm install -g solana-privacy-scanner

Use with npx (No Installation)

npx solana-privacy-scanner scan-wallet <address> --rpc <your-rpc-url>

Prerequisites

You'll need:

1. Node.js (version 20 or higher)
2. A Solana RPC endpoint - Get a free one from:
   • Helius
   • QuickNode
   • Alchemy

Quick Start

Scan a Wallet

solana-privacy-scanner scan-wallet <WALLET_ADDRESS> \
  --rpc https://your-rpc-endpoint.com \
  --max-signatures 50

Scan a Transaction

solana-privacy-scanner scan-transaction <TX_SIGNATURE> \
  --rpc https://your-rpc-endpoint.com

Scan a Program

solana-privacy-scanner scan-program <PROGRAM_ID> \
  --rpc https://your-rpc-endpoint.com \
  --max-accounts 10 \
  --max-transactions 20

Using Environment Variables

Instead of passing --rpc every time, set an environment variable:

export SOLANA_RPC=https://your-rpc-endpoint.com

# Now you can omit --rpc
solana-privacy-scanner scan-wallet <ADDRESS>

Output Formats

Human-Readable (Default)

solana-privacy-scanner scan-wallet <ADDRESS>

Outputs a formatted report to your terminal.

JSON Output

solana-privacy-scanner scan-wallet <ADDRESS> --json

Machine-readable JSON for programmatic use.

Save to File

solana-privacy-scanner scan-wallet <ADDRESS> --output report.txt

Next Steps

• CLI Quickstart - More CLI examples
• Understanding Reports - Learn to interpret results
• CLI User Guide - Complete command reference