Reportingpenetration testingidecollaborativeguiworkspacesnmapdirb

python-faraday

python-faraday is a transitional package for Faraday, a collaborative Penetration Test IDE that supports automatic import of tool results into workspaces. It provides a GUI with ZSH terminal and sidebar for managing hosts, services, and vulnerabilities.

Description

Faraday introduces an Integrated Penetration-Test Environment (IPE), a multiuser Penetration test IDE designed for distribution, indexation, and analysis of data generated during security audits. The main purpose is to re-use community tools in a multiuser way, automatically detecting and importing results from supported commands like nmap and dirb into workspaces. Users can view host details, services, vulnerabilities, and directories via the GUI sidebar and tabs.

The tool features a ZSH terminal within the GUI where running supported commands triggers automatic parsing and storage of results. Double-clicking hosts reveals detailed information including detected services and vulnerabilities. Faraday also includes a full-featured web interface for team collaboration and sharing of penetration test data.

Plugins for numerous tools are available in /usr/share/python-faraday/plugins/repo, supporting applications like nmap, dirb, metasploit, nessus, and many others. This package is transitional and can be safely removed once Faraday is installed.

How It Works

Faraday operates as a GUI application with an integrated ZSH terminal and sidebar for workspaces and hosts. When a supported command is executed, Faraday detects it, converts outputs (e.g., nmap -A to XML), parses results, and imports them into the current workspace. Data is stored in a PostgreSQL database, managed via faraday-manage, with a web interface powered by Flask and Celery workers for processing. Plugins in /usr/share/python-faraday/plugins/repo handle parsing for various tools.

Installation

bash
sudo apt install python-faraday

Flags

-hShow help message and exit for binaries like faraday, faraday-manage, faraday-server
--debugRun Faraday Server in debug mode
--port PORTOverrides server.ini port configuration for faraday-server
--bind_address BIND_ADDRESSOverrides server.ini bind_address configuration for faraday-server
--queue QUEUECelery queue for faraday-worker and faraday-worker-gevent
--concurrency CONCURRENCYCelery concurrency for faraday-worker and faraday-worker-gevent

Examples

Start faraday.service and show help
faraday -h
Show help for managing Faraday’s database and users
faraday-manage -h
Show help for launching Faraday server
faraday-server -h
Show help for starting Celery workers
faraday-worker -h
Initialize database, create postgres user, and configure server.ini
python-faraday -h
Run nmap scan; Faraday auto-converts to XML and imports results into workspace
nmap -A 192.168.0.7
Run dirb scan; Faraday imports detected directories into host details
dirb http://192.168.0.23/commix-testbed -w
Updated 2026-04-16kali.org ↗