Routa documentation

Routa needs Go 1.21+ — or download a prebuilt binary from GitHub Releases.

go install github.com/7uyash/routa/cmd/routa@latest

git clone https://github.com/7uyash/routa.git
cd routa
go build -o routa ./cmd/routa

Start your app on any local port, then point Routa at it and open http://localhost:4040.

routa dev 3000

Local inspector (default). routa dev 3000 runs a high-performance local proxy in front of port 3000 and serves the dashboard on 4040. No external setup at all.

Public tunnel gateway. Run a relay edge server, then connect the agent to it to receive a public URL.

routa relay --port 8080 --domain relay.example.com:8080
routa dev 3000 --relay ws://localhost:8080 --name my-app

Routa ships as native ARM64 and AMD64 binaries for macOS, Linux and Windows. Apple Silicon, Intel Macs, Raspberry Pi, ARM servers and standard x64 machines all get a platform-specific executable.

git clone https://github.com/7uyash/routa.git
cd routa

# macOS Apple Silicon (use darwin-amd64 for Intel)
chmod +x bin/routa-darwin-arm64
sudo mv bin/routa-darwin-arm64 /usr/local/bin/routa

# Linux AMD64 (use linux-arm64 for ARM)
chmod +x bin/routa-linux-amd64
sudo mv bin/routa-linux-amd64 /usr/local/bin/routa

routa dev 3000

git clone https://github.com/7uyash/routa.git
cd routa
.\bin\routa-windows-amd64.exe dev 3000
# Or install globally:
Copy-Item .\bin\routa-windows-amd64.exe C:\Windows\System32\routa.exe

go build -o routa ./cmd/routa
make build-all
# Windows: .\build.ps1

Routa scans local ports and identifies running HTTP services, then proposes routing rules for your confirmation. As traffic flows, it normalizes dynamic paths such as/users/123 into/users/{id}and builds an API map with volume, latency and error-rate context.

Any captured request can become a mock in one click. Edit the response status, JSON body or artificial delay, then save and activate it locally without changing the original service.

The Connect Anything gateway creates public webhook endpoints for Stripe, GitHub, Shopify, Slack, Discord or custom providers, with signature verification options, ON/OFF controls, test deliveries and complete event history.

Flags: routa dev

Flags: routa relay

• Live stream — requests arrive over WebSockets with no page refresh.
• Filters — search by keyword, or filter by method, status class (2xx / 4xx / 5xx) and type (normal vs replay).
• Split-view detail — raw request and response headers, pretty-printed JSON or form bodies, a timing breakdown, and a diff tab for shadow responses.

Re-execute any captured request without curl or Postman. Replay re-sends the exact headers, query and body. Edit & Replay opens a modal where you can change the method or path, add and remove headers, and edit the JSON payload before sending. Replayed entries carry a Replay badge and link back to their parent request ID.

1. Open the Webhook Lab tab in the dashboard.
2. Create an endpoint — you get a unique URL such as https://a7x3.routa.suyashx.dev/webhook/wh_abc123.
3. Point GitHub, Stripe, Shopify, Discord, Slack, Twilio, SendGrid or PayPal at it.
4. Routa detects the provider, checks the signature header, logs delivery timestamps, and lets you replay or intentionally duplicate an event to test idempotency.

Split inbound traffic across several local services from one public URL.

routes:
  - path: "/api/v1/auth/*"
    target: "http://localhost:8081"
  - path: "/api/v1/users/*"
    target: "http://localhost:8082"
  - path: "/*"
    target: "http://localhost:3000"

Routes can also be managed live from the Routes tab in the dashboard.

• Set or remove headers, e.g. inject X-Debug or strip an internal token.
• Rewrite paths and strip prefixes: /api/v1/users → /users.
• Inject query parameters such as ?debug=1&trace=true.
• Mutate nested JSON by dot-path: set user.role=admin, remove user.ssn.
• Return mock responses without ever touching the backend.

mutations:
  - name: "Inject Debug Header"
    match:
      path: "/api/*"
    request:
      set_headers:
        X-Debug-Mode: "true"
      remove_headers:
        - "X-Internal-Token"
      mock_response:
        status: 200
        body: '{"status": "ok", "mocked": true}'

Fixed or jittered latency, forced error rates and status codes, abrupt connection drops and upstream timeouts — configured live in the Simulator panel or in YAML.

simulations:
  - name: "Staging Latency & Error Test"
    match:
      path: "/api/v1/payments/*"
    latency_ms: 250
    jitter_ms: 50
    error_rate: 0.1
    error_status: 503

The primary service answers the real client while a duplicate request goes to the shadow target. The deep differ then compares status codes, headers and nested JSON fields, rendering side-by-side highlights in the Diff tab.

shadows:
  - name: "v2 Migration Test"
    match:
      path: "/api/v2/*"
    shadow_url: "http://localhost:9090"
    compare_response: true

Save the current history as a fixture under ~/.routa/sessions/<name>.json, share it with your team, and replay the requests sequentially with the original inter-request timing preserved.

version: "1"
agent:
  port: 4040
  target: "http://localhost:3000"

routes:
  - path: "/api/v1/users/*"
    target: "http://localhost:8081"

mutations: []
simulations: []
shadows: []

Run any configuration with the --config flag.

routa dev --config routa.yaml