← VigilAI

Documentation

Quick start

  1. Register and create a host in the dashboard.
  2. Copy the install command (or run the agent with the token).
  3. Metrics appear within about a minute.
  4. Default rules alert on high CPU, memory, and disk.

Agent (dev)

pnpm --filter @vigilai/agent start -- --token TOKEN --url http://localhost:3002

Support runbooks

See the repository docs/support/ folder for agent offline, missing metrics, alert noise, AI, billing, abuse, GDPR, and platform incident playbooks.

API

Control plane defaults to http://localhost:3001. Ingest is http://localhost:3002. OpenAPI-style route list is in docs/api/README.md.

Legal

GDPR export/delete is available under Billing. DPA template: docs/legal/DPA.md. Public status: /status.

Phase 2 features