Documentation

Portly v1.1 adds smart scanner coverage, safety controls, diagnostics, watch mode, session management, and CI-friendly output.

CLI Commands

Command	Description	Free?
`npx @solez-ai/portly`	Scan listening ports, detect frameworks, choose app, tunnel it.	Yes
`portly watch`	Track running apps and keep tunnel session in watch mode.	Yes
`portly doctor`	Environment diagnostics and reachability checks.	Yes
`portly list`	List active/recent sessions from local metadata cache.	Yes
`portly stop`	Stop current active tunnel session.	Yes
`portly dev` / `portly demo`	Preset alias commands for common workflows.	Yes

--json
--quiet
--verbose
--confirm
--copy
--allowlist 3000,5173
--denylist 9229
--no-reconnect

--json is recommended for scripts/CI. --confirm adds user confirmation when auth/admin routes are detected.

Error/Signal	Cause	Fix
`NO_SERVER_DETECTED`	No reachable local HTTP app found.	Start your dev server first, then run `portly doctor`.
`PORT_BLOCKED_POLICY`	Port rejected by allowlist/denylist.	Adjust flags or config in `.portlyrc`.
`TUNNEL_CREATE_FAILED`	Provider/network failure.	Portly auto-retries. Check internet and rerun.
`PUBLIC_URL_UNREACHABLE`	Tunnel URL not reachable from your network.	Verify firewall/proxy and test provider URL directly.
`NOT_SECURE`	Using wrong Pages URL or wildcard host.	Use `https://portly-live.pages.dev` exactly.

npm run dev
npx @solez-ai/portly

npm run dev
portly 3000

node server.js
portly --copy

npm run dev
portly watch

Portly merges config from global and project files:

~/.portlyrc.json
./.portlyrc
./.portlyrc.json

Supported keys: defaultPort, host, timeoutMs, allowlistPorts, denylistPorts, reconnectAttempts, reconnectDelayMs.

Docs URL: https://portly-live.pages.dev. Pages is free for static docs. Tunnel wildcard custom domains require your own routing infrastructure.