Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • A arachni
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 125
    • Issues 125
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 8
    • Merge requests 8
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Arachni - Web Application Security Scanner Framework
  • arachni
  • Wiki
  • Guides
  • User
  • Executables

Executables · Changes

Page history
Switched id attributes to name authored Aug 17, 2014 by Tasos Laskos's avatar Tasos Laskos
Show whitespace changes
Inline Side-by-side
guides/user/Executables.md
View page @ f1c2d3a4
......@@ -16,75 +16,75 @@ _Some of those executables are only available via the self-contained packages._
* [arachni_script](#arachni_script)
* [arachni_shell](#arachni_shell) (Package only)
## <a id="arachni" href="#arachni">arachni</a>
## <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 id="arachni_reporter" href="#arachni_reporter">arachni_reporter</a>
## <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 id="arachni_restore" href="#arachni_restore">arachni_restore</a>
## <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 id="arachni_multi" href="#arachni_multi">arachni_multi</a>
## <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 id="arachni_rpc" href="#arachni_rpc">arachni_rpc</a>
## <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 id="arachni_rpcd" href="#arachni_rpcd">arachni_rpcd</a>
## <a name="arachni_rpcd" href="#arachni_rpcd">arachni_rpcd</a>
Starts a [[Dispatcher | RPC-Server]].
## <a id="arachni_rpcd_monitor" href="#arachni_rpcd_monitor">arachni_rpcd_monitor</a>
## <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 id="arachni_web" href="#arachni_web">arachni_web</a> (Package only)
## <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 id="arachni_web_import" href="#arachni_web_import">arachni_web_import</a> (Package only)
## <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 id="arachni_web_scan_import" href="#arachni_web_scan_import">arachni_web_scan_import</a> (Package only)
## <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 id="arachni_web_create_user" href="#arachni_web_create_user">arachni_web_create_user</a> (Package only)
## <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 id="arachni_web_change_password" href="#arachni_web_change_password">arachni_web_change_password</a> (Package only)
## <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 id="arachni_console" href="#arachni_console">arachni_console</a>
## <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 id="arachni_script" href="#arachni_script">arachni_script</a>
## <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 id="arachni_shell" href="#arachni_shell">arachni_shell</a> (Package only)
## <a name="arachni_shell" href="#arachni_shell">arachni_shell</a> (Package only)
Starts a ```bash``` shell under the environment of the package.
Clone repository

Pages [all]

  • Home
  • Installation instructions
  • For users
    • Executables
    • Command Line Interface
    • Web User Interface
    • Distributed components (Dispatchers and Instances)
      • RPC Client
      • RPC Server (Dispatcher)
  • For developers
    • Core API documentation
    • RPC API
    • Development environment

Can't find what you're looking for? Why not have a look at the support portal?