Prompt

https://github.com/chimit/prompt
Admin
Prompt is a simple Laravel package designed for managing AI prompts within Markdown files,...
Tokens:7,818
Snippets:60
Trust Score:6.5
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Prompt via Composer

Source: https://github.com/chimit/prompt/blob/main/README.md

Use this command to add the Prompt package to your Laravel project dependencies.

```bash
composer require chimit/prompt
```

--------------------------------

### Define Prompt with Blade Syntax

Source: https://github.com/chimit/prompt/blob/main/README.md

Example of a Markdown prompt file using Blade syntax for variables, formatting, and conditional logic.

```markdown
You are an SEO expert specializing in e-commerce. Generate a compelling meta description for this product.

**Product:** {{ $product->name }}
**Price:** ${{ number_format($product->price, 2) }}

**Product Description:**
---
{!! $product->description !!}
---

@if($product->discount_percentage > 0)
**Special Offer:** {{ $product->discount_percentage }}% OFF - Limited Time!
@endif

Requirements:
- Maximum 160 characters
- Include the product name and key benefits
- Create urgency if there's a discount
- Target keywords: {{ implode(', ', $keywords) }}
```

--------------------------------

### Blade template example

Source: https://github.com/chimit/prompt/blob/main/_autodocs/api-reference/Prompt.md

An example of a Markdown file using Blade directives and variables.

```blade
You are an SEO expert. Generate a meta description for {{ $product->name }}.

@if($product->discount_percentage > 0)
**Special Offer:** {{ $product->discount_percentage }}% OFF - Limited Time!
@endif

Target keywords: {{ implode(', ', $keywords) }}
```

--------------------------------

### PromptServiceProvider source code

Source: https://github.com/chimit/prompt/blob/main/_autodocs/api-reference/PromptServiceProvider.md

The full implementation of the boot method, which registers the prompts view namespace, adds the prompts directory to the view finder, and enables Blade compilation for .md files.

```php
<?php

namespace Chimit;

use Illuminate\Support\ServiceProvider;

class PromptServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        $promptsPath = resource_path('prompts');

        $this->loadViewsFrom($promptsPath, 'prompts');
        $this->app['view']->addLocation($promptsPath);
        $this->app['view']->addExtension('md', 'blade');
    }
}
```

--------------------------------

### Basic usage of Prompt::get

Source: https://github.com/chimit/prompt/blob/main/_autodocs/api-reference/Prompt.md

Render a prompt template by providing the name and an array of data variables.

```php
use Chimit\Prompt;

$prompt = Prompt::get('seo/product-meta', [
    'product'  => $product,          // e.g. an Eloquent model
    'keywords' => ['wireless headphones', 'bluetooth', 'noise cancelling'],
]);

// $prompt contains the Blade-rendered Markdown, ready to send to an LLM API
```

--------------------------------

### Render Prompts with Prompt::get()

Source: https://github.com/chimit/prompt/blob/main/README.md

Use the Prompt::get method to render a prompt file by passing its path and an array of data.

```php
use Chimit\Prompt;

$prompt = Prompt::get('seo/product-meta', [
    'product' => $product,
    'keywords' => ['wireless headphones', 'bluetooth', 'noise cancelling']
]);
```

--------------------------------

### Verifying prompt registration

Source: https://github.com/chimit/prompt/blob/main/_autodocs/api-reference/PromptServiceProvider.md

After booting, prompt files can be rendered using either the namespaced view API or the un-namespaced view API.

```php
use Illuminate\\Support\\Facades\\View;

$rendered = view('prompts::seo.product-meta', $data)->render(); // namespaced
$rendered = view('seo.product-meta', $data)->render();          // via added location
```

--------------------------------

### boot(): void

Source: https://github.com/chimit/prompt/blob/main/_autodocs/api-reference/PromptServiceProvider.md

The boot() method is invoked by the Laravel container during application bootstrapping. It registers the prompts directory as a view location and binds .md files to the Blade engine.

```APIDOC
## boot(): void

### Description
Registers the prompts directory as a view namespace and location, and binds .md files to the Blade engine.

### Method
boot

### Signature
public function boot(): void

### Parameters
None.

### Return Value
void

### Throws
None explicitly.

### Behavior
1. Computes $promptsPath = resource_path('prompts').
2. Calls $this->loadViewsFrom($promptsPath, 'prompts').
3. Appends the prompts directory to the view finder's location stack via $this->app['view']->addLocation($promptsPath).
4. Binds .md extension to the blade engine via $this->app['view']->addExtension('md', 'blade').

### Examples
Manual registration in bootstrap/providers.php (Laravel 11+/12/13):
```php
<?php

