Documentation

Everything you need to get started with Routesy.

Hidden Sync

Routesy is great, but it naturally has one problem: you need to manually refresh your routes every time you make a change to your project, and that is honestly not ideal. To solve this problem, the Hidden Sync feature was created. Hidden Sync is actually an optional parameter used to invoke Routesy in headless mode so that the route refresh happens "automatically". This way, you can use, for example, a Git hook to allow your project's routes to be updated in Routesy whenever you make a commit:

/Applications/Routesy.app/Contents/MacOS/Routesy --sync --path /path/to/your/laravel/project

You can also use the short flags:

/Applications/Routesy.app/Contents/MacOS/Routesy -s -p /path/to/your/laravel/project

If Routesy is already running, the sync request will be forwarded to the existing instance automatically. We recommend that you run the instruction above as part of your git pre-commit hook.

Routesy will prevent concurrent syncs of the same project. If a sync is already in progress, subsequent requests will be ignored. When the sync completes, a confirmation message is logged to the console.

Note: This feature requires the Senior license tier.