Documentation

Everything you need to know about HLM.

Quick Start

Get up and running with HLM in under 5 minutes.

# Install HLM

$ curl -sSL https://hlmai.xyz/install | sh

# Run your first scan

$ hlm run https://example.com --goal "map attack surface"

Basic Usage

Running a Scan

hlm run [TARGET] --goal "[OBJECTIVE]" [OPTIONS]

Common Options

--safe Run in safe mode (no destructive actions)

--output Specify output format (json, html, pdf)

--verbose Enable detailed logging

--timeout Set execution timeout in seconds

Configuration

HLM can be configured via ~/.hlm/config.yaml

# Example configuration

default_mode: safe

output_format: json

log_level: info

max_threads: 10

timeout: 3600

API Reference

hlm.run()

Execute an HLM operation programmatically.

from hlm import HLM

client = HLM()

result = client.run(

target="https://example.com",

goal="map attack surface",

safe=True

)

Examples

Reconnaissance

hlm run https://target.com --goal "enumerate subdomains and services"

Vulnerability Assessment

hlm run https://target.com --goal "identify common vulnerabilities" --safe

API Testing

hlm run https://api.target.com --goal "test authentication endpoints" --output json

Troubleshooting

Installation Issues

Ensure Python 3.9+ is installed and accessible in your PATH.

Permission Errors

Run with appropriate permissions or configure permission boundaries in config.

GPU Not Detected

Verify CUDA drivers are installed and GPU is accessible via nvidia-smi.

Need More Help?

Join our community or check the GitHub repository for more resources.

Visit GitHub →