Skip to content

devlanes is in beta and not ready for production use.Report an issue

devlanes docs

Start with getting started. The two references are generated from the code and are the authority on fields and flags; the guides explain how the pieces fit and show configurations that work.

  • CLI: every command and option.
  • Config: every field of devlanes.yaml and the user config.yaml.
  • Examples: commented configuration files.
  • Proxy errors: every error page the proxy serves, its causes and fixes.
  • Run and run_script: the six script runners, which file picks which, and how presets pass their flags.
  • Languages: Node, Bun, Deno, Python and Rust services, mise and direnv.
  • Framework presets: Vite, Next, Wrangler and Tauri.
  • Ports and environment: port blocks, named ports, PORT, expressions, env layers, .env, local overrides and extends.
  • Hostnames and HTTPS: the proxy, the CA, trusting it per OS and runtime, resolver strategies, LAN access.
  • Infra: Compose and plain containers, shared versus per-lane, recipes for Postgres, MySQL, Redis, RabbitMQ, MinIO and Mailpit.
  • Service patterns: APIs behind a frontend, workers, several ports, wildcards, replicas, monorepos, several projects in one repository, CI.
  • Lane lifecycle: start, stop, what a plain start brings back, lane resume, reload after a config edit, project renames, on-demand services, lifecycle tasks, and idle lanes that are throttled and frozen.
  • Terminals: tab progress bars, clipboard.
  • Updates: release checks and notices, devlanes update per install method, builds of main, background installs, release highlights, the install scripts and devlanes uninstall.
  • Remote setup: preparing a box and a client for devlanes remote connect.
  • Remote boxes over Tailscale: MagicDNS names, OpenSSH keys or Tailscale SSH, check mode, Headscale.
  • Remote boxes through Cloudflare: Cloudflare Tunnel with Access and cloudflared as ProxyCommand, the Cloudflare One Client, session expiry.
  • Several boxes with the same project: forks of one image, which lane this machine mirrors, devlanes remote use and m in the TUI.
  • Boxes reached by a command: containers, pods, WSL distributions and codespaces through docker exec, kubectl exec, wsl.exe or gh codespace ssh instead of SSH.
  • Windows: requirements, Git for Windows’ shell, stops, ports, HTTPS, hostnames and logon start on Windows 11.
  • WSL: devlanes inside a WSL distro with the browser on Windows: trusting the CA in Windows, opening URLs, systemd, worktrees on Windows drives.
  • Remote boxes: what mirroring does once connected.
  • Security: who can reach the daemon, what the CA signs, what crosses a remote connection and what pairing protects.
  • Design: lanes, ports, the daemon and startup order.
  • Observability: spans, diagnostics and plans for tracing.