Snapper 🐠

Snapper aims to improve the overall security and reliability of Metamask Snaps by identifying vulnerabilities, potential issues, and ensuring best coding practices.

---

Getting Started

1. Installation

To install Snapper, you have multiple options depending on your preferred setup.

Using npm

To install Snapper globally, run the following command:

npm install -g @sayfer_io/snapper

Using GitHub

You can also clone the repository and run Snapper from your local machine. First, clone the repository:

git clone https://github.com/sayfer-io/Snapper.git
cd Snapper
npm install

Using Docker

To use Snapper with Docker, run the following commands:

git clone https://github.com/sayfer-io/Snapper.git
docker build -t snapper .
docker run snapper --help

---

2. Usage

Once Snapper is installed, you can run it in various ways. Below are the usage instructions for npm, GitHub, and Docker.

Using Snapper

To run Snapper using npm, you can use the following command:

npx snapper --help

# Or, if installed globally
snapper --help

This will show you the available options for Snapper. Here's an example output:

> [email protected] start
> npx ts-node main.ts

Options:
        --version          Show version number                           [boolean]
    -p, --path             Project path                        [string] [required]
    -d, --detectors        Specify which detector to run, specify multiple
                            detectors with a comma                        [string]
        --ignoreDetectors  Specify which detector to ignore, specify multiple
                            detectors with a comma                        [string]
    -v, --verbose          Enable verbose logging       [boolean] [default: false]
    -o, --output           Specify output file                            [string]
    -l, --logFile          Specify log file                               [string]
        --htmlReport       Generate HTML report         [boolean] [default: false]
    -h, --help             Show help                                     [boolean]

To run on a Snap:

# Basic scan
snapper --path /path/to/snap

# Ignore detectors when they aren't relevant or too verbose.
snapper --path /path/to/snap --ignoreDetectors detector1,detector2

# Run only specific detectors, useful for development when fixing a specific issue.
snapper --path /path/to/snap --detectors detector1,detector2

# Generate HTML report
snapper --path /path/to/snap --htmlReport

# Log output to a file
snapper --path /path/to/snap --logFile /path/to/logs.txt

To run a test case:

npm run start -- --path ./starknet-snap

Contributing

We welcome contributions to Snapper! If you would like to contribute, please follow the guidelines outlined in our CONTRIBUTING.md file.