return [
    App\Providers\AppServiceProvider::class,
    Chimit\PromptServiceProvider::class, // added manually
];
```

Manual registration in config/app.php (Laravel 9/10):
```php
'providers' => [
    // ...
    Chimit\PromptServiceProvider::class,
],
```

Verifying the registration:
```php
use Illuminate\Support\Facades\View;

$rendered = view('prompts::seo.product-meta', $data)->render(); // namespaced
$rendered = view('seo.product-meta', $data)->render();          // via added location
```
```

--------------------------------

### Dot-notation for prompt resolution

Source: https://github.com/chimit/prompt/blob/main/_autodocs/api-reference/Prompt.md

Demonstrates that dot-notation and slash-notation are interchangeable for resolving prompt file paths.

```php
$samePrompt = Prompt::get('seo.product-meta', $data); // identical result
```

--------------------------------

### Prompt Directory Structure

Source: https://github.com/chimit/prompt/blob/main/README.md

Prompt files should be stored in the resources/prompts directory with a .md extension.

```text
resources/
└── prompts/
    ├── seo/
    │   └── product-meta.md
    └── welcome.md
```

--------------------------------

### Prompt::get method signature

Source: https://github.com/chimit/prompt/blob/main/_autodocs/api-reference/Prompt.md

The full static method signature including the PHPDoc contract.

```php
/**
 * Get the content of a prompt and render it with Blade.
 *
 * @throws FileNotFoundException
 */
public static function get(string $name, array $data = []): string
```

--------------------------------

### Manual registration for Laravel 11+

Source: https://github.com/chimit/prompt/blob/main/_autodocs/api-reference/PromptServiceProvider.md

Add the provider to the bootstrap/providers.php file when auto-discovery is disabled.

```php
// bootstrap/providers.php
<?php

return [
    App\\Providers\\AppServiceProvider::class,
    Chimit\\PromptServiceProvider::class, // added manually
];
```

--------------------------------

### Error handling for missing prompts

Source: https://github.com/chimit/prompt/blob/main/_autodocs/api-reference/Prompt.md

Catch the FileNotFoundException when a requested prompt file does not exist.

```php
use Chimit\Prompt;
use Illuminate\Contracts\Filesystem\FileNotFoundException;

try {
    $prompt = Prompt::get('reports/daily-summary', ['day' => now()]);
} catch (FileNotFoundException $e) {
    // Message: "Prompt [reports/daily-summary] not found."
    Log::warning('Missing prompt template', ['error' => $e->getMessage()]);

    $prompt = Prompt::get('reports/daily-summary-fallback', ['day' => now()]);
}
```

--------------------------------

### Chimit\Prompt::get()

Source: https://github.com/chimit/prompt/blob/main/_autodocs/index.md

Static method to retrieve a prompt file's content. It accepts a prompt name with optional subdirectory path using slash or dot notation.

```APIDOC
## Chimit\Prompt::get()

### Description
Retrieves the content of a prompt file from the resources/prompts directory. The prompt name can include subdirectories using slash or dot notation.

### Method
Static method

### Signature
public static function get(string $prompt): string

### Parameters
- **$prompt** (string) - Required - The prompt file name, optionally with subdirectory path (e.g., 'seo/product-meta' or 'seo.product-meta'). The .md extension is appended automatically.

### Return Value
- **string** - The content of the prompt file.

### Exceptions
- **Illuminate\Contracts\Filesystem\FileNotFoundException** - Thrown when the prompt file does not exist.
```

--------------------------------

### Prompt::get(string $name, array $data = []): string

Source: https://github.com/chimit/prompt/blob/main/_autodocs/api-reference/Prompt.md

Renders a prompt template by name. It resolves the prompt file from the resources/prompts directory, checks its existence, reads its content, and renders it as a Blade template with the provided data array.

```APIDOC
## Prompt::get(string $name, array $data = []): string

### Description
Renders a prompt template by name. It maps the prompt name to a Markdown file in `<app>/resources/prompts/`, verifies the file exists, reads it, and renders its contents as a Blade template with the user-supplied data array.

### Method
Static method

### Signature
`public static function get(string $name, array $data = []): string`

### Parameters
- **$name** (string) - Required - The prompt name, used to locate the Markdown file in the resources/prompts directory.
- **$data** (array) - Optional - An associative array of data to pass to the Blade template during rendering.

### Return Value
- **string** - The rendered prompt content as a string.

### Exceptions
- **Illuminate\Contracts\Filesystem\FileNotFoundException** - Thrown when the prompt file does not exist.

### Example
```php
use Chimit\Prompt;

$rendered = Prompt::get('welcome', ['user' => 'John']);
```
```

--------------------------------

