Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/DevDonzo/warden/llms.txt

Use this file to discover all available pages before exploring further.

The console command starts a lightweight HTTP server on your local machine and opens a browser-based security dashboard that gives you a live view of your project’s security posture. The dashboard automatically refreshes every six seconds by polling the local API, so it stays current as you run scans. No external service or internet connection is required — everything runs entirely on your workstation. Running warden with no arguments also launches the console with default settings.

Synopsis

warden console [options]
warden ui [options]   # alias
console and ui are identical commands. Both accept the same flags and produce the same output.

Flags

FlagTypeDefaultDescription
--host <host>string127.0.0.1Hostname or IP address to bind the HTTP server to.
--port <number>number8787Preferred TCP port for the console server. If the port is already in use, Warden automatically tries the next available port (up to 20 attempts).
--no-openboolean flagStart the server without automatically opening a browser tab. Useful for headless environments or when you want to open the URL manually.
The console binds to 127.0.0.1 (loopback) by default. It is intentionally not exposed on 0.0.0.0 or any external interface. Do not change --host to a public address in shared or production environments, as the dashboard serves unauthenticated read access to your local scan data.

What the console displays

The dashboard is divided into a left sidebar and a main panel grid.
  • Project root — absolute path to the directory Warden is reading from.
  • Scanner — scanner type used in the most recent scan (snyk, npm-audit, etc.).
  • Mode — scan mode (sast or dast).
  • Artifact readiness — a checklist of generated files (scan results, markdown report, html report, approval request, agent run record, advisory, baseline) showing whether each file currently exists on disk.

Main panel grid

PanelContents
RiskNumeric risk score out of 100 and current posture label (critical, elevated, guarded, or stable).
FindingsTotal vulnerability count from the most recent scan.
FixableNumber of vulnerabilities Warden can remediate automatically.
ManualNumber of vulnerabilities requiring human review.
Top FindingsUp to 8 highest-severity vulnerabilities — package name, finding title, CVE/ID, and version.
Baseline DeltaComparison against the committed .warden-baseline.json: new findings, worsened findings, resolved findings, and net risk-score delta.
Run HistoryRisk-score bar chart for the last 8 scan runs, labelled by date.
Memory HotspotsPackages that have appeared repeatedly across runs, ranked by occurrence count and severity.
When no scan data exists yet, the dashboard displays a standing-by message and prompts you to run warden scan.

How to stop

Press Ctrl+C in the terminal where the console is running. Warden closes the HTTP server gracefully before exiting.

Examples

warden console

Port conflict handling

If the port you request is already in use, Warden does not fail immediately. It increments the port number and retries up to 20 times. The URL it actually binds to is printed to the terminal after startup:
✓ Warden console listening at http://127.0.0.1:8788
  Opened the local console in your browser.
  Press Ctrl+C to stop the console.
If all 20 candidate ports are occupied, Warden exits with an error. In that case, pick a different base port with --port.

Console API

The console exposes a minimal JSON API on the same host and port:
EndpointDescription
GET /Serves the full dashboard HTML.
GET /api/stateReturns the current console state as JSON (scan summary, baseline comparison, history, memory, artifacts).
GET /assets/warden-mark.svgServes the Warden logo SVG.
The /api/state endpoint is what the dashboard polls every six seconds to keep itself up to date. You can also query it directly from a script or browser developer tools to inspect the raw state.

Build docs developers (and LLMs) love