Skip to main content

AI-powered linking and automation tool

Project description

Dev Linker

Dev Linker runs frontend and backend dev servers, proxies both through a single local port (8000), and creates a single public URL via Cloudflare or ngrok.

Features

  • Launches frontend automatically (when frontend exists)
  • Auto-detects backend runtime (Docker Compose, Dockerfile, Node, or Python)
  • Auto-starts Python/Node backends; Docker is manual by default for reliability
  • Detects common frontend/backend ports
  • Detects Vite frontend across dynamic fallback ports (5173-5190, plus common alternatives)
  • Supports Docker backend port auto-detection
  • Works with dynamic container host ports
  • No config needed for standard Flask/Docker flows
  • Serves both through one proxy at http://localhost:8000
  • Creates a public tunnel for sharing (Cloudflare first, ngrok fallback)
  • Terminal-first workflow
  • Supports CLI version output with --version

Project Structure

devlinker/
├── devlinker/
│   ├── __init__.py
│   ├── main.py
│   ├── runner.py
│   ├── detector.py
│   ├── proxy.py
│   └── tunnel.py
├── setup.py
├── README.md
└── requirements.txt

Install

For local development:

pip install .

After publishing to PyPI:

pip install devlinker

Run

devlinker

Typical startup output:

Dev Linker v1.2.2

[INFO] Mode: Auto (Flask + Docker detection)
[INFO] Booting local services...
[INFO] Detecting frontend/backend ports...
[OK] Frontend -> 5173
[OK] Backend  -> 5000

[OK] Proxy ready at http://localhost:8000

[OK] Tunnel provider: Cloudflare
[OK] Public URL:
    https://xxxx.trycloudflare.com
Tip: Press Ctrl+Click to open link

[INFO] Share this link with collaborators.

DevLinker Ready (in 2.4s)
Frontend: http://localhost:5173
Backend:  http://localhost:5000
Proxy:    http://localhost:8000
PUBLIC URL: https://xxxx.trycloudflare.com
Tip: Press Ctrl+Click to open link

Version check:

devlinker --version

Optional overrides:

devlinker --frontend 5173 --backend 5000

Backend override alias:

devlinker --backend-port 3001

Enable Docker auto-start explicitly:

devlinker --docker

Run local-only mode without tunnel:

devlinker --no-tunnel

Interactive backend selection (when local and Docker are both detected):

devlinker --interactive-backend

Disable interactive backend selection (keeps local-first behavior):

devlinker --no-interactive-backend

If port 8000 is already in use:

devlinker --frontend 5173 --backend 5000 --proxy-port 18000

Default behavior also tries fallback ports automatically when 8000 is busy:

[WARN] Port 8000 in use
[INFO] Using proxy port: 8001
  • 8001
  • 8002
  • 18000

Frontend detection behavior:

  • Scans Vite defaults and fallback ports (5173 through 5190)
  • Also checks common alternatives (3000, 4173, 8080)
  • Retries during startup to catch slow boot cases

Important Frontend Rule

Frontend requests must use relative API paths:

fetch("/api/endpoint")

Do not hardcode backend host URLs in frontend code.

Backend Auto-Detection

Backend port detection runs in this order:

  1. Check localhost port 5000
  2. If not found, parse all Docker host-to-container port mappings
  3. Rank containers by likely backend identity (name hints like backend/api plus project-name hints)
  4. Use the best mapped host port automatically, even when internal port is not 5000
  5. If nothing is found, print next-step guidance and exit

When both Local and Docker backends are available, Dev Linker prompts you to choose one (TTY mode) unless --no-interactive-backend is used.

If backend detection fails, Dev Linker prints a clear checklist showing what it checked and how to recover.

Detection messages include source labels, for example:

[OK] Backend detected (Local) -> port 5000

Example Docker dynamic-port message:

[WARN] Backend not found on port 5000
[INFO] Checking Docker containers...
[OK] Backend detected (Docker) -> port 32768

Dev Linker checks backend runtime in this order:

  1. Docker Compose (backend/docker-compose.yml, docker-compose.yaml, compose.yml, or compose.yaml)
  2. Docker (backend/Dockerfile)
  3. Node (backend/package.json)
  4. Python (backend/requirements.txt or backend/app.py)

Backend startup commands:

  • Docker Compose (default): manual run docker compose up --build in backend/
  • Dockerfile (default): manual run docker build -t devlinker-backend . then docker run --rm -p 5000:5000 devlinker-backend
  • Docker Compose/Dockerfile with --docker: Dev Linker runs those Docker commands for you
  • Node: npm run dev (or npm start when dev is missing)
  • Python: python app.py

For containerized Flask backends, ensure:

  • App binds to all interfaces: app.run(host="0.0.0.0", port=5000)
  • Port mapping is present: -p 5000:5000

Notes

  • runner.py expects frontend project in frontend and Flask app in backend/app.py.
  • If those paths do not exist, Dev Linker skips launch and only tries to detect already-running services.
  • Tunnel selection order is: cloudflared (TryCloudflare), then ngrok.
  • If cloudflared is unavailable and ngrok is not configured, Dev Linker prints one-time setup guidance.
  • You may need to set ngrok auth once on your machine using ngrok config add-authtoken .
  • Dev Linker prints a public URL with ngrok-skip-browser-warning=true only when ngrok is used.
  • Startup output includes selected tunnel provider (cloudflare or ngrok).
  • When Dev Linker launches a Vite frontend, it sets ONELINK=1 to disable Vite HMR WebSockets for stable tunnel behavior.

Real-Time Development Modes

Option 1: Dev Linker sharing mode (recommended)

  • Run devlinker to share one combined frontend/backend URL.
  • Open local Vite URL yourself for instant HMR updates.
  • Share Dev Linker/ngrok URL with others; they can use normal page refresh to see changes.

Option 2: Full remote HMR mode (bypass Dev Linker)

  • Start frontend and backend manually.
  • Configure Vite server.proxy for /api to backend.
  • Run ngrok http <vite-port> directly so Vite handles WebSocket HMR traffic.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

devlinker-1.2.3.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

devlinker-1.2.3-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file devlinker-1.2.3.tar.gz.

File metadata

  • Download URL: devlinker-1.2.3.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for devlinker-1.2.3.tar.gz
Algorithm Hash digest
SHA256 97ed69e444a2efae34d9720d5646b351fcab9d06dace2fd17748cb51a472f215
MD5 23b8d6a439b5d14e71d3157695f53130
BLAKE2b-256 a3749d34da4b948c4cf9b198f22ec6f1d69e8296282ad4d6c6913b5fb018ac62

See more details on using hashes here.

Provenance

The following attestation bundles were made for devlinker-1.2.3.tar.gz:

Publisher: publish.yml on mani1028/devlinker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file devlinker-1.2.3-py3-none-any.whl.

File metadata

  • Download URL: devlinker-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for devlinker-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fa675ddb4f1c0bf36f39d7df89ce7e778a7c465c2ccd27268c5140f1c4dc4e43
MD5 cfae49b348862c41fee0f20b123aff78
BLAKE2b-256 51c5002290e31547bb14b43af3dc5d0a77099a8a7811cab2cc0cf1f8adb6b481

See more details on using hashes here.

Provenance

The following attestation bundles were made for devlinker-1.2.3-py3-none-any.whl:

Publisher: publish.yml on mani1028/devlinker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page