# routeup

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

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

Routeup is a command-line developer tool, not a general-purpose web API.
Agents should invoke the local `routeup` CLI, prefer its `--json` or `--jsonl` output
where available, and treat the installed command's `--help` output as authoritative.
Keep routes local unless the user explicitly requests public exposure.

## When to use Routeup

- [Stable local HTTPS](https://routeup.dev/docs/getting-started/first-route.md): Use Routeup when a local service needs a memorable trusted `*.localhost` URL instead of a changing port.
- [Frontend and API routing](https://routeup.dev/docs/recipes/frontend-plus-api.md): Use one HTTPS origin for multiple local services without development-only CORS workarounds.
- [Webhook development](https://routeup.dev/docs/recipes/webhook-development.md): Give an external provider temporary access to specific local webhook paths.
- [OAuth callbacks](https://routeup.dev/docs/recipes/oauth-callbacks.md): Keep a stable HTTPS redirect URI during development.
- [Agent and browser testing](https://routeup.dev/docs/recipes/agent-browser-testing.md): Let an off-machine browser or coding agent reach a local app after the user approves exposure.

## Agent instructions

- [Routeup Agent Skill](https://routeup.dev/docs/getting-started/agent-skill.md): Install and use the official skill for safe setup, configuration, exposure, and traffic inspection.
- [Install Routeup](https://routeup.dev/docs/getting-started/install.md): Install the CLI with Homebrew or the verified release installer.
- [CLI overview](https://routeup.dev/docs/cli-reference/routeup.md): Start here for CLI usage; inspect the linked subcommand reference before running commands.
- [Diagnose setup](https://routeup.dev/docs/cli-reference/doctor.md): Verify the machine with `routeup doctor --json`.

## Developer resources

- [Routeup source](https://github.com/mukul-mehta/routeup): MIT-licensed source code and issue tracker.
- [Routeup releases](https://github.com/mukul-mehta/routeup/releases/latest): Release notes and downloadable macOS and Linux binaries.
- [Routeup configuration](https://routeup.dev/docs/configuration/routeup-json.md): Typed `routeup.json` configuration reference and JSON Schema link.
- [Self-host Routeup](https://routeup.dev/docs/self-hosting/running-the-server.md): Run the public tunnel server on infrastructure and a domain you control.
- [Routeup privacy notice](https://routeup.dev/privacy.md): Data handling for the Routeup website, analytics, and hosted-token request form.
- [Sitemap](https://routeup.dev/sitemap-index.xml): Index of human-readable Routeup pages.

## Docs

- [routeup docs](https://routeup.dev/docs/index.md): Stable HTTPS routes for local services. Public when you need it.
- [Conflict resolution](https://routeup.dev/docs/architecture/conflict-resolution.md): What happens when two processes claim the same route, locally or publicly.
- [CLI ↔ agent IPC](https://routeup.dev/docs/architecture/ipc.md): 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.md): How a request to https://example-app.localhost reaches your local service.
- [Public exposure request flow](https://routeup.dev/docs/architecture/public-exposure-flow.md): How a public request reaches a local service through the routeup tunnel.
- [routeup completion](https://routeup.dev/docs/cli-reference/completion.md): Generate shell completion scripts for bash, zsh, fish, and PowerShell.
- [routeup config](https://routeup.dev/docs/cli-reference/config.md): Show the discovered project config and its resolved non-secret values.
- [routeup dashboard](https://routeup.dev/docs/cli-reference/dashboard.md): Open a read-only terminal dashboard for routes, exposures, and live requests.
- [routeup doctor](https://routeup.dev/docs/cli-reference/doctor.md): Diagnose local setup, CA trust, certificates, port 443, and agent health.
- [routeup exec](https://routeup.dev/docs/cli-reference/exec.md): Run one command with Routeup project URLs and local CA trust without owning a route.
- [routeup expose](https://routeup.dev/docs/cli-reference/expose.md): Make a route public using the explicit exposure command.
- [routeup inspect](https://routeup.dev/docs/cli-reference/inspect.md): Show captured request and response data for a specific request.
- [routeup logs](https://routeup.dev/docs/cli-reference/logs.md): Tail local and public request logs from the agent.
- [Operator commands](https://routeup.dev/docs/cli-reference/operator.md): Server-side commands for running a routeup deployment and minting tokens.
- [routeup routes](https://routeup.dev/docs/cli-reference/routes.md): List the active routes registered with the local agent.
- [routeup](https://routeup.dev/docs/cli-reference/routeup.md): The bare routeup command runs your dev script and gives it a stable route.
- [routeup serve](https://routeup.dev/docs/cli-reference/serve.md): Register a local route and reverse-proxy it to a local port.
- [routeup setup](https://routeup.dev/docs/cli-reference/setup.md): One-time install of the local CA, certificates, agent, and optional server credentials.
- [routeup stop](https://routeup.dev/docs/cli-reference/stop.md): Stop a foreground or detached routeup serve owner.
- [routeup update / uninstall / version](https://routeup.dev/docs/cli-reference/update-uninstall.md): Upgrade routeup in place, remove it and everything setup installed, or print the installed version.
- [Local agent](https://routeup.dev/docs/concepts/local-agent.md): The background process that owns local routing, TLS termination, and the route registry.
- [Public namespace](https://routeup.dev/docs/concepts/public-namespace.md): A subdomain where anyone can claim ephemeral public URLs without a token.
- [Public server](https://routeup.dev/docs/concepts/public-server.md): The component that receives external traffic and forwards it through a tunnel to your local agent.
- [Routes](https://routeup.dev/docs/concepts/routes.md): 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.md): How routeup authorizes reusable, scoped claims outside the public namespace.
- [Custom CA certificates](https://routeup.dev/docs/configuration/custom-ca-certificates.md): Trust routeup local HTTPS in apps that use their own certificate store.
- [Framework setup](https://routeup.dev/docs/configuration/frameworks.md): How to use routeup with Vite, Astro, Next.js, and other dev servers.
- [Name resolution](https://routeup.dev/docs/configuration/name-resolution.md): 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.md): Configure routeup inside an existing package.json under the routeup key.
- [routeup.json](https://routeup.dev/docs/configuration/routeup-json.md): The standalone config file for any project.
- [FAQ](https://routeup.dev/docs/faq.md): Common questions about routeup.
- [Agent Skill](https://routeup.dev/docs/getting-started/agent-skill.md): Teach coding agents how to install, set up, configure, and use routeup safely.
- [Exposing publicly](https://routeup.dev/docs/getting-started/exposing-publicly.md): 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.md): Run routeup setup once, then serve a local service at a stable HTTPS URL.
- [Install](https://routeup.dev/docs/getting-started/install.md): Install the routeup CLI on macOS or Linux.
- [Observe and debug requests](https://routeup.dev/docs/getting-started/observe-and-debug.md): Follow route traffic, use the live dashboard, and inspect captured exchanges.
- [Using a token](https://routeup.dev/docs/getting-started/using-a-token.md): Get reusable, named public URLs by configuring a server token.
- [Agent and browser testing](https://routeup.dev/docs/recipes/agent-browser-testing.md): 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.md): Serve a dev frontend at / and an API at /api/* behind a single route.
- [Mobile testing](https://routeup.dev/docs/recipes/mobile-testing.md): Test your dev build on a real iPhone or Android device over real HTTPS.
- [OAuth callbacks](https://routeup.dev/docs/recipes/oauth-callbacks.md): Use a stable URL as the redirect URI for OAuth integrations.
- [Webhook development](https://routeup.dev/docs/recipes/webhook-development.md): Receive real webhook deliveries from GitHub, Stripe, Slack, and others on your dev machine.
- [DNS setup](https://routeup.dev/docs/self-hosting/dns-setup.md): Configure DNS for a self-hosted routeup server.
- [Minting tokens](https://routeup.dev/docs/self-hosting/minting-tokens.md): Create, list, and revoke tokens for clients of your self-hosted server.
- [Enabling the public namespace](https://routeup.dev/docs/self-hosting/public-namespace.md): Turn on token-less, ephemeral claims under one designated subdomain.
- [Running the server](https://routeup.dev/docs/self-hosting/running-the-server.md): Run your own routeup server on a domain you control.
- [TLS](https://routeup.dev/docs/self-hosting/tls.md): 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.