Skip to content

usage.md

Latest commit

 

History

History
133 lines (100 loc) · 4.22 KB

usage.md

File metadata and controls

133 lines (100 loc) · 4.22 KB
Raw

Usage Guide

This guide walks through every IntelCLI command with realistic examples. Every command supports --help for full, always-up-to-date option documentation.

Global options

intelcli --version       # print the installed version
intelcli --verbose ...   # echo INFO+ level logs to the console (any command)
intelcli --help           # top-level command list

intelcli domain

Runs a full domain investigation: WHOIS, DNS, SSL certificate, HTTP security headers, and best-effort technology detection.

intelcli domain example.com
intelcli domain https://www.example.com/some/path   # scheme/www/path stripped automatically
intelcli domain example.com --skip-ssl               # skip the TLS handshake
intelcli domain example.com --skip-tech               # skip technology detection
intelcli domain example.com --export json             # write results to exports/domain_example.com.json

A single failing data source (e.g. a WHOIS server timeout) never aborts the whole command — you still get every other section, plus a warning explaining what failed.

intelcli ip

intelcli ip 8.8.8.8
intelcli ip 2001:4860:4860::8888        # IPv6 supported
intelcli ip 192.168.1.1                  # private ranges: geolocation is automatically skipped
intelcli ip 1.1.1.1 --export csv

intelcli email

Performs only lawful, passive checks — regex syntax validation and a public DNS MX lookup. IntelCLI never performs SMTP probing against mail servers.

intelcli email user@example.com
intelcli email not-an-email              # still exits 0; shows is_syntax_valid=False
intelcli email user@example.com --export html

intelcli username

Checks for account-existence signals across common public platforms (GitHub, GitLab, Reddit, PyPI, Docker Hub, Medium, dev.to, Keybase, Steam, and more) via a single lawful GET request per platform, run concurrently.

intelcli username torvalds
intelcli username torvalds --export json

The number of concurrent workers is configurable:

intelcli config set preferences.max_username_lookup_workers 4

intelcli company

intelcli company "Acme Corp"
intelcli company "Anthropic" --export csv

Uses Clearbit's free autocomplete endpoint by default; supplying an OpenCorporates API key (see installation.md) also queries official company-registration records.

intelcli report

Auto-detects whether the target is a domain, IP, email, or username, and runs the appropriate investigation.

intelcli report example.com
intelcli report 8.8.8.8
intelcli report user@example.com
intelcli report torvalds
intelcli report example.com --type username   # force a specific interpretation
intelcli report example.com --export json

intelcli history

Every investigation (successful or not) is recorded locally.

intelcli history                       # last 20 investigations
intelcli history --limit 50
intelcli history --search example.com
intelcli history show                  # equivalent to the default action
intelcli history clear                 # prompts for confirmation
intelcli history clear --yes           # skip the confirmation prompt

intelcli config

intelcli config                                              # show current config (secrets redacted)
intelcli config show
intelcli config set api_keys.ipinfo_token YOUR_TOKEN
intelcli config set preferences.default_export_format html
intelcli config path                                          # print the config file location

Export formats

Every command accepts --export {json,csv,html}. Files are written to the exports/ directory inside IntelCLI's application directory (see installation.md) and the exact path is printed after each export.

  • JSON — the full structured result, ideal for scripting/automation.
  • CSV — a flattened field,value table, ideal for spreadsheets.
  • HTML — a styled, standalone report you can open in a browser or share.

Exit codes

Code Meaning
0 Success (including "no matches found" outcomes)
1 Invalid input (e.g. malformed domain/IP/username) or unrecoverable error
2 CLI usage error (e.g. unknown command/option)