Skip to main content

Command-line malware scanner powered by Wordfence

Project description

Wordfence CLI

Wordfence CLI is an open source, high performance, multi-process security scanner, written in Python, that quickly scans network filesystems to detect PHP/other malware and WordPress vulnerabilities. CLI is parallelizable, can be scheduled, can accept input via pipe, and can pipe output to other commands.

Installation

We have a number of installation methods to install Wordfence CLI in our installation documentation which we'd recommend reviewing to get you scanning for malware in as few steps as possible.

We recommend installing using pip:

pip install wordfence

If you'd like to install Wordfence CLI manually or use CLI for development, you can clone the GitHub repo to your local environment:

git clone git@github.com:wordfence/wordfence-cli.git
cd ./wordfence-cli
pip install .
python main.py version

Requirements

  • Python >= 3.8
  • The C library libpcre >= 8.38
  • Python packages:
    • packaging >= 21.0
    • requests >= 2.3
    • mysql-connector-python >= 8.0

Obtaining a license

Visit https://www.wordfence.com/products/wordfence-cli/ to obtain a license to download our signature set.

Usage

You can run wordfence help for a full list of options that can be passed to Wordfence CLI. Read more about the configuration options that can be passed to Wordfence CLI.

Scanning a directory for malware

Recursively scanning the /var/www directory for malware:

wordfence malware-scan /var/www

A full list of examples for the malware scan is included in our documentation.

Scanning a WordPress installation for vulnerabilities

Scanning the /var/www/wordpress directory for vulnerabilities.

wordfence vuln-scan /var/www/wordpress

A full list of examples for the vulnerability scan is included in our documentation.

Documentation

The full documentation for Wordfence CLI can be found here which includes installation instructions, configuration options, detailed examples, and frequently asked questions.

License

Wordfence CLI is open source, licensed under GPLv3. The license can be found here.

Contributing

See our contribution guidelines.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wordfence-5.0.1.tar.gz (158.7 kB view details)

Uploaded Source

Built Distribution

wordfence-5.0.1-py3-none-any.whl (182.0 kB view details)

Uploaded Python 3

File details

Details for the file wordfence-5.0.1.tar.gz.

File metadata

  • Download URL: wordfence-5.0.1.tar.gz
  • Upload date:
  • Size: 158.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.18

File hashes

Hashes for wordfence-5.0.1.tar.gz
Algorithm Hash digest
SHA256 d77c63a6ef30fc8c9c288484e8b22870c6802cda4d73acd34fe186d08b9fb154
MD5 a9c11cfb84ac48503dc6617a23f14000
BLAKE2b-256 861ab39fe3f364343b1b765f4c5e8d63813f2b02777564b2b69af8624f26ae3b

See more details on using hashes here.

File details

Details for the file wordfence-5.0.1-py3-none-any.whl.

File metadata

  • Download URL: wordfence-5.0.1-py3-none-any.whl
  • Upload date:
  • Size: 182.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.18

File hashes

Hashes for wordfence-5.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6f62c7fd77cb9bcada499c62fd6b534d913b5296067c1a3f98c847325d601250
MD5 5db984276b215225b1edbf6b7ef8fca3
BLAKE2b-256 0122dd7a108064fb457947a0d73da5f81f3cab65a2dd4be563cbf08166e7b9a2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page