### Prompt::get(string $name, array $data = []): string

Source: https://github.com/chimit/prompt/blob/main/_autodocs/api-reference/Prompt.md

Retrieves the content of a prompt file and renders it with Blade. The method normalizes the prompt name, resolves the file path, checks existence, and renders the content with the given data.

```APIDOC
## Prompt::get(string $name, array $data = []): string

### Description
Retrieves the content of a prompt file and renders it with Blade. The method normalizes the prompt name, resolves the file path, checks existence, and renders the content with the given data.

### Method
Static method

### Signature
public static function get(string $name, array $data = []): string

### Parameters
- **$name** (string) - Required - Prompt name relative to resources/prompts, without the .md extension. Dots are converted to directory separators, so both seo/product-meta and seo.product-meta resolve to resources/prompts/seo/product-meta.md.
- **$data** (array) - Optional - Default: [] - Key/value pairs made available as variables to the Blade template ($data['product'] becomes $product, etc.).

### Return Value
string - The fully rendered prompt template. The returned text is the Blade-evaluated content of the .md file with all $data values substituted, directives executed (e.g. @if, @foreach), plain PHP expressions evaluated (number_format(...), implode(...)), and both escaped ({{ }}) and unescaped ({!! !!}) echoes resolved.

### Throws
- **Illuminate\Contracts\Filesystem\FileNotFoundException** - Thrown when the resolved file resources/prompts/{$name}.md does not exist (File::exists() returns false). Message: Prompt [{$name}] not found. (uses normalized name with dots converted to slashes).

### Behavior Details
1. Name normalization: $name = str_replace('.', '/', $name);
2. Path resolution: $path = resource_path("prompts/{$name}.md");
3. Existence gate: if (! File::exists($path)) { throw new FileNotFoundException(...); }
4. Read + render: $content = File::get($path); return Blade::render($content, $data);

### Examples

**Basic usage**
```php
use Chimit\Prompt;

$prompt = Prompt::get('seo/product-meta', [
    'product'  => $product,          // e.g. an Eloquent model
    'keywords' => ['wireless headphones', 'bluetooth', 'noise cancelling'],
]);

// $prompt contains the Blade-rendered Markdown, ready to send to an LLM API
```

Both dot-notation and slash-notation resolve to the same file:
```php
$samePrompt = Prompt::get('seo.product-meta', $data); // identical result
```

**Error handling**
```php
use Chimit\Prompt;
use Illuminate\Contracts\Filesystem\FileNotFoundException;

try {
    $prompt = Prompt::get('reports/daily-summary', ['day' => now()]);
} catch (FileNotFoundException $e) {
    // Message: "Prompt [reports/daily-summary] not found."
    Log::warning('Missing prompt template', ['error' => $e->getMessage()]);

    $prompt = Prompt::get('reports/daily-summary-fallback', ['day' => now()]);
}
```

**Blade template example**
```blade
You are an SEO expert. Generate a meta description for {{ $product->name }}.

@if($product->discount_percentage > 0)
**Special Offer:** {{ $product->discount_percentage }}% OFF - Limited Time!
@endif

Target keywords: {{ implode(', ', $keywords) }}
```
```

--------------------------------

### Manual registration for Laravel 9 / 10

Source: https://github.com/chimit/prompt/blob/main/_autodocs/api-reference/PromptServiceProvider.md

Add the provider to the providers array in the config/app.php configuration file.

```php
// config/app.php
'providers' => [
    // ...
    Chimit\\PromptServiceProvider::class,
],
```

--------------------------------

### boot method signature

Source: https://github.com/chimit/prompt/blob/main/_autodocs/api-reference/PromptServiceProvider.md

The boot method is invoked by the Laravel container during application bootstrapping.

```php
public function boot(): void
```

--------------------------------

### Chimit\Prompt Class Definition

Source: https://github.com/chimit/prompt/blob/main/_autodocs/api-reference/Prompt.md

The structure of the Prompt class, which is designed for static access and utilizes Laravel's Blade and File facades.

```php
<?php

namespace Chimit;

use Illuminate
eements\Filesystem\FileNotFoundException;
use Illuminate\Support\Facades\Blade;
use Illuminate\Support\Facades\File;

class Prompt
{
    public static function get(string $name, array $data = []): string
    {
        // ...
    }
}
```

--------------------------------

### Register Laravel Service Provider in composer.json

Source: https://github.com/chimit/prompt/blob/main/_autodocs/index.md

Configuration snippet for the extra.laravel.providers section to enable package auto-discovery.

```json
"extra": {
  "laravel": {
    "providers": [
      "Chimit\\PromptServiceProvider"
    ]
  }
}
```
Tokens:
Raw