|
|
|
_Some of those executables are only available via the self-contained packages._
|
|
|
|
|
|
|
|
* [arachni](#arachni)
|
|
|
|
* [arachni_reporter](#arachni_reporter)
|
|
|
|
* [arachni_restore](#arachni_restore)
|
|
|
|
* [arachni_multi](#arachni_multi)
|
|
|
|
* [arachni_rpc](#arachni_rpc)
|
|
|
|
* [arachni_rpcd](#arachni_rpcd)
|
|
|
|
* [arachni_rpcd_monitor](#arachni_rpcd_monitor)
|
|
|
|
* [arachni_web](#arachni_web) (Package only)
|
|
|
|
* [arachni_web_script](#arachni_web_script) (Package only)
|
|
|
|
* [arachni_web_import](#arachni_web_import) (Package only)
|
|
|
|
* [arachni_web_scan_import](#arachni_web_scan_import) (Package only)
|
|
|
|
* [arachni_web_create_user](#arachni_web_create_user) (Package only)
|
|
|
|
* [arachni_web_change_password](#arachni_web_change_password) (Package only)
|
|
|
|
* [arachni_console](#arachni_console)
|
|
|
|
* [arachni_script](#arachni_script)
|
|
|
|
* [arachni_shell](#arachni_shell) (Package only)
|
|
|
|
|
|
|
|
## <a name="arachni" href="#arachni">arachni</a>
|
|
|
|
|
|
|
|
Provides a command-line interface to the Arachni scanner.
|
|
|
|
See the relevant [[reference | Command-line-user-interface]] for more details.
|
|
|
|
|
|
|
|
## <a name="arachni_reporter" href="#arachni_reporter">arachni_reporter</a>
|
|
|
|
|
|
|
|
Generates reports in various formats from AFR (Arachni Framework Report -- `.afr`) files.
|
|
|
|
(AFR files are generated by all interfaces that can perform scans.)
|
|
|
|
|
|
|
|
## <a name="arachni_restore" href="#arachni_restore">arachni_restore</a>
|
|
|
|
|
|
|
|
Restores a suspended scan from an AFS (Arachni Framework Snapshot -- `.afs`) file.
|
|
|
|
(AFS files are generated by the `arachni` executable upon succesful suspension on a scan.)
|
|
|
|
|
|
|
|
## <a name="arachni_multi" href="#arachni_multi">arachni_multi</a>
|
|
|
|
|
|
|
|
Spawns and controls an RPC Instance in order to provide easy access to features
|
|
|
|
which are only available over RPC, like multi-Instance scans.
|
|
|
|
|
|
|
|
Essentially the same as [arachni_rpc](#arachni_rpc) but without requiring a [[Dispatcher | RPC-Server]].
|
|
|
|
|
|
|
|
## <a name="arachni_rpc" href="#arachni_rpc">arachni_rpc</a>
|
|
|
|
|
|
|
|
Provides a command-line RPC client for a [[Dispatcher | RPC-Server]]. Allows you to run a scan remotely.<br/>
|
|
|
|
See the relevant [[reference | RPC-client]] for more details.
|
|
|
|
|
|
|
|
## <a name="arachni_rpcd" href="#arachni_rpcd">arachni_rpcd</a>
|
|
|
|
|
|
|
|
Starts a [[Dispatcher | RPC-Server]].
|
|
|
|
|
|
|
|
## <a name="arachni_rpcd_monitor" href="#arachni_rpcd_monitor">arachni_rpcd_monitor</a>
|
|
|
|
|
|
|
|
Connects to a [[Dispatcher | RPC-Server]] and shows a few statistics like running
|
|
|
|
scans and their resource usage.
|
|
|
|
|
|
|
|
## <a name="arachni_web" href="#arachni_web">arachni_web</a> (Package only)
|
|
|
|
|
|
|
|
Starts the [Web User Interface](https://github.com/Arachni/arachni-ui-web).
|
|
|
|
|
|
|
|
## <a name="arachni_web_script" href="#arachni_web_script">arachni_web_script</a> (Package only)
|
|
|
|
|
|
|
|
Runs Ruby code in the context of the WebUI Rails environment, essentially delegates to [rails runner](http://guides.rubyonrails.org/command_line.html#rails-runner).
|
|
|
|
|
|
|
|
## <a name="arachni_web_import" href="#arachni_web_import">arachni_web_import</a> (Package only)
|
|
|
|
|
|
|
|
Imports the database and configuration of an older package to a new one in order to ease the
|
|
|
|
transitioning between different versions/packages.
|
|
|
|
|
|
|
|
## <a name="arachni_web_scan_import" href="#arachni_web_scan_import">arachni_web_scan_import</a> (Package only)
|
|
|
|
|
|
|
|
Imports AFR (Arachni Framework Report -- `.afr`) files as scans.
|
|
|
|
|
|
|
|
## <a name="arachni_web_create_user" href="#arachni_web_create_user">arachni_web_create_user</a> (Package only)
|
|
|
|
|
|
|
|
Allows you to create a new user for the Web interface from the command line.
|
|
|
|
|
|
|
|
## <a name="arachni_web_change_password" href="#arachni_web_change_password">arachni_web_change_password</a> (Package only)
|
|
|
|
|
|
|
|
Allows you to reset a Web interface user's password from the command line.
|
|
|
|
|
|
|
|
## <a name="arachni_console" href="#arachni_console">arachni_console</a>
|
|
|
|
|
|
|
|
Fires up an [IRB](http://en.wikipedia.org/wiki/Interactive_Ruby_Shell) console
|
|
|
|
after configuring it to operate under the namespace of the Arachni libraries.
|
|
|
|
|
|
|
|
It provides tab completion for class/module names and methods and command history.
|
|
|
|
|
|
|
|
## <a name="arachni_script" href="#arachni_script">arachni_script</a>
|
|
|
|
|
|
|
|
Used to run scripts under the namespace of the Arachni libraries -- provided for
|
|
|
|
just for convenience.
|
|
|
|
|
|
|
|
## <a name="arachni_shell" href="#arachni_shell">arachni_shell</a> (Package only)
|
|
|
|
|
|
|
|
Starts a ```bash``` shell under the environment of the package. |
|
|
|
_Some of those executables are only available via the self-contained packages._
|
|
|
|
|
|
|
|
* [arachni](#arachni)
|
|
|
|
* [arachni_reporter](#arachni_reporter)
|
|
|
|
* [arachni_restore](#arachni_restore)
|
|
|
|
* [arachni_rest_server](#arachni_rest_server)
|
|
|
|
* [arachni_rpc](#arachni_rpc)
|
|
|
|
* [arachni_rpcd](#arachni_rpcd)
|
|
|
|
* [arachni_rpcd_monitor](#arachni_rpcd_monitor)
|
|
|
|
* [arachni_web](#arachni_web) (Package only)
|
|
|
|
* [arachni_web_script](#arachni_web_script) (Package only)
|
|
|
|
* [arachni_web_import](#arachni_web_import) (Package only)
|
|
|
|
* [arachni_web_scan_import](#arachni_web_scan_import) (Package only)
|
|
|
|
* [arachni_web_create_user](#arachni_web_create_user) (Package only)
|
|
|
|
* [arachni_web_change_password](#arachni_web_change_password) (Package only)
|
|
|
|
* [arachni_console](#arachni_console)
|
|
|
|
* [arachni_script](#arachni_script)
|
|
|
|
* [arachni_shell](#arachni_shell) (Package only)
|
|
|
|
|
|
|
|
## <a name="arachni" href="#arachni">arachni</a>
|
|
|
|
|
|
|
|
Provides a command-line interface to the Arachni scanner.
|
|
|
|
See the relevant [[reference | Command-line-user-interface]] for more details.
|
|
|
|
|
|
|
|
## <a name="arachni_reporter" href="#arachni_reporter">arachni_reporter</a>
|
|
|
|
|
|
|
|
Generates reports in various formats from AFR (Arachni Framework Report -- `.afr`) files.
|
|
|
|
(AFR files are generated by all interfaces that can perform scans.)
|
|
|
|
|
|
|
|
## <a name="arachni_restore" href="#arachni_restore">arachni_restore</a>
|
|
|
|
|
|
|
|
Restores a suspended scan from an AFS (Arachni Framework Snapshot -- `.afs`) file.
|
|
|
|
(AFS files are generated by the `arachni` executable upon succesful suspension on a scan.)
|
|
|
|
|
|
|
|
## <a name="arachni_rest_server" href="#arachni_rest_server">arachni_rest_server</a>
|
|
|
|
|
|
|
|
Starts a [[REST server | REST-Server]].
|
|
|
|
|
|
|
|
## <a name="arachni_rpc" href="#arachni_rpc">arachni_rpc</a>
|
|
|
|
|
|
|
|
Provides a command-line RPC client for a [[Dispatcher | RPC-Server]]. Allows you to run a scan remotely.<br/>
|
|
|
|
See the relevant [[reference | RPC-client]] for more details.
|
|
|
|
|
|
|
|
## <a name="arachni_rpcd" href="#arachni_rpcd">arachni_rpcd</a>
|
|
|
|
|
|
|
|
Starts a [[Dispatcher | RPC-Server]].
|
|
|
|
|
|
|
|
## <a name="arachni_rpcd_monitor" href="#arachni_rpcd_monitor">arachni_rpcd_monitor</a>
|
|
|
|
|
|
|
|
Connects to a [[Dispatcher | RPC-Server]] and shows a few statistics like running
|
|
|
|
scans and their resource usage.
|
|
|
|
|
|
|
|
## <a name="arachni_web" href="#arachni_web">arachni_web</a> (Package only)
|
|
|
|
|
|
|
|
Starts the [Web User Interface](https://github.com/Arachni/arachni-ui-web).
|
|
|
|
|
|
|
|
## <a name="arachni_web_script" href="#arachni_web_script">arachni_web_script</a> (Package only)
|
|
|
|
|
|
|
|
Runs Ruby code in the context of the WebUI Rails environment, essentially delegates to [rails runner](http://guides.rubyonrails.org/command_line.html#rails-runner).
|
|
|
|
|
|
|
|
## <a name="arachni_web_import" href="#arachni_web_import">arachni_web_import</a> (Package only)
|
|
|
|
|
|
|
|
Imports the database and configuration of an older package to a new one in order to ease the
|
|
|
|
transitioning between different versions/packages.
|
|
|
|
|
|
|
|
## <a name="arachni_web_scan_import" href="#arachni_web_scan_import">arachni_web_scan_import</a> (Package only)
|
|
|
|
|
|
|
|
Imports AFR (Arachni Framework Report -- `.afr`) files as scans.
|
|
|
|
|
|
|
|
## <a name="arachni_web_create_user" href="#arachni_web_create_user">arachni_web_create_user</a> (Package only)
|
|
|
|
|
|
|
|
Allows you to create a new user for the Web interface from the command line.
|
|
|
|
|
|
|
|
## <a name="arachni_web_change_password" href="#arachni_web_change_password">arachni_web_change_password</a> (Package only)
|
|
|
|
|
|
|
|
Allows you to reset a Web interface user's password from the command line.
|
|
|
|
|
|
|
|
## <a name="arachni_console" href="#arachni_console">arachni_console</a>
|
|
|
|
|
|
|
|
Fires up an [IRB](http://en.wikipedia.org/wiki/Interactive_Ruby_Shell) console
|
|
|
|
after configuring it to operate under the namespace of the Arachni libraries.
|
|
|
|
|
|
|
|
It provides tab completion for class/module names and methods and command history.
|
|
|
|
|
|
|
|
## <a name="arachni_script" href="#arachni_script">arachni_script</a>
|
|
|
|
|
|
|
|
Used to run scripts under the namespace of the Arachni libraries -- provided for
|
|
|
|
just for convenience.
|
|
|
|
|
|
|
|
## <a name="arachni_shell" href="#arachni_shell">arachni_shell</a> (Package only)
|
|
|
|
|
|
|
|
Starts a ```bash``` shell under the environment of the package. |
