Documentation

Everything you need to get started with Routesy.

Settings

Routesy provides a settings page where you can configure various aspects of the application. You can open it at any time using the Cmd+, shortcut. The settings page is organized into the following tabs: General, Docker, Live Request, MCP Server, Excluded Routes, Exclusion Patterns, Shortcuts, and About.

General

The General tab contains global preferences that apply across all projects:

Authentication

Configure how Routesy authenticates requests to your Laravel application. Available methods:

  • None — No authentication headers added
  • Bearer Token — Sends an Authorization: Bearer <token> header
  • Basic Auth — Sends HTTP Basic authentication with username and password
  • Sanctum — Cookie-based authentication with configurable CSRF, login, logout endpoints and login fields

Request Timeout

You can configure the request timeout from 1 to 300 seconds. The default value is 10 seconds. If a request exceeds the configured timeout, it will be automatically cancelled.

Block Request with Empty Required Fields

When enabled, Routesy will prevent sending a request if any required field is left empty. This helps avoid unnecessary requests with missing data. You can learn more about how Routesy detects required fields in the Route Auto-Discovery page.

Choose whether the route sidebar appears on the left or right side of the main window. A mini layout preview shows how the interface will look with the selected position.