Lionad-Morotar/port-key

Latest recorded source activity: July 15, 2026 at 15:47

SkillsMP catalog refreshed: November 2, 2026 at 18:02

skills collected: 1

GitHub stars: 0
GitHub forks: 0

Install with an AI assistant

Copy this prompt into the AI assistant you're using.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/Lionad-Morotar/port-key.

Repository README

Repository README source: README.md

Read the source README

Expand full README

# PortKey <img width="200" src="https://raw.githubusercontent.com/Lionad-Morotar/port-key/main/public/logo.png" /> PortKey：A Simple, Practical Port Naming Strategy  <a href="./docs/README.cn.md">中文</a> | <a href="./docs/README.es.md">Español</a> | <a href="./docs/README.fr.md">Français</a> | <a href="./docs/README.de.md">Deutsch</a> | <a href="./docs/README.ja.md">日本語</a> | <a href="./docs/README.ko.md">한국어</a> | <a href="./docs/README.ru.md">Русский</a> | <a href="./docs/README.ar.md">العربية</a> | <a href="./docs/README.pt.md">Português</a> | <a href="./docs/README.it.md">Italiano</a> ## Brief Generate ports with a letter-to-number keyboard mapping When you’re running a bunch of projects locally, picking port numbers becomes annoying. - Over the last couple of years, there have been *so many* new projects. To really try them out, you often need to boot them locally—and then ports start colliding. - If you want to keep browser tabs (or bookmarks) stable, a project’s port shouldn’t keep changing. For example, I have more than ten Nuxt apps on my machine. If they all default to `3000`, that’s obviously not going to work. So I came up with a simple, consistent port naming rule to “assign” ports per project. [Source Blog Post](https://lionad.art/articles/simple-naming-method) ### Core idea Instead of picking random numbers, map the **project name to numbers based on the keyboard**, so the port is *readable* and *memorable*. As long as the result is within the valid port range (**1024–65535**) and doesn’t hit reserved/system ports, you can just use it. More specifically: using a standard QWERTY keyboard, map each letter to a single digit based on its **row/column position**. Example: `"cfetch"` → `c(3) f(4) e(3) t(5) c(3) h(6)` → `34353`（port number） Then you can take the first 4 digits (e.g. `3453`), or keep more digits (e.g. `34353`). Either is fine. If a project needs multiple ports (frontend, backend, database, etc.), pick **one** of these two approaches: 1. Use the project prefix, then append a “role suffix” - For `"cfetch"`, take `3435` as the base - Frontend (`fe`, i.e. `43`) → `34354` - Backend (`server`) → `34352` - Database (`mongo`) → `34357` - …and so on 2. Use the project prefix, then assign sequential roles - For `"cfetch"`, take `3435` as the base - Web → `34351` - Backend → `34352` - Database → `34353` - …and so on ### Valid port range - Ports must be within **1024–65535** (System ports 0-1023 are blocked). - **System Ports (0-1023)**: Assigned by IETF. Strictly blocked. - **User Ports (1024-49151)**: Assigned by IANA. Use with caution as they might conflict with registered services. - **Dynamic/Private Ports (49152-65535)**: Not assigned. Safest for private or dynamic use. --- ## How to use Simple command: ```sh npx -y @lionad/port-key <your-project-name> ``` Or you want a stdio MCP server: ```sh npx -y @lionad/port-key-mcp ``` ```json { "mcpServers": { "port-key": { "command": "npx", "args": ["@lionad/port-key-mcp"] } } } ``` ### CLI options - `-m, --map <object>`: custom mapping (JSON or JS-like object literal) - `--lang <code>`: output language (currently only `en` and `cn`, default: `cn`) - `-d, --digits <count>`: preferred digit count for port (4 or 5, default: 4) - `--padding-zero <true|false>`: Pad to preferred digits with trailing zeros when input is short (default: true). e.g. `"air"` -> `1840`, `"1234" --digits 5` -> `12340` - `-h, --help`: show help Examples: ```bash npx @lionad/port-key cfetch # -> 3435 npx @lionad/port-key cfetch --digits 4 # -> 3435 (4-digit port) npx @lionad/port-key cfetch --digits 5 # -> 34353 (5-digit port) ``` Notes: - Default log language is `cn`. Use `--lang en` to show English messages. - Use `-h` or `--help` to show help. ### Config PortKey reads optional user config from: - `~/.port-key/config.json` A full Example: ```json { // Preferred digit count for port (4 or 5) "preferDigitCount": 5, // Pad to preferred digits with trailing zeros when input is short (default: true) "paddingZero": true, // Custom letter-to-digit mapping "blockedPorts": [3000, 3001, 3002, 6666], // Port range limits (inclusive) "minPort": 1024, "maxPort": 49151 } ``` --- ## For Developer ### Project Structure - 本仓库采用 pnpm monorepo；核心包位于 `packages/core`。 - 安装：在根目录执行 `pnpm install`。 - 运行测试：`pnpm -C packages/core test` 或 `pnpm -C packages/core test:watch`。

Loading the repository README…

Skills in this repository

Software Developers

1 occupation category · 100% classified

skill

occupation

description

updated

smart-port-allocation

Software Developers

根据项目名称通过键盘映射算法生成可记忆的端口号，解决本地开发多项目端口冲突问题；支持微服务架构端口分配、前后端组件端口规划

Source text: Chinese

2026-07-15

Showing 1 of 1 collected skill.