agentleFS
syofyanzuhadsyofyanzuhad/uptime-kita/.agents/skills/wayfinder-development/SKILL.md

wayfinder-development

Skill184 starsChanged 2 months agoApache-2.0View on GitHub

Use this skill for Laravel Wayfinder which auto-generates typed functions for Laravel controllers and routes. ALWAYS use this skill when frontend code needs to call backend routes or controller actions. Trigger when: connecting any React/Vue/Svelte/Inertia frontend to Laravel controllers, routes, building end-to-end features with both frontend and backend, wiring up forms or links to backend endpoints, fixing route-related TypeScript errors, importing from @/actions or @/routes, or running wayfinder:generate. Use Wayfinder route functions instead of hardcoded URLs. Covers: wayfinder() vite plugin, .url()/.get()/.post()/.form(), query params, route model binding, tree-shaking. Do not use for backend-only task

We split this skill into the rules it gives an agent

7 rules. 4 are common, 0 are distinctive, and 3 are very specific to this project.

  • 4

    Common

    Most of the 4 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use search-docs for detailed Wayfinder patterns and documentation.

    line 13
  2. Common:

    Run after route changes if Vite plugin isn't installed:

    line 19
  3. Very specific:

    Use Wayfinder with useForm:

    line 64
  4. Very specific:

    Run php artisan wayfinder:generate to regenerate routes if Vite plugin isn't installed

    line 76
  5. Common:

    Check TypeScript imports resolve correctly

    line 77
  6. Common:

    Verify route URLs match expected paths

    line 78
  7. Common:

    Not using type-safe parameter objects for route model binding

    line 84

“Common” is measured: kept by at least 6 in 10 of the 4 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Wayfinder Development

Documentation

Use search-docs for detailed Wayfinder patterns and documentation.

Quick Reference

Generate Routes

Run after route changes if Vite plugin isn't installed:

php artisan wayfinder:generate --no-interaction

For form helpers, use --with-form flag:

php artisan wayfinder:generate --with-form --no-interaction

Import Patterns

<!-- Controller Action Imports -->
// Named imports for tree-shaking (preferred)...
import { show, store, update } from '@/actions/App/Http/Controllers/PostController'

// Named route imports...
import { show as postShow } from '@/routes/post'

Common Methods

<!-- Wayfinder Methods -->
// Get route object...
show(1) // { url: "/posts/1", method: "get" }

// Get URL string...
show.url(1) // "/posts/1"

// Specific HTTP methods...
show.get(1)
store.post()
update.patch(1)
destroy.delete(1)

// Form attributes for HTML forms...
store.form() // { action: "/posts", method: "post" }

// Query parameters...
show(1, { query: { page: 1 } }) // "/posts/1?page=1"

Wayfinder + Inertia

Use Wayfinder with useForm:

<!-- Wayfinder useForm -->
import { store } from "@/actions/App/Http/Controllers/ExampleController";

const form = useForm({ name: "My Big Post" });
form.submit(store());

Verification

  1. Run php artisan wayfinder:generate to regenerate routes if Vite plugin isn't installed
  2. Check TypeScript imports resolve correctly
  3. Verify route URLs match expected paths

Common Pitfalls

  • Using default imports instead of named imports (breaks tree-shaking)
  • Forgetting to regenerate after route changes
  • Not using type-safe parameter objects for route model binding

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.