Skip to content
localhost-aliases

Projects

Group aliases by folder, and optionally pin them in the repo with .localhost-aliases.json.

Linking a folder

An alias can carry an absolute project folder path. That is all a project is: aliases that share a folder are grouped under it in the patchbay, and the Projects view lists the folders that have at least one alias. An alias with no folder is perfectly normal — it simply belongs to nothing.

Linking a folder is metadata only. It writes no file into your repository and needs no admin prompt.

The optional .localhost-aliases.json

A repository can declare the aliases it wants, so a teammate can recreate them in one action instead of reading a README. The file is entirely optional — aliases created in the dashboard work perfectly well without it — and it never creates anything on its own.

.localhost-aliases.json

{
  "aliases": [
    { "name": "myapp", "port": 3000, "description": "web" },
    { "name": "api.myapp", "port": 3001, "description": "API" }
  ]
}
  • name — the host label without the TLD. Lowercase letters, digits, hyphens and dots.
  • port — the port your dev server listens on, on 127.0.0.1.
  • description — optional, shown in the dashboard.

Importing a declared alias that does not exist yet creates one, which changes the hostname set — so that import is one of the actions that raises the admin prompt.

From a coding agent

The MCP server exposes the same operations: list_projects lists the linked folders, and link_project attaches a folder to an alias, imports the aliases the folder declares, and can write the file back out from the aliases currently linked to it. See MCP.