Skip to content
HookProbe Docs

CLI Reference

CLI Reference

The hookprobe-ctl command provides unified management of HookProbe.

Syntax

Terminal window
hookprobe-ctl <command> [options]

Service Management

status

Show service status.

Terminal window
hookprobe-ctl status

Output:

HookProbe Status:
─────────────────
Agent:     running (PID 1234)
Provision: completed
XDP:       loaded (native mode)
Uptime:    2d 5h 32m

start

Start all HookProbe services.

Terminal window
hookprobe-ctl start

stop

Stop all HookProbe services.

Terminal window
hookprobe-ctl stop

restart

Restart all services.

Terminal window
hookprobe-ctl restart

enable

Enable auto-start on boot.

Terminal window
hookprobe-ctl enable

disable

Disable auto-start.

Terminal window
hookprobe-ctl disable

Monitoring

health

Check health status.

Terminal window
hookprobe-ctl health

Options:

Terminal window
--json         # Output as JSON
--engines      # Include engine status
--verbose      # Detailed output

metrics

View current metrics.

Terminal window
hookprobe-ctl metrics

Options:

Terminal window
--format prometheus   # Prometheus format
--filter <pattern>    # Filter metrics
--history            # Include history
--since <duration>   # Time range (e.g., 24h)

Example:

Terminal window
hookprobe-ctl metrics --filter qsecbit --format json

logs

View and follow logs.

Terminal window
hookprobe-ctl logs

Options:

Terminal window
-f, --follow          # Follow log output
-n, --lines <n>       # Number of lines (default: 50)
<service>             # Specific service logs

Examples:

Terminal window
hookprobe-ctl logs -f
hookprobe-ctl logs -n 100
hookprobe-ctl logs hookprobe-provision.service

Updates

update

Manually update HookProbe.

Terminal window
sudo hookprobe-ctl update

What it does:

  1. Create backup
  2. Pull from GitHub
  3. Apply updates
  4. Re-provision
  5. Restart services
  6. Verify health
  7. Rollback on failure

enable-autoupdate

Enable weekly auto-updates.

Terminal window
sudo hookprobe-ctl enable-autoupdate

disable-autoupdate

Disable auto-updates.

Terminal window
sudo hookprobe-ctl disable-autoupdate

Configuration

config

Manage configuration.

Terminal window
hookprobe-ctl config <subcommand>

Subcommands:

Terminal window
show       # Display active configuration
validate   # Validate config files
test       # Test configuration changes

Examples:

Terminal window
hookprobe-ctl config show
hookprobe-ctl config validate
hookprobe-ctl config test --file /etc/hookprobe/config.yaml

Mesh Operations

mesh

Manage mesh connectivity.

Terminal window
hookprobe-ctl mesh <subcommand>

Subcommands:

Terminal window
status     # Show mesh status
peers      # List connected peers
stats      # View contribution statistics

Examples:

Terminal window
hookprobe-ctl mesh status
hookprobe-ctl mesh peers
hookprobe-ctl mesh stats

DSM Operations

dsm

Manage DSM ledger.

Terminal window
hookprobe-ctl dsm <subcommand>

Subcommands:

Terminal window
status          # Show DSM status
blocks          # List microblocks
checkpoint      # View checkpoint
verify          # Verify inclusion

Examples:

Terminal window
hookprobe-ctl dsm status
hookprobe-ctl dsm blocks --recent 10
hookprobe-ctl dsm checkpoint --epoch 147
hookprobe-ctl dsm verify --block <hash> --checkpoint <epoch>

VLAN Operations (Fortress)

vlan

Manage VLANs.

Terminal window
hookprobe-ctl vlan <subcommand>

Subcommands:

Terminal window
list       # List all VLANs
add        # Add new VLAN
remove     # Remove VLAN
status     # VLAN status

Examples:

Terminal window
hookprobe-ctl vlan list
hookprobe-ctl vlan add --id 50 --name "development"
hookprobe-ctl vlan remove --id 50

flows

Manage OpenFlow rules.

Terminal window
hookprobe-ctl flows <subcommand>

Subcommands:

Terminal window
list       # List flow rules
add        # Add flow rule
remove     # Remove flow rule

Fleet Operations (Nexus)

fleet

Manage edge node fleet.

Terminal window
hookprobe-ctl fleet <subcommand>

Subcommands:

Terminal window
list       # List managed nodes
health     # Check fleet health
config     # Push configuration
deploy     # Deploy model/update

Examples:

Terminal window
hookprobe-ctl fleet list
hookprobe-ctl fleet health
hookprobe-ctl fleet config --update baseline.yaml
hookprobe-ctl fleet deploy --model threat-v4.onnx

GPU Operations (Nexus)

gpu

Manage GPU resources.

Terminal window
hookprobe-ctl gpu <subcommand>

Subcommands:

Terminal window
status     # Show GPU status
memory     # GPU memory usage
processes  # GPU processes

ML Operations (Nexus)

ml

Manage ML models.

Terminal window
hookprobe-ctl ml <subcommand>

Subcommands:

Terminal window
list       # List models
train      # Start training
export     # Export model
metrics    # Training metrics

Examples:

Terminal window
hookprobe-ctl ml list
hookprobe-ctl ml train --use-gpu
hookprobe-ctl ml export --model threat-v4 --format onnx

System

version

Show version information.

Terminal window
hookprobe-ctl version

uninstall

Remove HookProbe completely.

Terminal window
sudo hookprobe-ctl uninstall

help

Show help.

Terminal window
hookprobe-ctl help
hookprobe-ctl <command> --help

Exit Codes

CodeMeaning
0Success
1General error
2Invalid arguments
3Service not running
4Configuration error
5Permission denied

Next Steps