`fuchsiactl` console client¶

The fuchsiactl console client lets you access the scanning node directly, bypassing the control node.

Usage¶

The fuchsiactl service can be used as follows:

fuchsiactl [flags]
fuchsiactl [command]

The following flags are available:

Flag	Type	Description
`-h`, `--help`	Not specified	Help for `fuchsiactl` commands
`-v`, `--version`	Not specified	`fuchsiactl` version

Global flags¶

The flags listed in the table below are available for all commands.

Flag	Type	Description
`--addr`	`string`	`fuchsiad` socket address. By default, `unix:///run/fuchsia/fuchsiad.sock`, or the value from the `fuchsiactl` configuration file, if present
`--ca`	`string`	Path the CA certificates used for server verification. By default, the system certificate storage is used
`--cert`	`string`	Path to the client certificate that can be used when communicating over TLS
`--insecure`	`boolean`	Disables server certificate verification
`--key`	`string`	Path to the private key of the client certificate
`--tls`	`boolean`	Enables TLS for communication with the server

The available commands are divided into the following types:

common or unrelated to scans;
related to web scans;
related to network scans.

Note

There is no continuous numbering across different scan types.

Common commands¶

Command	Description
`completion`	Generate an autocompletion script for the specified shell
`config`	Update and check runtime settings
`help`	Help for any command
`reload`	Reload the server configuration

`completion` command¶

Generates an autocompletion script for the specified shell.

Usage:

fuchsiactl completion [shell_type]

`bash` shell¶

To load in the current session:

source <(fuchsiactl completion bash)

For future sessions (launch a new shell after executing the command for the changes to take effect):

GNU/LinuxmacOS

fuchsiactl completion bash > /etc/bash_completion.d/fuchsiactl

fuchsiactl completion bash > $(brew --prefix)/etc/bash_completion.d/fuchsiactl

`fish` shell¶

To load in the current session:

fuchsiactl completion fish | source

For future sessions (launch a new shell after executing the command for the changes to take effect):

fuchsiactl completion fish > ~/.config/fish/completions/fuchsiactl.fish

`powershell` shell¶

To load in the current session:

fuchsiactl completion powershell | Out-String | Invoke-Expression

For future sessions add the command above to your powershell profile.

`zsh` shell¶

If auto-completion has not been enabled previously in your environment, it needs to be enabled.

echo "autoload -U compinit; compinit" >> ~/.zshrc

To load in the current session:

source <(fuchsiactl completion zsh)

For future sessions (launch a new shell after executing the command for the changes to take effect):

GNU/LinuxmacOS

fuchsiactl completion zsh > "${fpath[1]}/_fuchsiactl"

fuchsiactl completion zsh > $(brew --prefix)/share/zsh/site-functions/_fuchsiactl

Flags:

Flag	Type	Description
`--no-descriptions`	Not specified	Disables description output

`config` command¶

Allows you to update and check runtime settings. Running the command without any flags displays the current values.

Usage:

fuchsiactl config [flags]

Flags:

Flag	Type	Description
`--concurrency`	`int`	Maximum number of parallel jobs (`0` — auto, `-1` — reset, do not change default)
`--scan-concurrency`	`int`	Maximum number of parallel scans (`0` — unlimited, `-1` — reset, do not change default)

`help` command¶

Displays help for the specified command.

Usage:

fuchsiactl help [command]

`reload` command¶

Reloads the server configuration.

Usage:

fuchsiactl reload [flags]

Web scan commands¶

Command	Description
`cancel_scan`	Cancel the specified scan
`create_scangroup`	Create a scan group (experimental functionality)
`delete_scan`	Delete the specified scan and its associated data
`dump_requests`	Save all HTTP requests from the specified scan to a given directory
`dump_responses`	Save all HTTP responses from the specified scan to a given directory
`export`	Export the resources and endpoints of the specified scan
`get_deps`	Display a list of endpoints and their tags
`get_resources`	Display a list of resources and their tags
`get_scangroup`	Display information about the scan group with the specified ID (experimental functionality)
`get_tokenbudget_metrics`	Display the token budget metrics for the scan group with the specified ID (experimental functionality)
`list_modules`	Display the list of modules
`list_scangroups`	Display the list of all scan groups (experimental functionality)
`list_scans`	Display the list of scans
`logs`	Display logs
`pause_scan`	Pause the specified scan
`rescan`	Start a new scan identical to the specified one
`resume_scan`	Resume a paused scan
`scan`	Start a new scan
`scan_stats`	Display network statistics for a specific scan

`cancel_scan` command¶

Cancels the specified scan.

Usage:

fuchsiactl cancel_scan <scan_id> [flags]

`create_scangroup` command¶

