XtraShield Agent (xtrashield-scan)

Local system security scanner for XtraShield. It audits the machine it runs on — open ports, running processes, installed software, and file/permission issues — computes a local security score, and uploads the results to your XtraShield dashboard, authenticated with your personal API key.

Install & run

No install needed:

npx xtrashield-scan --key xtra_your_api_key

Or install globally:

npm install -g xtrashield-agent
xtrashield-scan --key xtra_your_api_key

Get your API key from the Scanner page of your dashboard (/scanner).

Options

| Flag | Description | Default | |------|-------------|---------| | --key <apiKey> | Required. Your XtraShield API key (xtra_…). | — | | --api-url <url> | XtraShield server URL. | https://xtrashield.vercel.app |

You can also set the server via the XTRASHIELD_API_URL environment variable (useful for local development, e.g. http://localhost:3000).

What it collects

• OS: platform, distro, version, kernel, hostname
• Network: interfaces and listening/open ports (via ss/netstat)
• Processes: top processes by CPU, with basic risk tagging
• Software: installed packages/applications (per-platform) — checked against the OSV.dev vulnerability database server-side
• Permissions: world-writable config files, SUID binaries (Linux/macOS), admin-context check (Windows)

All findings are sent only to the XtraShield server you point it at, over HTTPS, using your API key. Nothing is shared with third parties by the agent.

Requirements

• Node.js ≥ 18
• Works on Linux, macOS, and Windows. Some checks (SUID/world-writable, full software inventory) are richer with elevated privileges.

Example

  🛡️  XtraShield Security Agent v1.0.1

  Server:  https://xtrashield.vercel.app
  Key:     xtra_1a2b3c4d...ef01

  ✔ Scan uploaded successfully!

  Results:
    Score:      82/100
    Open Ports: 5
    Processes:  50 (top by CPU)
    Software:   48 packages
    Perm Issues: 1

  View report: https://xtrashield.vercel.app/scanner

MIT © XtraShield