Faraday Manage

Faraday Manage

Faraday Manage is a backend tool that helps us administrate Faraday's configuration.

To use Faraday Manage, you can run it as follow:

$ faraday-manage COMMAND

If you run faraday-manage, it will list all the available commands.

Available Commands


This command allows you to create Custom Fields from the terminal. For more information about Custom Fields, you can see this KB page.


It allows you to change your user's password.


The name says it all! This is the way to create a new admin user through the command line.


This command allows the user to manually create a table on Faraday's database. It would come in handy if something in the initdb command fails for an example.


This will print a PNG image with Faraday's internal working scheme.


It allows you to delete a Custom Field from the terminal.


This command displays the nginx config example to be added in nginx config


This command displays the roles permission in a JSON file


It will create an RSA key for integrations


Find duplicate vulnerabilities matching with Faraday knowledge database.


Imports vulnerabilities knowledge base to Faraday DB.


Imports Faraday License.


Imports methodologies and tasks from a csv file


Imports vuln templates from a file


This command needs to be executed only at the moment of Faraday's installation. It will create the tables of the database, Faraday's user among other things.

If you try to execute this a second time it will indeed fail.

Please do not lose the random password that this command will print on the screen. It will be necessary to login into Faraday.


Lists available plugins.


Migrates database schema.


Show URLs in OpenApi format


Change username.


It allows you to manage settings inside faraday configuration


Prints a list of all the URLs available to communicate with our API Rest.


This command will open a PostgreSQL shell already configured with Faraday's user and configuration.

    Still looking for answers? You can try opening a ticket.
      • Related Articles

      • Faraday Server

        Faraday's installers (.deb or .rpm) will install Faraday Server as a service. Faraday Server is the interface between PostgreSQL, Faraday Client and the WebUI. The Server's responsibility is to transmit information between the Client or WebUI and ...
      • Updating Faraday

        Faraday will be installed as a service if you use .deb or .rpm.  Note: if you're updating from Faraday v3.8.1 or lower, follow the instructions specified in the last section of this article. Once you're done, you can proceed with the instructions ...
      • How to reset Faraday Server password

        If you forgot the password or you don't know your Faraday Server password, you can use the command faraday-manage to change it: $ faraday-manage change-password
      • Faraday Server Releases

        New features in the latest update 3.17.0 [Aug 10th, 2021]: ADD --data parameter to faraday-manage settings MOD Process report files in a separate process MOD Make bulk_create requests asynchronous 3.16.1 [Jul 2nd, 2021]: MOD only show settings of ...
      • Faraday Plugin

        Intro In order to manage, add, and list information stored in faraday, we created fplugin, a simple plugin that allows you to interact directly with our Python API from the command line. It gives Faraday powerful scripting features and allows you to ...