Skip to content

README.md

Latest commit

 

History

History
75 lines (54 loc) · 1.71 KB

README.md

File metadata and controls

75 lines (54 loc) · 1.71 KB

Frontguard CLI Docs

Frontguard CLI is the repeatable, scriptable companion to the Frontguard browser extension.

Use it for:

  • Local frontend builds
  • Public URLs
  • Localhost development servers
  • HAR files exported from DevTools
  • Interactive deep browser sessions
  • CI checks
  • Copy-friendly reports for issues, PRs, and AI-assisted fixes

Quick Start

npm install
npm run build
node dist/index.js scan ./dist

Useful commands:

frontguard start
fguard start
node dist/index.js scan ./dist --copy
node dist/index.js scan http://localhost:3000 --copy
node dist/index.js scan-har ./session.har --markdown
node dist/index.js deep-scan http://localhost:3000 --copy
node dist/index.js rules list

When installed globally or published, the command name should be:

frontguard scan ./dist

Short alias:

fguard scan ./dist

Guided Start

For the friendliest workflow, run:

frontguard start

The wizard asks:

  • What you want to scan: normal scan, deep active scan, HAR file, or saved JSON report.
  • What target to use: folder, build output, URL, localhost URL, HAR path, or report path.
  • How to output results: terminal text, copy-friendly Markdown, Markdown file, JSON file, or SARIF file.
  • Whether to include third-party evidence.

This is best for non-technical users or anyone who does not want to memorize commands.

Safety Model

Frontguard CLI is defensive by default:

  • It does not replay requests.
  • It does not fuzz endpoints.
  • It does not submit forms automatically.
  • It does not mutate data by itself.
  • deep-scan only captures traffic while you use the browser.
  • Reports mask secret values by default.

Use it only on apps you own or are authorized to assess.