quickstart.mdx

title	Quick Start
description	From sign-up to your first security report in 5 minutes. Install the CLI, authenticate, scan your system, and start real-time protection.
icon	rocket

This guide walks you through the fastest path to securing your first machine with Panguard AI.

Choose your platform and install Panguard with a single command.

<Tabs>
  <Tab title="macOS / Linux">
    ```bash
    curl -fsSL https://get.panguard.ai | bash
    ```
  </Tab>
  <Tab title="Windows">
    ```powershell
    powershell -ExecutionPolicy Bypass -Command "irm https://get.panguard.ai/windows | iex"
    ```
  </Tab>
  <Tab title="npm (all platforms)">
    ```bash
    npm install -g @panguard-ai/panguard
    ```
  </Tab>
</Tabs>

Verify the installation:

```bash
panguard --version
# Expected: 0.3.1
```

<Tip>
  **Intel Mac users:** The curl installer downloads the ARM64 binary. Either install via npm
  (`npm install -g @panguard-ai/panguard`) or enable Rosetta 2 first
  (`softwareupdate --install-rosetta`) before using the curl installer.
</Tip>

If you do not have an account yet, sign up at [panguard.ai](https://panguard.ai). The Community plan is free and requires no credit card.

Then authenticate from the CLI:

```bash
panguard login
```

Your browser opens automatically. After completing authentication, return to the terminal:

```
  PANGUARD AI

  -- Login Info ----------------------------------------

  Email     user@example.com
  Name      User Name
  Plan      Solo
  Expires   2026-04-27

  Login successful!
```

<Info>
  **Headless servers:** Use `panguard login --no-browser` to get a URL you can open on another device.
</Info>

Execute a quick security audit of your system:

```bash
panguard scan --quick
```

The scan completes in approximately 30 seconds and produces a risk assessment:

```
  PANGUARD AI - Security Scanner

  Scanning system environment...

  -- Security Findings ----------------------

  CRITICAL  Port 22 (SSH) exposed to 0.0.0.0
  HIGH      No firewall rules detected
  MEDIUM    Password policy not enforced
  LOW       12 unnecessary services running

  -- Risk Score -----------------------------

  Score: 62/100 [============--------] Grade: C

  -- Recommendations ------------------------

  1. Restrict SSH access to specific IP ranges
  2. Enable and configure system firewall
  3. Enforce password complexity requirements
```

Remove the `--quick` flag for a full scan (~60 seconds) that includes SSL certificate validation, scheduled task audit, and shared folder checks.

<Tabs>
  <Tab title="Generate PDF report">
    ```bash
    panguard scan --output my-report.pdf
    ```
  </Tab>
  <Tab title="Traditional Chinese output">
    ```bash
    panguard scan --lang zh-TW
    ```
  </Tab>
  <Tab title="Full scan">
    ```bash
    panguard scan
    ```
  </Tab>
</Tabs>

A scan is a one-time check. For continuous protection, start the Guard engine:

```bash
panguard guard start
```

```
  PANGUARD AI - Guard Engine

  Guard engine starting...

  -- Status ---------------------------------

  Mode:       Learning (Day 1/7)
  Monitoring: processes, network, files
  Rules:      3,155 Sigma rules loaded
  Score:      --/100 (building baseline)

  Guard is now protecting your system.
  Learning mode: AI is observing normal behavior.
  Protection mode activates automatically after 7 days.
```

<Info>
  **How Guard works:** During the first 7 days, the AI observes normal system behavior and builds a baseline (no false positives during this period). Starting on day 8, it automatically detects anomalies, executes responses, and notifies you.
</Info>

What to do next

Now that your system is scanned and protected, explore these features:

Receive alerts via Telegram, Slack, or Email when threats are detected. Catch attackers with 8 types of decoy services. Requires Pro plan. Auto-generate ISO 27001, SOC 2, and Taiwan TCSA audit reports. Full reference for every Panguard command and flag.