Skip to content

Faraday Manage CLI Reference

Version: v5.19.0 (Community Edition) Source: faraday/manage.py — 19 registered commands Last Updated: 2026-02-27

Overview

faraday-manage is the backend administration tool for Faraday Security's penetration testing platform. It provides commands for database management, user administration, server configuration, and integration setup.

Usage

faraday-manage COMMAND [OPTIONS] [ARGUMENTS]

Running faraday-manage without arguments displays all available commands. Use -h or --help with any command for detailed usage information.

faraday-manage --help
faraday-manage COMMAND --help

Requirements

  • Linux: The user running faraday-manage must be in the faraday group (or be root). After adding the user to the group, log out and log back in.
  • Configuration: Most commands require a valid server.ini configuration with PostgreSQL connection details.

Command Quick Reference

Command Description Category
initdb Initialize Faraday database, create tables, and admin user Database
create-tables Create database tables manually Database
migrate Run database schema migrations (upgrade/downgrade) Database
database-schema Generate PNG diagrams of the database model Database
sql-shell Open interactive PostgreSQL shell Database
create-superuser Create an admin user User Management
change-password Change a user's password User Management
rename-user Rename a user account User Management
settings Manage Faraday server settings Configuration
generate-nginx-config Generate NGINX reverse proxy configuration Server Config
show-urls Display all API endpoint URLs Utilities
openapi-swagger Generate OpenAPI/Swagger specification file Utilities
list-plugins List all available plugins Utilities
import-vulnerability-templates Import CWE vulnerability templates Utilitie
add-custom-field Interactive wizard to add a custom vulnerability field Custom Fields
delete-custom-field Interactive wizard to delete a custom vulnerability field Custom Fields
ingest Import vulnerabilities into Elasticsearch Integrations
move-references Migrate vulnerability references to new model Maintenance
sync-hosts-stats Recalculate host vulnerability severity statistics Maintenance

Command Categories

Edition Notes

This reference covers the Community Edition commands (19 commands). The Commercial/Professional edition includes additional commands not available in the open-source version:

Command Description Edition
create workspace Create a workspace via CLI Commercial
generate-roles-permission Export RBAC roles as JSON Commercial
generate-rsa-keys Create RSA keys for integrations Commercial
import-license Import Faraday license file Commercial
import-methodologies Import methodology templates from CSV Commercial
load-samples Load sample data for configs, attributes, filters Commercial
remove-rsa-keys Remove RSA key pair Commercial
show-rsa-keys Display RSA key pair Commercial
take-stats-snapshot Generate vulnerability statistics snapshot Commercial
update-enrichment-database Download latest enrichment database Commercial

Documentation Pages

File Content
README.md This index page
database-commands.md initdb, create-tables, migrate, database-schema, sql-shell
user-management.md create-superuser, change-password, rename-user
settings.md settings command + all 5 settings modules
server-config.md generate-nginx-config
custom-fields.md add-custom-field, delete-custom-field
utilities.md show-urls, openapi-swagger, list-plugins, import-vulnerability-templates
integrations.md ingest (Elasticsearch)
maintenance.md move-references, sync-hosts-stats

Known Documentation Corrections

The previous documentation (last updated 2023-08-29) contained these naming errors:

Old Documentation Name Correct Command Name Notes
add-custom-attribute add-custom-field Function name in code is add_custom_field
openapi-yaml openapi-swagger Generates JSON format, not YAML

Users following the old documentation using these command names will receive Error: No such command errors.