Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

CLI Reference

proxelar [OPTIONS]

Options

FlagShortDefaultDescription
--interface-ituiInterface mode: terminal, tui, or gui
--mode-mforwardProxy mode: forward or reverse
--port-p8080Port to listen on
--addr-b127.0.0.1Bind address
--target-t—Upstream target URI (required for reverse mode)
--script-s—Path to a Lua script for request/response hooks
--gui-port8081Web GUI port (only used with -i gui)
--ca-dir~/.proxelarDirectory for CA certificate and key files
--body-capture-limitfreeMaximum body bytes buffered for capture/editing; use free, unlimited, or none for unlimited

Environment variables

VariableDescription
RUST_LOGControls log verbosity. Examples: debug, proxyapi=trace, warn

Examples

# Default: forward proxy with TUI
proxelar

# Terminal output on custom port
proxelar -i terminal -p 9090

# Web GUI accessible from the network
proxelar -i gui -b 0.0.0.0

# Reverse proxy with script
proxelar -m reverse --target http://localhost:3000 --script auth.lua

# Forward proxy with logging script
proxelar --script log_traffic.lua

# Capture only the first 1 MiB of large bodies while streaming traffic through
proxelar --body-capture-limit 1048576