Getting Started

Getting Started

Verify Installation

catnet version

Expected output:

catnet/v0.2.0 (linux/amd64) go1.26.3
catnet-core/v0.2.0

Your First Scan — Single Host

catnet scan 192.168.1.1

Annotated human output:

Scanning 1 hosts...

  IP            HOSTNAME        MAC                STATUS   PORTS
  192.168.1.1   router.local    AA-BB-CC-DD-EE-01  ALIVE    80, 443

Scan complete in 1.2s

Your First Scan — Subnet

catnet scan 192.168.1.0/24

You can specify targets using:

• CIDR notation: 192.168.1.0/24
• Dash ranges: 192.168.1.1-254
• Comma-separated targets: 192.168.1.0/24,10.0.0.1
• Multiple positional arguments: catnet scan 192.168.1.0/24 10.0.0.1

Save Results to JSON

catnet scan 192.168.1.0/24 --format json -o results.json

The JSON output follows this schema:

{
  "schemaVersion": "2.0.0",
  "startTime": "2026-06-06T12:00:00Z",
  "endTime": "2026-06-06T12:00:05Z",
  "total": 1,
  "alive": 1,
  "devices": [
    {
      "ip": "127.0.0.1",
      "mac": "",
      "hostname": "",
      "isAlive": true,
      "openPorts": [
        22,
        80
      ]
    }
  ]
}

Re-export to CSV or XML

catnet export results.json --format csv
catnet export results.json --format xml -o results.xml

Understanding Exit Codes

Code	Description
0	Success
1	Input error (invalid target, bad flag)
2	Runtime error (engine failure, export failure)
130	Interrupted (Ctrl+C / SIGTERM)

Next Steps

• CLI Reference — full flag documentation
• Output Reference — output schema details
• Use Cases — real-world recipes