86 online 3 members  + Join RP Base  +
FreeTool

faraday-cli

by infobyte  ·  version 2026.11.12  ·  updated 2 days ago

No reviews yet

Downloads
0
Reviews
0
Size
7.8 MB
Code check
Clean
Licence
GPL-3.0
Released
Nov 2026

Faraday's Command Line Interface

faraday-cli
Faraday on the terminal
Use faraday directly from your favorite terminal

faraday-cli is the official client that make automating your security workflows, easier.

Before installing, we recommend creating and activating a Python virtual environment to avoid affecting your system Python packages. For example:

python3 -m venv .venv
source .venv/bin/activate

You can also use virtualenv if you prefer. Once the virtual environment is active, run the installation commands below.
Install from pip
pip install faraday-cli

Install from source
 script
git clone https://github.com/infobyte/faraday-cli.git
cd faraday-cli
pip install .

Documentation
For more info you can check our [documentation][doc]
Use it like a commandLogin
Configure auth for farday-cli

 script
$ faraday-cli auth

Create a workspace
When you create a workspace by default is selected as active, unless you use the "-d" flag
 script
$ faraday-cli workspace create some_name
✔ Created workspace: some_name

Select active workspace
 script
$ faraday-cli workspace select some_name
✔ Selected workspace: some_name

List workspaces
 script
$ faraday-cli list_ws
NAME         HOSTS    SERVICES    VULNS  ACTIVE    PUBLIC    READONLY
---------  -------  ----------  -------  --------  --------  ----------
some_name       14          13       39  True      False     False

List hosts of a workspace
 script
$ faraday-cli host list
  ID  IP           OS       HOSTNAMES          SERVICES  VULNS
----  -----------  -------  ---------------  ----------  -------
 574  127.0.0.1    unknown                            1  3
 566  127.0.0.10   unknown                            1  3
 569  127.0.0.11   unknown                            1  3
 568  127.0.0.12   unknown                            1  3
 570  127.0.0.13   unknown                            1  3
 576  127.0.0.2    unknown                            1  3
 565  127.0.0.3    unknown                            1  3
 572  127.0.0.4    unknown                            1  3
 573  127.0.0.5    unknown                            1  3
 567  127.0.0.6    unknown                            1  3
 571  127.0.0.7    unknown                            1  3
 564  127.0.0.8    unknown                            1  3
 575  127.0.0.9    unknown                            1  3
 590  58.76.184.4  unknown  www.googlec.com           0  -

Get host
 script
$ faraday-cli host get 574

$ faraday-cli host get 574
Host:
  ID  IP         OS       HOSTNAMES    OWNER    OWNED      VULNS
----  ---------  -------  -----------  -------  -------  -------
 574  127.0.0.1  unknown               faraday  False          3

Services:
  ID  NAME    DESCRIPTION    PROTOCOL      PORT  VERSION    STATUS      VULNS
----  ------  -------------  ----------  ------  ---------  --------  -------
2638  ssh                    tcp             22  unknown    open            2

Vulnerabilities:
   ID  NAME                                      SEVERITY    STATUS    CONFIRMED    TOOL
-----  ----------------------------------------  ----------  --------  -----------  -------
13509  SSH Weak Encryption Algorithms Supported  MED         opened    False        Openvas
13510  SSH Weak MAC Algorithms Supported         LOW         opened    False        Openvas
13511  TCP timestamps                            LOW         opened    False        Openvas

Create hosts
 script
$ faraday-cli host create -d \''[{"ip": "stan.local", "description": "some server"}]'\'

Or pipe it
 script
$ echo '[{"ip": "1.1.1.5", "description": "some text"}]' | faraday-cli host create --stdin

**The escaping of the single quotes (\\') is only needed when using it as a command.
In the shell or using pipes it not necessary**
Import vulnerabilities from tool report
 script
$ faraday-cli tool report "/path/to/report.xml"

Import vulnerabilities from command
 script
$ faraday-cli ping -c 1 www.google.com

List agents (runners)
Local Faraday Agents (dispatcher runners). Reachable as agent, agents,
runner or runners (all equivalent).

 script
$ faraday-cli agent list
  id  name      active    status    executors
----  --------  --------  --------  -----------
   8  internal  True      online    nmap

Run executor
 script
$ faraday-cli agent run -a 1 -e nmap -p \''{"target": "www.google.com"}'\'
Run executor: internal/nmap [{'successful': True}]

Run a FaradAI scan (cloud agents / scanners)
Cloud agents are server-side security scanners (the v3/cloud_agents API),
distinct from the local runners above. FaradAI is one such scanner, with its own
command and top-level shortcuts.

 script
**Quick FaradAI pentest (standard tier — 20 rounds)**
$ faraday-cli pentest --target https://example.com
**Deeper audit (80 rounds), and watch it until it finishes**
$ faraday-cli pentest --target https://example.com --advanced --watch
**Triage the existing findings of a workspace**
$ faraday-cli triage -w my_workspace --severities critical,high --reproduce

List and run any cloud agent generically:

 script
$ faraday-cli scanners list
  ID  NAME            SLUG            CATEGORY   LAST_RUN
----  --------------  --------------  ---------  ----------
   2  FaradAI         faradai         pentest    -
   4  FaradAI Triage  faradai-triage  triage     -

$ faraday-cli scanners run --agent faradai -w my_workspace \
    --param TARGET=https://example.com --param ROUNDS=20

No Faraday server connected? pentest / triage fall back to the
FaradAI-scan SaaS and walk you through creating an account on first use.
See the [FaradAI docs][doc] for registration and --standalone details.
Use it like a shell
Faraday-cli can be used as a shell and have all the same commands you have as a cli
Use cases**Continuous scan your assets with fa

…