composer require usamamuneerchaudhary/filarank

php artisan filarank:install

php artisan filarank:install --dry-run

php artisan vendor:publish --tag=filarank-migrations
php artisan migrate

php artisan vendor:publish --tag=filarank-config
php artisan vendor:publish --tag=filarank-views
php artisan vendor:publish --tag=filarank-translations

use Usamamuneerchaudhary\FilaRank\FilaRankPlugin;

public function panel(Panel $panel): Panel
{
    return $panel->plugin(FilaRankPlugin::make());
}

FilaRankPlugin::make()
    ->overview()             // SEO Overview dashboard
    ->healthDashboard()      // 404s, cannibalization, orphans, technical audit
    ->keywordResearch()
    ->rankTracker()
    ->backlinks(false)       // hide the pages you don't need
    ->competitors(false)
    ->settings()
    ->redirects()

use Usamamuneerchaudhary\FilaRank\Concerns\HasSeo;

class Post extends Model
{
    use HasSeo;
}

public function getSeoContent(): ?string
{
    return $this->body;
}

public function getSeoSlug(): ?string
{
    return $this->permalink;
}

/** Public URL, used by the sitemap, link graph, and technical audit. */
public function getSeoUrl(): ?string
{
    return route('posts.show', $this, absolute: false);
}

use Usamamuneerchaudhary\FilaRank\Forms\SeoFields;

public static function form(Schema $schema): Schema
{
    return $schema->components([
        TextInput::make('title'),
        TextInput::make('slug'),
        RichEditor::make('content'),

        SeoFields::make(), // assumes `content` + `slug` fields on this form
    ]);
}

SeoFields::make(contentField: 'body', slugField: 'permalink');

// or take full control of where values are read from and written to:
SeoFields::make(
    getContentUsing: fn (Get $get) => $get('../body'),
    getSlugUsing: fn (Get $get) => $get('../permalink'),
    setSlugUsing: fn (string $value, Set $set) => $set('../permalink', $value),
);

use Usamamuneerchaudhary\FilaRank\Tables\SeoScoreColumn;

public static function table(Table $table): Table
{
    return $table->columns([
        TextColumn::make('title'),
        SeoScoreColumn::make(),
    ]);
}

<x-filarank::tags :model="$post" />

<x-filarank::tags title="Contact us" description="Get in touch with our team." />

composer require laravel/head

use Usamamuneerchaudhary\FilaRank\SeoHead;

public function show(Post $post): View
{
    SeoHead::for($post);

    return view('posts.show', ['post' => $post]);
}

SeoHead::for(null, title: 'Contact us', description: 'Get in touch with our team.');

use Usamamuneerchaudhary\FilaRank\SeoAnalyzer;

$report = SeoAnalyzer::analyze([
    'title' => 'Coffee Beans Guide',
    'description' => '…',
    'focus_keyword' => 'coffee beans',
    'slug' => 'coffee-beans',
    'content' => $html,
]);

$report->score();            // 0–100 or null
$report->seoScore();
$report->readabilityScore();
$report->geoScore();
$report->rating();           // Status::Good | Ok | Bad
$report->results;            // list of CheckResult

'ai' => [
    'providers' => [
        'openai' => [
            'api_key' => env('OPENAI_API_KEY'),
            'models' => ['gpt-4o-mini', 'gpt-4o', 'your-new-model'],
            'rates' => [
                'default' => ['in' => 0.15, 'out' => 0.60],
                'gpt-4o' => ['in' => 2.50, 'out' => 10.00],
            ],
        ],
    ],
],

use Usamamuneerchaudhary\FilaRank\Ai\AiService;
use Usamamuneerchaudhary\FilaRank\Ai\Providers\FakeProvider;

$suggestion = app(AiService::class)->suggestSeoFix([
    'title' => $post->seo->title,
    'description' => $post->seo->description,
    'focus_keyword' => 'coffee beans',
    'slug' => $post->slug,
    'content' => $post->content,
]);

// Deterministic output for tests (local/testing environments only):
(new AiService)->useProvider(new FakeProvider)->suggestSeoFix([...]);

'sitemap' => [
    'enabled' => true,
    'path' => 'filarank-sitemap.xml',
    'changefreq' => 'weekly',
    'priority' => 0.5,
    'cache_seconds' => 3600,

    'ping' => false,
    'ping_endpoints' => [
        'https://www.bing.com/ping?sitemap={sitemap}',
    ],
],

'audit' => [
    'allowed_hosts' => ['docs.example.com'],
    'max_pages' => 500,
    'delay_ms' => 0,       // throttle between requests
],

use Usamamuneerchaudhary\FilaRank\Keywords\KeywordStore;

$store = app(KeywordStore::class);
$store->saveResearched(['coffee beans', 'best coffee beans']);
$store->track('coffee beans');       // never clears existing enrichment
$store->dismiss([$id]);              // untracked rows only; tracked keywords are safe

php artisan filarank:check-ranks

php artisan filarank:prune-keywords --days=30          # dry run, lists what would go
php artisan filarank:prune-keywords --days=30 --force  # actually delete

'analysis' => [
    'disabled_checks' => ['outbound-links', 'passive-voice'],
],

'render' => [
    'schema_types' => [
        'organization' => true,
        'website' => true,
        'breadcrumb' => true,
        'article' => true,
        'faq' => true,
        'product' => false,
    ],
],

'scanned_models' => [
    \App\Models\Post::class => ['label' => 'title'],
    \App\Models\Page::class => ['label' => 'name'],
],

use Usamamuneerchaudhary\FilaRank\Analysis\Contracts\Check;
use Usamamuneerchaudhary\FilaRank\Analysis\{CheckResult, ContentContext, Status};

final class NoClickbaitTitle implements Check
{
    public function id(): string { return 'no-clickbait'; }
    public function group(): string { return 'seo'; }

    public function isApplicable(ContentContext $context): bool
    {
        return filled($context->title);
    }

    public function run(ContentContext $context): CheckResult
    {
        $clickbait = str_contains(mb_strtolower($context->title), 'you won\'t believe');

        return new CheckResult(
            $this->id(),
            $this->group(),
            $clickbait ? Status::Bad : Status::Good,
            $clickbait ? 'Avoid clickbait phrasing in titles.' : 'Title looks trustworthy.',
        );
    }
}

$report = SeoAnalyzer::analyzer()
    ->withCheck(new NoClickbaitTitle())
    ->analyze($context);

use Usamamuneerchaudhary\FilaRank\Http\Middleware\HandleRedirects;

->withMiddleware(function (Middleware $middleware) {
    $middleware->web(append: [HandleRedirects::class]);
})

'redirects' => [
    'auto_on_slug_change' => true,
    'only_when_published' => true,
],

$graph = app(\Usamamuneerchaudhary\FilaRank\Reports\SeoReports::class)->linkGraph();
$graph->orphans();
$graph->suggestionsFor($record);       // keyphrase-based, cornerstone-boosted
$graph->underlinkedCornerstones(3);

use Usamamuneerchaudhary\FilaRank\Keyphrase\KeyphraseAnalyzer;

$results = (new KeyphraseAnalyzer())->analyze($context); // primary first, then related

use Usamamuneerchaudhary\FilaRank\Language\LanguageRegistry;

app(LanguageRegistry::class)->register(new FrenchPack());

composer test              # Pest (Laravel integration, requires composer install)
composer test:standalone   # both engine suites, zero dependencies, just PHP