Reportingfaradaycliterminalautomationsecurityworkflows

faraday-cli

Faraday on the terminal. Official client that makes automating security workflows easier.

Description

faraday-cli is the official command-line client for Faraday, designed to bring Faraday's capabilities to the terminal. It simplifies the automation of security workflows, allowing users to manage and interact with Faraday's features directly from the command line without needing a graphical interface.

This tool is particularly useful for security professionals who prefer or require terminal-based operations, such as in automated scripts, CI/CD pipelines, or remote environments where GUI tools are impractical. By integrating with Faraday's ecosystem, it streamlines tasks like vulnerability management and reporting.

The package is lightweight, with an installed size of 220 KB, and depends on several Python libraries and the core Faraday package.

How It Works

faraday-cli operates as a terminal-based client leveraging Python dependencies like python3-click for command parsing, python3-cmd2 for interactive shell functionality, and python3-simple-rest-client for API interactions with Faraday servers. It supports both interactive shell mode and direct command execution, using libraries such as python3-faraday-plugins for extended functionality and python3-jsonschema for data validation.

Installation

bash
sudo apt install faraday-cli

Flags

-h, --helpshow this help message and exit

Examples

Displays the help message and usage information for faraday-cli
faraday-cli -h
Enters the interactive shell mode when no command is provided
faraday-cli
Runs a specific command with its optional arguments
faraday-cli command command_args
Shows the help message using the long form option
faraday-cli --help
Accesses help information within the interactive shell
faraday-cli help
Displays help for a specific command and its arguments
faraday-cli command --help
Updated 2026-04-16kali.org ↗