ProxyWhirl DocsAPI
CLI Reference
Typer command inventory parsed from proxywhirl.cli.
CLI Reference
Generated reference. This page is derived from Typer command declarations and docstrings in proxywhirl/cli.py during pnpm --dir web run docs:generate. Edit web/scripts/generate-docs.mjs, not this MDX file.
16
Commands
Typer command declarations
3
Groups
Top-level plus nested apps
fetch
Primary flow
Hydrate and validate proxy data
export
Data flow
Write dashboard-ready proxy lists
Command Groups
| Group | Commands |
|---|---|
| Top-level | 7 |
| Pool | 5 |
| Config | 4 |
Command Inventory
| Command | Summary | Function |
|---|---|---|
proxywhirl request | Make an HTTP request through a rotating proxy. | request |
proxywhirl pool list | List proxies in the active pool. | _pool_list |
proxywhirl pool add | Add a proxy URL to the pool. | _pool_add |
proxywhirl pool remove | Remove a proxy URL from the pool. | _pool_remove |
proxywhirl pool test | Test one proxy against a target URL. | _pool_test |
proxywhirl pool stats | Show active pool statistics. | _pool_stats |
proxywhirl config init | Create a local configuration file. | _config_init |
proxywhirl config show | Print the current configuration. | _config_show |
proxywhirl config get | Read one configuration value. | _config_get |
proxywhirl config set | Write one configuration value. | _config_set |
proxywhirl export | Export proxy data and statistics for web dashboard. | export |
proxywhirl fetch | Fetch proxies from configured sources. | fetch |
proxywhirl sources | List and validate configured proxy sources. | sources |
proxywhirl health | Check health of all proxies in the pool. | health |
proxywhirl validate-proxy | Validate proxy health with optional target URL test. | validate_proxy |
proxywhirl import-proxies | Import proxies from file (JSON, CSV, or plain text). | import_proxies |