# routeup

> Stable HTTPS routes for local services. Public when you need it.

routeup gives local services stable HTTPS names like
https://myapp.localhost and can expose those same routes
publicly at a named URL such as https://myapp.mukul.routeup.dev when needed.

## Docs

- [routeup docs](https://routeup.dev/docs): Stable HTTPS routes for local services. Public when you need it.
- [Conflict resolution](https://routeup.dev/docs/architecture/conflict-resolution): What happens when two processes claim the same route, locally or publicly.
- [CLI ↔ agent IPC](https://routeup.dev/docs/architecture/ipc): How the routeup CLI talks to the background agent over a per-user Unix socket.
- [Local-only request flow](https://routeup.dev/docs/architecture/local-only-flow): How a request to https://example-app.localhost reaches your local service.
- [Public exposure request flow](https://routeup.dev/docs/architecture/public-exposure-flow): How a public request reaches a local service through the routeup tunnel.
- [routeup completion](https://routeup.dev/docs/cli-reference/completion): Generate shell completion scripts for bash, zsh, fish, and PowerShell.
- [routeup doctor](https://routeup.dev/docs/cli-reference/doctor): Diagnose local setup, CA trust, certificates, port 443, and agent health.
- [routeup expose](https://routeup.dev/docs/cli-reference/expose): Make a route public using the explicit exposure command.
- [routeup inspect](https://routeup.dev/docs/cli-reference/inspect): Show captured request and response data for a specific request.
- [routeup logs](https://routeup.dev/docs/cli-reference/logs): Tail local and public request logs from the agent.
- [Operator commands](https://routeup.dev/docs/cli-reference/operator): Server-side commands for running a routeup deployment and minting tokens.
- [routeup routes](https://routeup.dev/docs/cli-reference/routes): List the active routes registered with the local agent.
- [routeup](https://routeup.dev/docs/cli-reference/routeup): The bare routeup command runs your dev script and gives it a stable route.
- [routeup serve](https://routeup.dev/docs/cli-reference/serve): Register a local route and reverse-proxy it to a local port.
- [routeup setup](https://routeup.dev/docs/cli-reference/setup): One-time install of the local CA, certificates, agent, and optional server credentials.
- [routeup update / uninstall](https://routeup.dev/docs/cli-reference/update-uninstall): Upgrade routeup in place, or remove it and everything setup installed.
- [Local agent](https://routeup.dev/docs/concepts/local-agent): The background process that owns local routing, TLS termination, and the route registry.
- [Public namespace](https://routeup.dev/docs/concepts/public-namespace): A subdomain where anyone can claim ephemeral public URLs without a token.
- [Public server](https://routeup.dev/docs/concepts/public-server): The component that receives external traffic and forwards it through a tunnel to your local agent.
- [Routes](https://routeup.dev/docs/concepts/routes): The core primitive in routeup is the route, a dotted name that maps to a stable HTTPS hostname.
- [Tokens and allow patterns](https://routeup.dev/docs/concepts/tokens): How routeup authorizes reusable, scoped claims outside the public namespace.
- [Framework setup](https://routeup.dev/docs/configuration/frameworks): How to use routeup with Vite, Astro, Next.js, and other dev servers.
- [Name resolution](https://routeup.dev/docs/configuration/name-resolution): How routeup turns a CLI argument, env var, or config value into a route name.
- [package.json embed](https://routeup.dev/docs/configuration/package-json-embed): Configure routeup inside an existing package.json under the routeup key.
- [routeup.json](https://routeup.dev/docs/configuration/routeup-json): The standalone config file for any project.
- [FAQ](https://routeup.dev/docs/faq): Common questions about routeup.
- [Exposing publicly](https://routeup.dev/docs/getting-started/exposing-publicly): Make a local route reachable from the internet for webhooks, OAuth, and mobile testing.
- [Your first route](https://routeup.dev/docs/getting-started/first-route): Run routeup setup once, then serve a local service at a stable HTTPS URL.
- [Install](https://routeup.dev/docs/getting-started/install): Install the routeup CLI on macOS or Linux.
- [Using a token](https://routeup.dev/docs/getting-started/using-a-token): Get reusable, named public URLs by configuring a server token.
- [Agent and browser testing](https://routeup.dev/docs/recipes/agent-browser-testing): Point Playwright, Puppeteer, or an LLM browser agent at a stable HTTPS origin.
- [Frontend + API behind one route](https://routeup.dev/docs/recipes/frontend-plus-api): Serve a dev frontend at / and an API at /api/* behind a single route.
- [Mobile testing](https://routeup.dev/docs/recipes/mobile-testing): Test your dev build on a real iPhone or Android device over real HTTPS.
- [OAuth callbacks](https://routeup.dev/docs/recipes/oauth-callbacks): Use a stable URL as the redirect URI for OAuth integrations.
- [Webhook development](https://routeup.dev/docs/recipes/webhook-development): Receive real webhook deliveries from GitHub, Stripe, Slack, and others on your dev machine.
- [DNS setup](https://routeup.dev/docs/self-hosting/dns-setup): Configure DNS for a self-hosted routeup server.
- [Minting tokens](https://routeup.dev/docs/self-hosting/minting-tokens): Create, list, and revoke tokens for clients of your self-hosted server.
- [Enabling the public namespace](https://routeup.dev/docs/self-hosting/public-namespace): Turn on token-less, ephemeral claims under one designated subdomain.
- [Running the server](https://routeup.dev/docs/self-hosting/running-the-server): Run your own routeup server on a domain you control.
- [TLS](https://routeup.dev/docs/self-hosting/tls): Wildcard certificates for the public server via ACME DNS-01, or your own cert.

## Optional

- [Full docs concatenated](https://routeup.dev/llms-full.txt): every docs page joined into one Markdown document.