Skip to content

Commit 5c6c90d

Browse files
voltsparxvoltsparx
committed
Fixing
1 parent 1c82589 commit 5c6c90d

15 files changed

Lines changed: 1292 additions & 1288 deletions

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ coverage/
99
.asrfacet_rb/
1010
temp/
1111
tmp/
12-
output/
12+
/output/
1313
install/test-root/

‎docs/website/app.js‎

Lines changed: 187 additions & 199 deletions
Large diffs are not rendered by default.

‎docs/website/cli-reference.html‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>CLI Reference | ASRFacet-Rb</title>
7+
<link rel="preconnect" href="https://fonts.googleapis.com">
8+
<link href="https://fonts.googleapis.com/css2?family=Share+Tech+Mono&family=Rajdhani:wght@300;400;500;600;700&family=Orbitron:wght@400;600;700;900&display=swap" rel="stylesheet">
9+
<link rel="stylesheet" href="styles.css">
10+
</head>
11+
<body data-page="cli-reference.html" data-default-section="commands">
12+
<header id="topbar">
13+
<div id="topbar-logo-wrap"><img id="topbar-logo" src="web_assets/asrfacet-rb-web.png" alt="ASRFacet-Rb"><span id="topbar-name">ASRFacet-Rb</span></div>
14+
<span id="topbar-version">v1.0.0 · CLI Reference</span>
15+
<div id="topbar-links">
16+
<a href="index.html">⬡ Home</a>
17+
<a href="workflow.html#pipeline">🧭 Workflow</a>
18+
<a href="mailto:voltsparx@proton.me">✉ Contact</a>
19+
</div>
20+
<div id="topbar-actions">
21+
<button id="quick-jump-trigger" class="topbar-action" type="button">Quick Jump</button>
22+
<button id="menu-toggle" class="topbar-action topbar-action-menu" type="button">Menu</button>
23+
</div>
24+
</header>
25+
26+
<nav id="sidebar" aria-label="Documentation navigation">
27+
<div class="sidebar-panel-head">
28+
<div class="sidebar-kicker">CLI</div>
29+
<button class="sidebar-jump-btn" type="button" data-open-palette>Jump To Section</button>
30+
<p class="sidebar-note">Commands, shared flags, and syntax patterns for everyday operator use.</p>
31+
</div>
32+
<div id="sidebar-nav"></div>
33+
</nav>
34+
<button id="sidebar-backdrop" type="button" aria-label="Close navigation"></button>
35+
36+
<div id="command-palette" class="command-palette" hidden>
37+
<div class="command-palette-panel" role="dialog" aria-modal="true" aria-labelledby="command-palette-title">
38+
<div class="command-palette-head">
39+
<div>
40+
<div id="command-palette-title" class="command-palette-title">Quick Jump</div>
41+
<div class="command-palette-sub">Search commands, flags, syntax, and neighboring docs pages.</div>
42+
</div>
43+
<button id="command-palette-close" class="command-palette-close" type="button" aria-label="Close quick jump">×</button>
44+
</div>
45+
<label class="command-palette-search">
46+
<span>Search Docs</span>
47+
<input id="command-palette-input" type="search" placeholder="Try scan, passive, flags, syntax..." autocomplete="off">
48+
</label>
49+
<div id="command-palette-results" class="command-palette-results"></div>
50+
</div>
51+
</div>
52+
53+
<main id="main">
54+
<section id="commands" class="page-section active">
55+
<div class="page-hero">
56+
<div class="page-eyebrow">CLI Reference</div>
57+
<div class="page-title">Commands</div>
58+
<div class="page-desc">The command layout stays explicit so the user can tell what the framework is about to do before it does it.</div>
59+
</div>
60+
61+
<div class="cmd-grid">
62+
<div class="cmd-card"><div class="cmd-name">scan DOMAIN</div><div class="cmd-desc">Run the complete workflow from passive collection through findings and reports.</div></div>
63+
<div class="cmd-card"><div class="cmd-name">passive DOMAIN</div><div class="cmd-desc">Use passive sources only for a lower-noise first pass.</div></div>
64+
<div class="cmd-card"><div class="cmd-name">ports TARGET</div><div class="cmd-desc">Focus on service discovery without the whole web workflow.</div></div>
65+
<div class="cmd-card"><div class="cmd-name">dns DOMAIN</div><div class="cmd-desc">Inspect naming and resolution data without broader probing.</div></div>
66+
<div class="cmd-card"><div class="cmd-name">lab</div><div class="cmd-desc">Start the safe local practice target.</div></div>
67+
<div class="cmd-card"><div class="cmd-name">about / explain / manual</div><div class="cmd-desc">Read framework guidance without leaving the terminal.</div></div>
68+
</div>
69+
</section>
70+
71+
<section id="flags" class="page-section active">
72+
<div class="page-hero">
73+
<div class="page-eyebrow">CLI Reference</div>
74+
<div class="page-title">Global Flags</div>
75+
<div class="page-desc">These switches show up across multiple commands so the CLI feels consistent instead of fragmented.</div>
76+
</div>
77+
78+
<div class="tbl-wrap">
79+
<table>
80+
<thead><tr><th>Flag</th><th>Meaning</th><th>Typical Use</th></tr></thead>
81+
<tbody>
82+
<tr><td><code>--threads N</code></td><td>Set worker concurrency</td><td>Control speed versus stability</td></tr>
83+
<tr><td><code>--format cli|txt|html|json</code></td><td>Select the output style</td><td>Switch between operator, report, or automation views</td></tr>
84+
<tr><td><code>--output PATH</code></td><td>Write reports to a specific location</td><td>Save a named artifact</td></tr>
85+
<tr><td><code>--monitor</code></td><td>Compare the run against recon memory</td><td>Track change over time</td></tr>
86+
<tr><td><code>--headless</code></td><td>Use browser-backed rendering where available</td><td>Handle JS-heavy targets</td></tr>
87+
<tr><td><code>--web-session</code></td><td>Launch the local browser control panel</td><td>Operate through the web UI</td></tr>
88+
</tbody>
89+
</table>
90+
</div>
91+
</section>
92+
93+
<section id="syntax" class="page-section active">
94+
<div class="page-hero">
95+
<div class="page-eyebrow">CLI Reference</div>
96+
<div class="page-title">Syntax Guide</div>
97+
<div class="page-desc">The basic shape stays predictable: verb first, target second, then whatever tuning flags are needed.</div>
98+
</div>
99+
100+
<div class="code-wrap">
101+
<div class="code-header"><div class="code-dot"></div><div class="code-dot"></div><div class="code-dot"></div><span class="code-lang">shell</span></div>
102+
<div class="code-body">
103+
<span class="cm"># General shape</span>
104+
<span class="pn">$</span> asrfacet-rb <span class="kw">COMMAND</span> <span class="ar">TARGET</span> [<span class="fl">--flags</span> <span class="ar">values</span>]
105+
106+
<span class="cm"># Examples</span>
107+
<span class="pn">$</span> asrfacet-rb <span class="kw">scan</span> <span class="ar">example.com</span> <span class="fl">--format</span> html
108+
<span class="pn">$</span> asrfacet-rb <span class="kw">passive</span> <span class="ar">example.com</span> <span class="fl">--threads</span> 12
109+
<span class="pn">$</span> asrfacet-rb <span class="kw">ports</span> <span class="ar">api.example.com</span> <span class="fl">--ports</span> top100
110+
<span class="pn">$</span> asrfacet-rb <span class="kw">manual</span> <span class="ar">workflow</span>
111+
</div>
112+
</div>
113+
114+
<div class="callout callout-info">
115+
<div class="callout-title">Operator Habit</div>
116+
When you are unsure, start with <code>passive</code> or <code>lab</code> before escalating to <code>scan</code>.
117+
</div>
118+
</section>
119+
</main>
120+
121+
<footer id="site-footer">
122+
<div><div class="footer-col-title">CLI</div><span class="footer-copy">Commands, flags, and syntax</span></div>
123+
<div><div class="footer-col-title">Modes</div><a class="footer-link" href="modes.html#console">Console</a><a class="footer-link" href="modes.html#web">Web Session</a></div>
124+
<div><div class="footer-col-title">Reports</div><a class="footer-link" href="reporting.html#outputs">Output Formats</a><a class="footer-link" href="reporting.html#testing">Testing</a></div>
125+
<div><div class="footer-col-title">Home</div><a class="footer-link" href="index.html">Overview</a><a class="footer-link" href="getting-started.html#quickstart">Quick Start</a></div>
126+
</footer>
127+
128+
<script src="app.js"></script>
129+
</body>
130+
</html>