Creates a new scan group with the specified token budget (experimental functionality).

Usage:

fuchsiactl create_scangroup <token_budget_capacity> [flags]

`delete_scan` command¶

Deletes the specified scan and its associated data.

Usage:

fuchsiactl delete_scan <scan_id> [flags]

`dump_requests` command¶

Saves all HTTP requests from the specified scan to a given directory. This command is only applicable to scans created with the --dumpRequests flag.

Usage:

fuchsiactl dump_requests [flags]

Flags:

Flag	Type	Description
`-o`, `--output`	`string`	Directory for saving requests
`-s`, `--scan`	`int`	Scan ID. By default `-1`

`dump_responses` command¶

Saves all HTTP responses from the specified scan to a given directory. This command is only applicable to scans created with the --dumpResponses flag.

Usage:

fuchsiactl dump_responses [flags]

Flags:

Flag	Type	Description
`-o`, `--output`	`string`	Directory for saving responses
`-s`, `--scan`	`int`	Scan ID. By default `-1`

`export` command¶

Exports the resources and endpoints of the specified scan.

Usage:

fuchsiactl export <scan_id> [flags]

Flags:

Flag	Type	Description
`--dest`	`string`	File name for storing extracted data

`get_deps` command¶

Displays a list of endpoints and their tags.

Usage:

fuchsiactl get_deps <scan_id> [flags]

Flags:

Flag	Type	Description
`--json`	`boolean`	Output in NDJSON format. By default `false`
`--per-page`	`int32`	The number of endpoints to display per API request. By default `100`

`get_resources` command¶

Displays a list of resources and their tags.

Usage:

fuchsiactl get_resources <scan_id> [flags]

Flags:

Flag	Type	Description
`--json`	`boolean`	Output in NDJSON format. By default `false`
`--per-page`	`int32`	The number of resources to display per API request. By default `100`

`get_scangroup` command¶

Displays information about the scan group with the specified group ID (experimental functionality).

Usage:

fuchsiactl get_scangroup <scangroup_id> [flags]

`get_tokenbudget_metrics` command¶

Displays the token budget metrics for the scan group with the specified ID (experimental functionality).

Usage:

fuchsiactl get_tokenbudget_metrics <scangroup_id> [flags]

`list_modules` command¶

Displays the list of modules.

Usage:

fuchsiactl list_modules [flags]

`list_scans` command¶

Displays the list of scans.

Usage:

fuchsiactl list_scans [flags]

Flags:

Flag	Type	Description
`--per-page`	`int32`	The number of endpoints to display per API request. By default `100`

`list_scangroups` command¶

Displays the list of all scan groups (experimental functionality).

Usage:

fuchsiactl list_scangroups [flags]

`logs` command¶

Displays logs.

Usage:

fuchsiactl logs [flags]

Flags:

Flag	Type	Description
`--all`	`boolean`	Displays all logs. By default `false`
`--job`	`int`	Job ID. Overrides other flags. By default `-1`
`--log-type`	`log-type`	Displays logs of a specific type. Valid types: `authChecker`, `httpRequests`, `httpRequestsFull`, `output` (default `output`). The `httpRequestsFull` type is available only for scans created with the `--dumpRequests` flag
`--modules`	`strings`	A list of modules from which logs are being requested
`--scan`	`int`	Scan ID. By default `-1`

`pause_scan` command¶

Pauses the specified scan.

Usage:

fuchsiactl pause_scan <scan_id> [flags]

`rescan` command¶

Creates a new scan, identical to the specified one.

Usage:

fuchsiactl rescan <scan_id> [flags]

Flags:

Flag	Type	Description
`--login-proposal`	`boolean`	If the automatic login module was involved in the specified scan, this flag allows reusing tags previously generated by this module as browser scripts in a new scan

`resume_scan` command¶

Resumes a paused scan.

Usage:

fuchsiactl resume_scan <scan_id> [flags]

`scan` command¶

Starts a new scan.

Usage:

fuchsiactl scan [flags]

Flags:

