faraday-cli

Overview

faraday-cli is the terminal client for Faraday, a collaborative penetration-testing and vulnerability-management platform that centralizes findings from many scanners into shared workspaces. Rather than driving everything through Faraday’s web UI, testers pipe scanner output (Nmap, Nessus, Burp, etc.) straight into a workspace from the CLI, keeping data collection scriptable and part of a normal terminal workflow during an engagement.

Common Usage

Authenticate against a Faraday server

faraday-cli auth -f https://faraday.internal

Create a new workspace for an engagement

faraday-cli workspace create acme-2026-q3

Set the active workspace for subsequent commands

faraday-cli workspace set-active acme-2026-q3

Import an Nmap XML scan directly into the active workspace

faraday-cli tool run nmap -- -sV -oX - <target> | faraday-cli tool report -

Pipe a scan straight in (Nmap plugin auto-detected)

nmap -sV -oX - <target> | faraday-cli tool report -

List vulnerabilities in the current workspace

faraday-cli vuln list --workspace-name acme-2026-q3

Notes

• Works alongside the Faraday server/web UI — the CLI is for scripting ingestion and querying, not a replacement for the full platform
• Has plugins for most common scanners (Nmap, Nessus, OpenVAS, Burp, Nikto, etc.) that auto-parse output format on import
• Useful for CI-style pipelines that continuously feed recon/scan results into a shared team workspace during long engagements

faraday-cli [COMMAND] [OPTIONS]

Commands:
  auth               authenticate to a Faraday server
  workspace           list, create, set-active, delete workspaces
  tool                run a supported tool and report output to Faraday
  vuln                list, search, create vulnerabilities
  host                list, create hosts in a workspace
  status-check        check status of an ongoing bulk import

Examples:
  faraday-cli auth -f https://faraday.internal
  faraday-cli workspace list
  faraday-cli tool report scan.xml --workspace-name <name>
  faraday-cli vuln list --workspace-name <name> --json

Vue d’ensemble

faraday-cli est le client terminal pour Faraday, une plateforme collaborative de tests d’intrusion et de gestion des vulnérabilités qui centralise les findings de nombreux scanners dans des workspaces partagés. Plutôt que de tout piloter via l’interface web de Faraday, les testeurs redirigent la sortie des scanners (Nmap, Nessus, Burp, etc.) directement vers un workspace depuis le CLI, gardant la collecte de données scriptable et intégrée à un workflow terminal normal pendant une mission.

Utilisation courante

# S'authentifier contre un serveur Faraday
faraday-cli auth -f https://faraday.internal

# Créer un nouveau workspace pour une mission
faraday-cli workspace create acme-2026-q3

# Définir le workspace actif pour les commandes suivantes
faraday-cli workspace set-active acme-2026-q3

# Importer un scan Nmap XML directement dans le workspace actif
faraday-cli tool run nmap -- -sV -oX - <target> | faraday-cli tool report -

# Rediriger un scan directement (plugin Nmap auto-détecté)
nmap -sV -oX - <target> | faraday-cli tool report -

# Lister les vulnérabilités du workspace courant
faraday-cli vuln list --workspace-name acme-2026-q3

Notes

• Fonctionne aux côtés du serveur/interface web Faraday : le CLI sert au scripting de l’ingestion et des requêtes, pas de remplacement de la plateforme complète
• Dispose de plugins pour la plupart des scanners courants (Nmap, Nessus, OpenVAS, Burp, Nikto, etc.) qui parsent automatiquement le format de sortie à l’import
• Utile pour des pipelines de type CI qui alimentent en continu un workspace d’équipe partagé avec des résultats de recon/scan pendant des missions longues

faraday-cli [COMMAND] [OPTIONS]

Commands:
  auth               authenticate to a Faraday server
  workspace           list, create, set-active, delete workspaces
  tool                run a supported tool and report output to Faraday
  vuln                list, search, create vulnerabilities
  host                list, create hosts in a workspace
  status-check        check status of an ongoing bulk import

Examples:
  faraday-cli auth -f https://faraday.internal
  faraday-cli workspace list
  faraday-cli tool report scan.xml --workspace-name <name>
  faraday-cli vuln list --workspace-name <name> --json