Skip to content

catnet-io/catnet

Repository files navigation

catnet

CI Go Version Release License: MIT

Scriptable network scanner CLI. Part of the CatNet ecosystem.

Installation

From binary (recommended)

Download the latest release from the GitHub Releases page.

From source

go install github.com/catnet-io/catnet/cmd/catnet@latest

Usage

Basic scan

catnet scan 192.168.1.0/24

Multiple targets

catnet scan 192.168.1.0/24,10.0.0.1-10

JSON output (for scripting)

catnet scan 192.168.1.0/24 --format json | jq '.devices[] | select(.isAlive)'

Save and re-export

catnet scan 192.168.1.0/24 --format json -o result.json
catnet export result.json --format csv -o result.csv

Custom port scan

catnet scan 192.168.1.0/24 --ports 22,80,443,8080,3306

Default ports: 22, 80, 443, 139, 445, 3389. Use --no-ports to skip port scanning entirely.

Quiet mode (scripts/CI)

catnet scan 192.168.1.0/24 --format json --quiet

Output Reference

The JSON output contains the following structure:

Field Type Description
schemaVersion string The version of the JSON schema (e.g., "1.0.0")
startTime string ISO 8601 timestamp when the scan started
endTime string ISO 8601 timestamp when the scan completed
total int Total number of IP addresses scanned
alive int Total number of hosts found alive
devices array List of scanned devices with their details

Device fields:

Field Type Description
ip string IPv4 address
isAlive boolean True if the host responded to ping
hostname string Reverse DNS hostname
mac string MAC address (if on local subnet)
openPorts array[int] List of open ports discovered

Exit Codes

Code Description
0 Success
1 Input error (invalid targets or flags)
2 Runtime error (engine failure or export failure)
130 Interrupted (cancelled by signal, e.g., Ctrl+C)

Ecosystem

Repository Role
catnet-core Shared scanning engine (no CLI/GUI)
catnet This repository � Scriptable CLI
catnet-tui Interactive TUI interface
catnet-scanner Desktop GUI application

License

MIT

Part of the CatNet ecosystem

Repository Role
⚙️ catnet-io/engine Shared Go scanning engine
💻 catnet-io/catnet CLI
🖥️ catnet-io/app Desktop app
📟 catnet-io/tui Terminal UI

About

CatNet CLI — command-line interface for network scanning and monitoring

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors