用途:根据项目名称生成可记忆且不易冲突的端口号,用于本地多服务启动、前后端端口配置和微服务端口分配。
主要能力:键盘映射算法生成端口;端口合法性校验(范围 1024-65535,屏蔽 0-1023);短名称直接使用、长名称提取首字母(英文取首字母,中文取拼音首字母,如“我爱我家”转为 wawj);支持多端口策略,如角色前缀法(fe-、api-、db-)或基础端口顺序分配;可通过配置文件设置 minPort、maxPort、blockedPorts。
使用方式:无需额外依赖,确保已安装 Node.js 和 npm,用 npx 调用。示例:npx -y @lionad/port-key "myproject";指定参数:npx -y @lionad/port-key "myproject" --digits 5 --lang en。多组件可分别生成,如 npx -y @lionad/port-key "fe-myapp"。冲突处理:工具不检测端口占用,需自行检查,将冲突端口加入 ~/.port-key/config.json 的 blockedPorts 后重试,或临时设置 PORTKEY_HOME 指向独立目录。
适用场景:本地多项目开发、全栈项目前后端与数据库端口规划、微服务架构端口分配。
限制:生成端口仅为建议,使用前需验证可用性;端口范围受限;团队内应保持分配策略一致并记录端口,避免重复。详细参数与最佳实践见 references/port-key.md 和 references/port-best-practices.md。