beef README

The project's README from github.com/beefproject/beef. As one markdown file: README.md.

===============================================================================

Copyright (c) 2006-2026 Wade Alcorn - [email protected]
Browser Exploitation Framework (BeEF) - https://beefproject.com
See the file 'doc/COPYING' for copying permission

===============================================================================

What is BeEF?

BeEF is short for The Browser Exploitation Framework. It is a penetration testing tool that focuses on the web browser.

Amid growing concerns about web-borne attacks against clients, including mobile clients, BeEF allows the professional penetration tester to assess the actual security posture of a target environment by using client-side attack vectors. Unlike other security frameworks, BeEF looks past the hardened network perimeter and client system, and examines exploitability within the context of the one open door: the web browser. BeEF will hook one or more web browsers and use them as beachheads for launching directed command modules and further attacks against the system from within the browser context.

Get Involved

You can get in touch with the BeEF team. Just check out the following:

Please, send us pull requests!

Web: https://beefproject.com/

Bugs: https://github.com/beefproject/beef/issues

Security Bugs: [email protected]

Twitter: @beefproject

Discord: https://discord.gg/25wT2P8pwx

Requirements

Quick Start

The following is for the impatient.

The install script installs the required operating system packages and all the prerequisite Ruby gems:

$ ./install

For full installation details, please refer to INSTALL.txt or the Installation page on the wiki.

Upon successful installation, be sure to read the Configuration page on the wiki for important details on configuring and securing BeEF.

Documentation

Usage

To get started, simply execute beef and follow the instructions:

$ ./beef

beef (beefproject/beef)

Searching Database…

11.1K ·GitHub
What is this?BeEF (Browser Exploitation Framework) is a penetration testing tool that focuses on the web browser, letting a tester assess the real security posture of a target by using client-side attack vectors instead of network-perimeter exploits.
Is this a browser extension or a standalone server?It is a standalone Ruby-based server application. You run the 'beef' command to start it, and it hooks target browsers by having them load a JavaScript hook file, then you control those hooked browsers from BeEF's web console.
How do I get it running?Run the install script to install OS packages and the required Ruby gems, then execute the 'beef' command and follow the on-screen instructions.
What do I need installed before running BeEF?You need Ruby 3.0+, SQLite 3.x, Node.js 10+, and the gems listed in the Gemfile; on macOS you also need Selenium via Homebrew ('brew install selenium-server-standalone').
Does it run on Windows?No, Windows is explicitly not supported; only Mac OSX 10.5+ or a modern Linux distribution can run BeEF.
How do I attack a browser once I have BeEF running?You get a target browser to load the BeEF hook JavaScript file (the 'hook'); once hooked, the browser appears in BeEF's web console where you can launch command modules and further attacks against it.
Why does it matter that BeEF looks at the browser instead of the network?The README argues that network perimeters and client systems can be hardened while the browser remains an open door, so BeEF targets that overlooked attack surface rather than duplicating traditional network-focused security tools.
Where can I find detailed install and configuration steps?The project points to INSTALL.txt and the project wiki's Installation and Configuration pages for full setup and hardening details beyond the quick-start script.
Size
24.8 MB
Stars
11.1K
Age
14y
Commits · 90 Days