CLI Reference
Find AssetLoom Network Scanner CLI commands, options, flags, and examples for configuring scans, running dry runs, saving results, and managing output.
AssetLoom Network Scanner is operated through the command line, with CLI options for configuring the scanner, validating targets, running scans, managing output, and checking scanner information.
This guide will help you look up a command or understand what each CLI option does. It covers the available commands and options for macOS, Windows, and Linux.
1. Basic Command Format
A typical scanner command looks like this:
- macOS/Linux:
sudo ./assetloom-scanner OPTIONS TARGET - Windows:
.\assetloom-scanner.exe OPTIONS TARGET
TARGET is the IP address or network you want to scan, for example: 192.168.1.50
Once you understand this structure, you can add different options depending on what you want the scanner to do.
2. Common Commands
The following commands cover the most common actions you may need, from creating your configuration file to running a scan and saving the results.
Create a Configuration File
Use this when setting up the scanner for the first time.
- macOS/Linux:
sudo ./assetloom-scanner --config ./config.json --init-config - Windows:
.\assetloom-scanner.exe --config .\config.json --init-config
--init-config creates a new configuration file. It will not overwrite an existing one.
Check Your Setup Before Scanning
Use --dry-run to check whether your target and configuration are ready without sending discovery packets.
- macOS/Linux:
sudo ./assetloom-scanner --config ./config.json --dry-run TARGET - Windows:
.\assetloom-scanner.exe --config .\config.json --dry-run TARGET
Run a Scan and Save CSV Results
CSV is the default output format.
- macOS/Linux:
sudo ./assetloom-scanner --config ./config.json --output ./devices.csv TARGET - Windows:
.\assetloom-scanner.exe --config .\config.json --output .\devices.csv TARGET
Run a Scan and Save JSON Results
Use --format json and save the output with a .json extension.
- macOS/Linux:
sudo ./assetloom-scanner --config ./config.json --format json --output ./devices.json TARGET - Windows:
.\assetloom-scanner.exe --config .\config.json --format json --output .\devices.json TARGET
Replace an Existing Result File
The scanner does not overwrite an existing result file by default.
Add --force-output when you intentionally want to replace it.
- macOS/Linux:
sudo ./assetloom-scanner --config ./config.json --output ./devices.csv --force-output TARGET - Windows:
.\assetloom-scanner.exe --config .\config.json --output .\devices.csv --force-output TARGET
Use a different filename if you want to keep the previous scan result.
Check the Scanner Version
Use --version to check which scanner build you are running.
- macOS/Linux:
./assetloom-scanner --version - Windows:
.\assetloom-scanner.exe --version
3. CLI Options at a Glance
| Option | When to use it |
|---|---|
--config PATH | Choose which configuration file the scanner should use. |
--init-config | Create a new configuration file. |
--dry-run | Check the target and scan setup before scanning. |
--output PATH | Choose where scan results are saved. |
--format csv | Save results as CSV. |
--format json | Save results as JSON. |
--force-output | Replace an existing output file. |
--version | Check the scanner version and build information. |