Skip to content

Quick Start

Jump to bottom
dev-mondoshawan edited this page May 6, 2026 · 2 revisions

Quick Start

Get ScarpShield up and monitoring in under 5 minutes.

If you haven't installed ScarpShield yet, follow the Installation Guide first.

Step 1: Install (if not done)

pip install scarpshield
scarpshield init

Alternative: Install from source

git clone https://github.com/RunTimeAdmin/ScarpShield.git
cd ScarpShield
pip install -r requirements.txt
python main.py init

Step 2: Add Your First Contract

Add a contract address to the watchlist with a friendly label and chain.

scarpshield add 0xdAC17F958D2ee523a2206206994597C13D831ec7 --label "USDT" --chain ethereum

Expected output:

[+] Added USDT on ethereum

Tip: The address is automatically validated and checksummed. Supported chains: ethereum, polygon, bsc, arbitrum, base.

Step 3: Check Status

Verify your configuration is correct:

scarpshield status

Expected output:

==================================================
  ScarpShield v1.0.1
  Powered by CounterScarp.io
==================================================
  Contracts:  1
  Alerts:     console
  Poll rate:  15s
  Chains:     ethereum

Step 4: Test Alerts

Send a test alert to confirm your alert channels are working:

scarpshield test-alerts

Expected output:

[+] Test alert sent to all enabled channels.

You should see a test message printed to your terminal (and any other enabled channels like Email, Discord, Slack, or Telegram).

Step 5: Start Monitoring

Launch the monitoring loop. ScarpShield will poll the blockchain every 15 seconds for new events on your watched contracts.

scarpshield start

Expected output:

==================================================
  ScarpShield v1.0.1
  Powered by CounterScarp.io
==================================================
Monitoring 1 contract(s) on ethereum...
(Press Ctrl+C to stop)

Press Ctrl+C at any time to stop the monitor.

Step 6 (Optional): Launch the Web Dashboard

In a separate terminal, start the web GUI for a visual monitoring experience:

scarpshield gui

Expected output:

╔══════════════════════════════════════════╗
║       ScarpShield Web Dashboard          ║
║   THE OUTER WALL OF DEFENSE              ║
╠══════════════════════════════════════════╣
║   Running at: http://127.0.0.1:8050      ║
║   Press Ctrl+C to stop                   ║
╚══════════════════════════════════════════╝

Your browser will open automatically to http://127.0.0.1:8050.

What's Next?

Now that you're monitoring, you can:

  • Add more contracts: scarpshield add <address> --label "My Contract" --chain <chain>
  • Enable more alert channels: scarpshield setup-email, scarpshield setup-discord, etc.
  • Configure the web dashboard: browse to the Settings tab in the GUI
  • Read the full CLI Reference for every command and option

Troubleshooting

Issue Solution
ModuleNotFoundError Run pip install --upgrade scarpshield
config.json not found Run scarpshield init
No events showing Check that your contract is deployed on the selected chain and that the RPC endpoint is reachable
Alerts not sending Verify credentials using scarpshield test-alerts and check your .env file

Clone this wiki locally