Getting Started

Installation

Use Bundler in the repo for development, or use the install scripts when you want the framework placed like a real app on your system.

Prerequisites

Ruby 3.2 or newer is required. Check with ruby --version and bundle --version before installing.

Installation Paths

Repo Development

Use this when developing ASRFacet-Rb locally and running full validation from source.

View development steps

System Install Scripts

Use platform scripts from the repo to install the framework as a real system tool with launchers.

View system install commands

Website Download Installers

Download standalone installers from the website that fetch required files and run lifecycle mode.

Open dedicated download center

Development Install

shell

# Clone the repository
$ git clone https://github.com/voltsparx/ASRFacet-Rb.git
$ cd ASRFacet-Rb

# Install dependencies
$ bundle install

# Verify the repo end to end
$ bundle exec rake

# Confirm the CLI loads cleanly
$ bundle exec ruby bin/asrfacet-rb help
      

System Installers

The installers build a real application folder, create launchers on your user PATH, and keep user data outside the app folder so reinstalling does not wipe reports or saved session state.

linux / macos / windows

# Linux
$ bash install/linux.sh install

# macOS
$ bash install/macos.sh install

# Windows PowerShell
PS> .\install\windows.ps1 install

# Windows CMD (website installer)
C:\> asrfacet-rb-installer-windows.cmd install --yes
      

Command	Purpose
`asrfacet-rb`	Main system launcher
`asrfrb`	Short alias to the same installed tool

Website Download Installers

Prefer using the dedicated Download Center for the cleanest installer flow.

If you are starting from the docs website directly, download one installer below. Each installer fetches only required framework files into a temporary folder (sparse checkout), keeps root README.md and LICENSE, includes only docs/images from docs, then runs the same maintained lifecycle scripts used by repository installs.

Open installer usage guide for modes, flags, and troubleshooting notes.

Platform	Download	Start Command
Linux	asrfacet-rb-installer-linux.sh	`bash asrfacet-rb-installer-linux.sh install`
macOS	asrfacet-rb-installer-macos.sh	`bash asrfacet-rb-installer-macos.sh install`
Windows	asrfacet-rb-installer-windows.ps1 or asrfacet-rb-installer-windows.cmd	`asrfacet-rb-installer-windows.cmd install --yes`

installer modes

# Supports: install, test, update, uninstall
$ bash asrfacet-rb-installer-linux.sh update --verbose
$ bash asrfacet-rb-installer-macos.sh uninstall
PS> .\asrfacet-rb-installer-windows.ps1 install --yes
      

Install Paths and Data

Website installers place the application like a real tool using the platform install scripts, while keeping operator data under ~/.asrfacet_rb. You can still use the repository flow (bundle install + bundle exec rake) when developing locally.

Getting Started

Quick Start

A simple first-run path that starts safe, teaches the workflow, and avoids throwing a new user straight into active scanning.

Goal	Command	Outcome
Validate the framework	`asrfacet-rb lab`	Runs against the local practice target instead of a real system
Collect passive intel	`asrfacet-rb passive example.com`	Builds a low-noise picture before active probes
Full recon	`asrfacet-rb scan example.com --format html`	Generates a full report bundle
Browser-driven run	`asrfacet-rb --web-session`	Opens the local control panel

Recommended First Flow

shell

# Step 1 - validate locally first
$ asrfacet-rb lab

# Step 2 - gather passive data on the authorized target
$ asrfacet-rb passive example.com

# Step 3 - run the complete workflow with a report
$ asrfacet-rb scan example.com --format html
      

Why This Order Helps

It confirms the framework itself, confirms your local environment, and delays active probing until the target and scope are both understood.