Flag	Type	Description
`--anomaly-checker-config`	`string`	Path to the anomaly checker configuration file
`--cookie`	`string`	Additional cookie file (passed to the original hostname of the scan). E.g. `"name=value; name2=value2"`
`--depDedupUrlRegexp`	`array`	Regular expressions for deduplicating endpoints by URL. To specify multiple expressions, use the flag multiple times
`--depDeduplication`	enumerable	Endpoint deduplication mode (`none`, `default`, `extended`). By default `default`
`--dirbusting`	`boolean`	Enables dirbusting with a default dictionary. By default `true`
`--domain-list`	`array`	Comma-separated list of domains
`--domain-scope`	enumerable	Domain filtering mode (`any`, `same`, `subdomain`, `secondlevel`/`second-level`). By default `second-level`
`--dumpRequests`	`boolean`	Mode for saving requests for later use. The following commands are used to display the saved requests: `fuchsiactl logs` with the `--log-type httpRequestsFull` flag or `fuchsiactl dump_requests`
`--extra-setting`	`string`	Passes additional settings to modules. E.g. `--extra-setting=${module}:${name}=${value}`. The `value` parameter should be specified in JSON format. E.g. `--extra-setting 'module_example:test_param="test_val"'`
`--file`	`string`	Passes additional files to modules. E.g. `--file=${module}:${name}=${contents}`, `--file=${module}:${name}@${path}`. Use „*“ to transfer the file to all modules
`--header`	`string`	An additional HTTP header (passed to the original hostname of the scan). E.g. `"X-Token: foobar"`
`--import`	`string`	Path to the file containing data for the imported scan. The specified file must be obtained using the `fuchsiactl export` command
`--max-rps`	`float`	The maximum RPS value. It is not limited by default
`--modules`	`array`	Module specifications, comma‑separated, in the format: `module-name`, `%label`, `%role:label`. The default value is `%default`. For more information, see the section
`--pageDedupUrlRegexp`	`array`	Regular expressions for deduplicating pages by URL. To specify multiple expressions, use the flag multiple times
`--pageDeduplication`	`boolean`	Enables page deduplication for modules that accept pages as input. By default `true`
`--password`	`string`	Password for basic HTTP authentication (passed to the original hostname of the scan)
`--php-entrypoints`	`string`	Comma-separated list of endpoints
`--proxy`	`string`	Proxy server. E.g. `http://127.0.0.1:8080`
`--replace-in-json`	`object`	Replaces the value at the `path` with a new one (specified by the `value` key) in the JSON bodies of HTTP requests. E.g. `--replace-in-json={"path": ["path", "to", "key"], "value": "newValue"}`
`--scanRequest`	`string`	Path to the JSON file containing the scan settings
`--scangroup`	`int`	Starts a scan within the scan group with the specified ID
`--static-crawler-max-depth`	`int`	Maximum crawling depth for static web crawling. E.g. `3`
`--static-crawler-max-links`	`int`	Maximum number of pages to crawl for the static web crawling module. E.g. `0` (unlimited)
`--url`	`string`	URL to scan
`--url-blacklist`	`array`	Regular expressions for restricting the URLs included in the scan. To specify multiple expressions, use the flag multiple times
`--username`	`string`	Username for basic HTTP authentication (passed to the original hostname of the scan)

`--modules` flag¶

This flag specifies a comma‑separated list of module specifications to be used for scanning. A ! prefix can be used to exclude a specific module or module group from the scan list.

Supported formats:

to use modules:
- module-name;
- %label;
- %role:label;
to exclude modules:
- %label, !module-name;
- %label, !%label;
- %label, !%role:label.

Supported label values:

all — all modules are used;
default — all modules are used except experimental ones (default);
browser — modules that use a headless browser are used.

Supported role values:

discovery — only discovery modules are used;
fuzzing — only fuzzing modules are used.

Examples of usage:

Use only the static web crawling module for scanning.
```
fuchsiactl scan ... --modules='static-crawler'
```

Use all modules for scanning except the static web crawling module.

fuchsiactl scan ... --modules='%all, !static-crawler'

Example of an incorrect command usage:

fuchsiactl scan ... --modules='!static-crawler'

Use only non‑experimental discovery modules for scanning.
```
fuchsiactl scan ... --modules='%discovery:default'
```

Use all modules for scanning that are neither experimental nor use a headless browser.
```
fuchsiactl scan ... --modules='%default,!%browser'
```

Use all modules for scanning except fuzzing modules.

fuchsiactl scan ... --modules='%all, !%fuzzing:all'

Alternative variant:

fuchsiactl scan ... --modules='%discovery:all'

`scan_stats` command¶

Displays network statistics for the specified scan.

Usage:

fuchsiactl scan_stats [flags]

Flags:

Flag	Type	Description
`-s`, `--scan`	`int`	Scan ID. By default `-1`

Network scan commands¶

Command	Description
`cancel_network_scan`	Cancel the specified network scan
`delete_network_scan`	Delete the specified network scan and its associated data
`get_network_endpoints`	Display the list of open ports and their tags
`list_network_scan_modules`	Display the list of network scan modules
`list_network_scans`	Display the list of network scans
`network_scan`	Launch a new network scan
`network_scan_logs`	Display logs for network scans
`pause_network_scan`	Pause the specified network scan
`resume_network_scan`	Resume a paused network scan

`cancel_network_scan` command¶

Cancels the specified network scan.

