portless 是做什么的?
安装并使用 portless 为本地开发服务器设置命名 URL(例如使用 https://myapp.localhost 替代 http://localhost:3000)。适用于将 portless 集成到项目中、配置开发服务器名称、设置本地代理、处理 .localhost 域名或排查端口/代理问题。
概述
portless 是一个轻量级的本地开发工具,允许你通过可读的域名(如 myapp.localhost)访问本地运行的开发服务器,而不是使用 localhost:3000 这样的端口号。它利用本地 DNS 解析和代理服务器,将 .localhost 域名映射到本地端口,并提供 HTTPS 支持。
安装
你可以通过 npm 或 yarn 全局安装 portless:
npm install -g @vercel/portless
# 或
yarn global add @vercel/portless
使用方式
启动代理服务器
portless start
该命令会启动一个本地代理服务器(默认端口 80 或 443),监听所有 .localhost 域名的请求。
注册开发服务器
你可以为每个开发服务器绑定一个名称:
portless add myapp --port 3000
现在访问 https://myapp.localhost 就会代理到 http://localhost:3000。
查看已注册的服务
portless list
停止代理
portless stop
配置
portless 支持通过配置文件(默认 ~/.portless)进行高级配置,例如自定义代理端口、SSL 证书等。
支持的平台
portless 适用于 macOS、Linux 和 Windows(需要管理员权限进行 DNS 和端口绑定)。它可与任何框架或语言配合使用,只要该框架可在本地端口上启动 HTTP 服务器。
故障排除
无法启动代理
- 确保以 root 或管理员权限运行
portless start。 - 检查端口 80 或 443 是否已被占用。
- 运行
portless status查看日志。
域名无法解析
- 确认
portless代理正在运行。 - 检查系统 DNS 设置,确保
.localhost被指向 127.0.0.1。 - 对于 Windows,可能需要手动设置 hosts 文件。
更多信息
请参考 官方文档 获取完整的 API 参考和示例。