feat(framework): add optional AGENTS.md installer

src/Tempest/Framework/Installers/AGENTS.md

@@ -0,0 +1,9 @@
+## General
+
+- All documentation for Tempest can be found in vendor/tempest/framework/docs
+- Use `php tempest make:` commands to create framework-specific classes.
+
+## Frontend
+
+- Use TailwindCSS
+- Use Tempest view components where it makes sense

src/Tempest/Framework/Installers/FrameworkInstaller.php

@@ -44,6 +44,19 @@ public function install(): void
             },
         );
 
+        $this->publish(
+            source: __DIR__ . '/AGENTS.md',
+            destination: root_path('AGENTS.md'),
+            callback: function (string $_, string $destination): void {
+                $claude = root_path('CLAUDE.md');
+
+                if (PHP_OS_FAMILY !== 'Windows') {
+                    // @phpstan-ignore-next-line
+                    exec("ln -s {$destination} {$claude}");
+                }
+            },
+        );
+
         $this->updateComposer();
 
         $this->console->call('discovery:generate');

tests/Integration/Core/FrameworkInstallerTest.php

@@ -56,10 +56,20 @@ public function test_it_can_force_install(): void
                 path: '.env',
                 content: file_get_contents(__DIR__ . '/../../../.env.example'),
             )
+            ->assertFileExists(
+                path: 'AGENTS.md',
+                content: file_get_contents(__DIR__ . '/../../../src/Tempest/Framework/Installers/AGENTS.md'),
+            )
             ->assertCommandExecuted('composer up');
 
         if (PHP_OS_FAMILY !== 'Windows') {
             $this->assertTrue(is_executable($this->installer->path('tempest')));
+
+            $this->installer
+                ->assertFileExists(
+                    path: 'CLAUDE.md',
+                    content: file_get_contents(__DIR__ . '/../../../src/Tempest/Framework/Installers/AGENTS.md'),
+                );
         }
     }