Usage:

fuchsiactl cancel_network_scan <network_scan_id> [flags]

`delete_network_scan` command¶

Deletes the specified network scan and its associated data.

Usage:

fuchsiactl delete_network_scan <network_scan_id> [flags]

`get_network_endpoints` command¶

Displays the list of open ports and their tags.

Usage:

fuchsiactl get_network_endpoints <network_scan_id> [flags]

Flags:

Flag	Type	Description
`--json`	`boolean`	Output in NDJSON format. Default is `false`
`--per-page`	`int32`	Number of endpoints to output per API request. Default is `100`

`list_network_scan_modules` command¶

Displays the list of network modules.

Usage:

fuchsiactl list_network_scan_modules [flags]

`list_network_scans` command¶

Displays the list of network scans.

Usage:

fuchsiactl list_network_scans [flags]

Flags:

Flag	Type	Description
`--per-page`	`int32`	Number of network scans to output per API request. Default is `100`

`network_scan` command¶

Launches a new network scan.

Usage:

fuchsiactl network_scan [flags]

Flags:

Flag	Type	Description
`--autoscan-web`	`string`	Path to a JSON file with scan parameters for child web scans. To enable automatic scanning with default parameters, use `--autoscan-web=''`. If the flag is not specified, automatic scanning is disabled
`--extra-setting`	`array`	Passes additional settings to modules in the `--extra-setting=${module}:${name}=${value}` format
`--file`	`array`	Passes additional settings to modules in the `--file=${module}:${name}=${contents}` or `--file=${module}:${name}@${path}` format (use `*` instead of the module name to pass the specified files to all modules)
`--modules`	`array`	Comma-separated module specifications in the format: `name`, `%label`, `%role:label`. Default is `%default`
`--ports`	`string`	Ports to scan. Nmap-like syntax is supported
`--scanRequest`	`string`	Path to a JSON file containing scan settings
`--targets`	`array`	Network targets to scan. You can specify a hostname, IP address, or network prefix in CIDR notation. The flag can be specified multiple times

`network_scan_logs` command¶

Displays logs for network scans.

Usage:

fuchsiactl network_scan_logs [flags]

Flags:

Flag	Type	Description
`--all`	`boolean`	Output all log entries. Default is `false`
`--job`	`int`	Job identifier. Overrides other flags. Default is `-1`
`--modules`	`strings`	List of modules whose logs are requested
`--scan`	`int`	Scan identifier. Default is `-1`

`pause_network_scan` command¶

Pauses a network scan.

Usage:

fuchsiactl pause_network_scan <network_scan_id> [flags]

`resume_network_scan` command¶

Resumes a paused network scan.

Usage:

fuchsiactl resume_network_scan <network_scan_id> [flags]

fuchsiactl console client¶

Usage¶

Global flags¶

Common commands¶

completion command¶

bash shell¶

fish shell¶

powershell shell¶

zsh shell¶

config command¶

help command¶

reload command¶

Web scan commands¶

cancel_scan command¶

create_scangroup command¶

delete_scan command¶

dump_requests command¶

dump_responses command¶

export command¶

get_deps command¶

get_resources command¶

get_scangroup command¶

get_tokenbudget_metrics command¶

list_modules command¶

list_scans command¶

list_scangroups command¶

logs command¶

pause_scan command¶

rescan command¶

resume_scan command¶

scan command¶

--modules flag¶

scan_stats command¶

Network scan commands¶

cancel_network_scan command¶

delete_network_scan command¶

get_network_endpoints command¶

list_network_scan_modules command¶

list_network_scans command¶

network_scan command¶

network_scan_logs command¶

pause_network_scan command¶

resume_network_scan command¶

`fuchsiactl` console client¶

`completion` command¶

`bash` shell¶

`fish` shell¶

`powershell` shell¶

`zsh` shell¶

`config` command¶

`help` command¶

`reload` command¶

`cancel_scan` command¶

`create_scangroup` command¶

`delete_scan` command¶

`dump_requests` command¶

`dump_responses` command¶

`export` command¶

`get_deps` command¶

`get_resources` command¶

`get_scangroup` command¶

`get_tokenbudget_metrics` command¶

`list_modules` command¶

`list_scans` command¶

`list_scangroups` command¶

`logs` command¶

`pause_scan` command¶

`rescan` command¶

`resume_scan` command¶

`scan` command¶

`--modules` flag¶

`scan_stats` command¶

`cancel_network_scan` command¶

`delete_network_scan` command¶

`get_network_endpoints` command¶

`list_network_scan_modules` command¶

`list_network_scans` command¶

`network_scan` command¶

`network_scan_logs` command¶

`pause_network_scan` command¶

`resume_network_scan` command¶