‎docs/website/getting-started.html‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>Getting Started | ASRFacet-Rb</title>
7+
<link rel="preconnect" href="https://fonts.googleapis.com">
8+
<link href="https://fonts.googleapis.com/css2?family=Share+Tech+Mono&family=Rajdhani:wght@300;400;500;600;700&family=Orbitron:wght@400;600;700;900&display=swap" rel="stylesheet">
9+
<link rel="stylesheet" href="styles.css">
10+
</head>
11+
<body data-page="getting-started.html" data-default-section="install">
12+
<header id="topbar">
13+
<div id="topbar-logo-wrap"><img id="topbar-logo" src="web_assets/asrfacet-rb-web.png" alt="ASRFacet-Rb"><span id="topbar-name">ASRFacet-Rb</span></div>
14+
<span id="topbar-version">v1.0.0 · Getting Started</span>
15+
<div id="topbar-links">
16+
<a href="index.html">⬡ Home</a>
17+
<a href="workflow.html#pipeline">🧭 Workflow</a>
18+
<a href="mailto:voltsparx@proton.me">✉ Contact</a>
19+
</div>
20+
<div id="topbar-actions">
21+
<button id="quick-jump-trigger" class="topbar-action" type="button">Quick Jump</button>
22+
<button id="menu-toggle" class="topbar-action topbar-action-menu" type="button">Menu</button>
23+
</div>
24+
</header>
25+
26+
<nav id="sidebar" aria-label="Documentation navigation">
27+
<div class="sidebar-panel-head">
28+
<div class="sidebar-kicker">Start Here</div>
29+
<button class="sidebar-jump-btn" type="button" data-open-palette>Jump To Section</button>
30+
<p class="sidebar-note">Install the framework, validate it, and follow a safe first-run path before touching a real authorized target.</p>
31+
</div>
32+
<div id="sidebar-nav"></div>
33+
</nav>
34+
<button id="sidebar-backdrop" type="button" aria-label="Close navigation"></button>
35+
36+
<div id="command-palette" class="command-palette" hidden>
37+
<div class="command-palette-panel" role="dialog" aria-modal="true" aria-labelledby="command-palette-title">
38+
<div class="command-palette-head">
39+
<div>
40+
<div id="command-palette-title" class="command-palette-title">Quick Jump</div>
41+
<div class="command-palette-sub">Search the full docs site and jump directly to any page or section.</div>
42+
</div>
43+
<button id="command-palette-close" class="command-palette-close" type="button" aria-label="Close quick jump">×</button>
44+
</div>
45+
<label class="command-palette-search">
46+
<span>Search Docs</span>
47+
<input id="command-palette-input" type="search" placeholder="Try install, quick start, testing..." autocomplete="off">
48+
</label>
49+
<div id="command-palette-results" class="command-palette-results"></div>
50+
</div>
51+
</div>
52+
53+
<main id="main">
54+
<section id="install" class="page-section active">
55+
<div class="page-hero">
56+
<div class="page-eyebrow">Getting Started</div>
57+
<div class="page-title">Installation</div>
58+
<div class="page-desc">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.</div>
59+
</div>
60+
61+
<div class="callout callout-info">
62+
<div class="callout-title">Prerequisites</div>
63+
Ruby 3.2 or newer is required. Check with <code>ruby --version</code> and <code>bundle --version</code> before installing.
64+
</div>
65+
66+
<div class="sec-head">Development Install</div>
67+
<div class="code-wrap">
68+
<div class="code-header"><div class="code-dot"></div><div class="code-dot"></div><div class="code-dot"></div><span class="code-lang">shell</span></div>
69+
<div class="code-body">
70+
<span class="cm"># Clone the repository</span>
71+
<span class="pn">$</span> git clone https://github.com/voltsparx/ASRFacet-Rb.git
72+
<span class="pn">$</span> cd ASRFacet-Rb
73+
74+
<span class="cm"># Install dependencies</span>
75+
<span class="pn">$</span> bundle install
76+
77+
<span class="cm"># Verify the repo end to end</span>
78+
<span class="pn">$</span> bundle exec rake
79+
80+
<span class="cm"># Confirm the CLI loads cleanly</span>
81+
<span class="pn">$</span> bundle exec ruby bin/asrfacet-rb help
82+
</div>
83+
</div>
84+
85+
<div class="sec-head">System Installers</div>
86+
<div class="prose">
87+
<p>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.</p>
88+
</div>
89+
90+
<div class="code-wrap">
91+
<div class="code-header"><div class="code-dot"></div><div class="code-dot"></div><div class="code-dot"></div><span class="code-lang">linux / macos / windows</span></div>
92+
<div class="code-body">
93+
<span class="cm"># Linux</span>
94+
<span class="pn">$</span> bash install/linux.sh <span class="kw">install</span>
95+
96+
<span class="cm"># macOS</span>
97+
<span class="pn">$</span> bash install/macos.sh <span class="kw">install</span>
98+
99+
<span class="cm"># Windows PowerShell</span>
100+
<span class="pn">PS&gt;</span> .\install\windows.ps1 <span class="kw">install</span>
101+
</div>
102+
</div>
103+
104+
<div class="tbl-wrap">
105+
<table>
106+
<thead><tr><th>Command</th><th>Purpose</th></tr></thead>
107+
<tbody>
108+
<tr><td><code>asrfacet-rb</code></td><td>Main system launcher</td></tr>
109+
<tr><td><code>asrfrb</code></td><td>Short alias to the same installed tool</td></tr>
110+
</tbody>
111+
</table>
112+
</div>
113+
</section>
114+
115+
<section id="quickstart" class="page-section active">
116+
<div class="page-hero">
117+
<div class="page-eyebrow">Getting Started</div>
118+
<div class="page-title">Quick Start</div>
119+
<div class="page-desc">A simple first-run path that starts safe, teaches the workflow, and avoids throwing a new user straight into active scanning.</div>
120+
</div>
121+
122+
<div class="tbl-wrap">
123+
<table>
124+
<thead><tr><th>Goal</th><th>Command</th><th>Outcome</th></tr></thead>
125+
<tbody>
126+
<tr><td>Validate the framework</td><td><code>asrfacet-rb lab</code></td><td>Runs against the local practice target instead of a real system</td></tr>
127+
<tr><td>Collect passive intel</td><td><code>asrfacet-rb passive example.com</code></td><td>Builds a low-noise picture before active probes</td></tr>
128+
<tr><td>Full recon</td><td><code>asrfacet-rb scan example.com --format html</code></td><td>Generates a full report bundle</td></tr>
129+
<tr><td>Browser-driven run</td><td><code>asrfacet-rb --web-session</code></td><td>Opens the local control panel</td></tr>
130+
</tbody>
131+
</table>
132+
</div>
133+
134+
<div class="sec-head">Recommended First Flow</div>
135+
<div class="code-wrap">
136+
<div class="code-header"><div class="code-dot"></div><div class="code-dot"></div><div class="code-dot"></div><span class="code-lang">shell</span></div>
137+
<div class="code-body">
138+
<span class="cm"># Step 1 - validate locally first</span>
139+
<span class="pn">$</span> asrfacet-rb <span class="kw">lab</span>
140+
141+
<span class="cm"># Step 2 - gather passive data on the authorized target</span>
142+
<span class="pn">$</span> asrfacet-rb <span class="kw">passive</span> <span class="ar">example.com</span>
143+
144+
<span class="cm"># Step 3 - run the complete workflow with a report</span>
145+
<span class="pn">$</span> asrfacet-rb <span class="kw">scan</span> <span class="ar">example.com</span> <span class="fl">--format</span> html
146+
</div>
147+
</div>
148+
149+
<div class="callout callout-warn">
150+
<div class="callout-title">Why This Order Helps</div>
151+
It confirms the framework itself, confirms your local environment, and delays active probing until the target and scope are both understood.
152+
</div>
153+
</section>
154+
</main>
155+
156+
<footer id="site-footer">
157+
<div><div class="footer-col-title">Getting Started</div><span class="footer-copy">Install, verify, and begin safely</span></div>
158+
<div><div class="footer-col-title">Next</div><a class="footer-link" href="workflow.html#pipeline">Workflow</a><a class="footer-link" href="cli-reference.html#commands">CLI Reference</a></div>
159+
<div><div class="footer-col-title">Modes</div><a class="footer-link" href="modes.html#web">Web Session</a><a class="footer-link" href="modes.html#lab">Lab Mode</a></div>
160+
<div><div class="footer-col-title">Home</div><a class="footer-link" href="index.html">Overview</a><a class="footer-link" href="project.html#author">Project</a></div>
161+
</footer>
162+
163+
<script src="app.js"></script>
164+
</body>
165+
</html>

0 commit comments

Comments
 (0)