@midlajc/proxc
v1.0.2
Published
PROXC client CLI for provisioning HTTPS tunnels over FRP
Maintainers
Readme
@midlajc/proxc
CLI for exposing a local HTTP service through a PROXC server with automatic HTTPS provisioning.
Codebase: https://github.com/midlajc/proxc
Requirements
- Node.js 18+
- npm
- Linux or macOS
taravailable on the system- Access to a configured PROXC server
Install
npm install -g @midlajc/proxcInitialize the Client
Run the interactive setup:
proxc configYou can also configure it non-interactively:
proxc config \
--server-address yourdomain.com \
--server-port 7000 \
--auth-token your-token \
--register-endpoint https://yourdomain.com/_proxc/registerThis stores client configuration in ~/.proxc/config.json and downloads the matching frpc binary into ~/.proxc/frpc.
Usage
Start a tunnel:
proxc <local_port> <subdomain>Example:
proxc 3000 appIf the server is configured for yourdomain.com, the tunnel will be available at:
https://app.yourdomain.comBefore starting the tunnel, the CLI calls the server registration endpoint to ensure HTTPS is provisioned for the requested subdomain.
Commands
proxc config
Initializes or updates the local client config.
Supported flags:
--server-address <domain>--server-port <port>--auth-token <token>--register-endpoint <url>
proxc config show
Prints the active client configuration as JSON.
proxc <local_port> <subdomain>
Starts a tunnel from 127.0.0.1:<local_port> to <subdomain>.<server-address>.
Subdomain rules:
- lowercase letters, numbers, and hyphens only
- no dots
- no leading or trailing hyphen
Help
proxc --helpproxc init is still accepted as a backward-compatible alias for proxc config.
Troubleshooting
If proxc config fails while downloading FRP:
- confirm outbound access to GitHub Releases
- confirm
taris installed - rerun
proxc config
If tunnel registration fails:
- confirm the
register-endpointis reachable - confirm the auth token matches the server configuration
- confirm the requested subdomain is valid
If the CLI says config is missing:
proxc configUninstall
npm uninstall -g @midlajc/proxc
rm -rf ~/.proxc ~/.cache/proxcServer Setup
Server configuration and install assets are available in the GitHub repo:
- Repo overview: https://github.com/midlajc/proxc#readme
- Server installer: https://github.com/midlajc/proxc/blob/master/server/install.sh
- Server files: https://github.com/midlajc/proxc/tree/master/server
