Install the Filament SEO plugin with composer and the interactive filarank:install command. Includes dry-run mode.
Prerequisites
Before you begin, you must have:
PHP 8.3+
Laravel 11, 12, or 13
Filament v5
Install the package
1
Require the package
composer require usamamuneerchaudhary/filarank
2
Run the interactive installer
php artisan filarank:install
The interactive installer publishes the config and migrations, offers to run migrate, then shows a checklist of your app/Models classes. For each model you pick it will:
add the HasSeo trait (plus import) to the model,
find the matching Filament resource anywhere under app/Filament and, with your confirmation, append SeoFields::make() to the form and SeoScoreColumn::make() to the table, with imports.
Patching is deliberately conservative: files are only modified when the expected structure is found, every edit is idempotent (safe to re-run), and anything that can’t be patched automatically falls back to printed manual instructions.
3
Register the panel plugin
The admin pages live behind a plugin so you only get the ones you want:
use Usamamuneerchaudhary\FilaRank\FilaRankPlugin;public function panel(Panel $panel): Panel{ return $panel->plugin(FilaRankPlugin::make());}
Every page defaults to on and can be switched off individually:
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() ->files() // robots.txt + llms.txt ->indexing() // IndexNow ->bulkEditor() ->setupWizard()
Use --dry-run to preview the changes without writing anything to disk:
php artisan filarank:install --dry-run
Manual installation
Prefer to wire things up by hand? The manual steps below are exactly what the installer automates:
Once installed, continue to Wire SEO Fields in Filament to prepare your model, add the SEO form section, show the score column, and render tags on your frontend.
Need to tune site-wide defaults or disable checks? See FilaRank Configuration after wiring up your resources.
Last modified on October 10, 2026
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"FilaRank","description":"SEO toolkit for Filament v5 — live scoring, readability, GEO/AEO, AI fixes, sitemap indexes, robots.txt, IndexNow, and site-wide health reports.","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/filarank/81YWTuFT7FSXkBmD/logo/filarank-logo.png?fit=max\u0026auto=format\u0026n=81YWTuFT7FSXkBmD\u0026q=85\u0026s=85f0df4a113e61a216219264b0ab2b65","dark":"https://mintcdn.com/filarank/81YWTuFT7FSXkBmD/logo/filarank-logo.png?fit=max\u0026auto=format\u0026n=81YWTuFT7FSXkBmD\u0026q=85\u0026s=85f0df4a113e61a216219264b0ab2b65"},"favicon":"https://mintcdn.com/filarank/T-Jui22RsLVBrU1o/favicon.png?fit=max\u0026auto=format\u0026n=T-Jui22RsLVBrU1o\u0026q=85\u0026s=0613ab895fa1c559d16f3512212b613c","navbar":{"links":[{"href":"mailto:hello@usamamuneer.me","label":"Support"},{"icon":"play","href":"https://filarank.com","label":"Demo"}],"primary":{"type":"button","label":"Purchase","href":"https://checkout.anystack.sh/filarank-pro/a22ff325-a480-49c5-bd18-8e9c01990f79"}},"footer":{"socials":{"website":"https://filarank.com"}},"search":{"prompt":"Search FilaRank docs…"},"seo":{"metatags":{"og:site_name":"FilaRank Docs","twitter:card":"summary_large_image","keywords":"Filament SEO, Laravel SEO plugin, Filament meta tags, SERP preview, readability analysis, GEO AEO, AI SEO, rank tracking, XML sitemap, robots.txt, IndexNow, llms.txt"},"indexing":"navigable"},"integrations":{"ga4":{"measurementId":"G-78PZDFFEW2"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"filarank","hasAudioNarration":false,"actualSubdomain":"filarank","customDomains":["docs.filarank.com"],"gitSource":{"type":"github","owner":"usamamuneerchaudhary","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae61411b1d87e83eee6a518","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"Site health","count":5},{"language":"default","tag":"Research","count":4},{"language":"default","tag":"Crawl \u0026 indexing","count":4},{"language":"default","tag":"Usage","count":4},{"language":"default","tag":"Analysis","count":4},{"language":"default","tag":"Getting Started","count":4},{"language":"default","tag":"AI","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#assistant-entry,#assistant-entry-mobile,.chat-assistant-floating-input,#chat-assistant-sheet{display:none!important}"}]}
{"page":{"pagePath":"quickstart","slug":"/quickstart","pageMetadata":{"title":"Install FilaRank on Filament","description":"Install the Filament SEO plugin with composer and the interactive filarank:install command. Includes dry-run mode.","href":"/quickstart"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Install the Filament SEO plugin with composer and the interactive filarank:install command. Includes dry-run mode.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Step,Steps,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsx(_components.p,{children:`Before you begin, you must have:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`PHP 8.3+`}),`\n`,_jsx(_components.li,{children:`Laravel 11, 12, or 13`}),`\n`,_jsx(_components.li,{children:`Filament v5`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`install-the-package`,children:`Install the package`}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Require the package`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`composer`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` require`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` usamamuneerchaudhary/filarank`})]}),`\n`]})})})}),_jsxs(Step,{title:`Run the interactive installer`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`php`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` artisan`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` filarank:install`})]}),`\n`]})})}),_jsxs(_components.p,{children:[`The interactive installer publishes the config and migrations, offers to run `,_jsx(_components.code,{children:`migrate`}),`, then shows a checklist of your `,_jsx(_components.code,{children:`app/Models`}),` classes. For each model you pick it will:`]}),_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`add the `,_jsx(_components.code,{children:`HasSeo`}),` trait (plus import) to the model,`]}),`\n`,_jsxs(_components.li,{children:[`find the matching Filament resource anywhere under `,_jsx(_components.code,{children:`app/Filament`}),` and, with your confirmation, append `,_jsx(_components.code,{children:`SeoFields::make()`}),` to the form and `,_jsx(_components.code,{children:`SeoScoreColumn::make()`}),` to the table, with imports.`]}),`\n`]}),_jsx(_components.p,{children:`Patching is deliberately conservative: files are only modified when the expected structure is found, every edit is idempotent (safe to re-run), and anything that can’t be patched automatically falls back to printed manual instructions.`})]}),_jsxs(Step,{title:`Register the panel plugin`,children:[_jsx(_components.p,{children:`The admin pages live behind a plugin so you only get the ones you want:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`php`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`php`,children:_jsxs(_components.code,{language:`php`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`use`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#D4D4D4`},children:` Usamamuneerchaudhary\\\\FilaRank\\\\`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`FilaRankPlugin`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`public`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` function`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` panel`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`Panel`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` $panel`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` Panel`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` $panel`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`->`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`plugin`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`FilaRankPlugin`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`::`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`make`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`());`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(_components.p,{children:`Every page defaults to on and can be switched off individually:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`13`,language:`php`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`php`,children:_jsxs(_components.code,{language:`php`,numberOfLines:`13`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`FilaRankPlugin`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`::`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`make`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` ->`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`overview`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`() `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// SEO Overview dashboard`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` ->`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`healthDashboard`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`() `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// 404s, cannibalization, orphans, technical audit`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` ->`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`keywordResearch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` ->`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`rankTracker`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` ->`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`backlinks`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// hide the pages you don't need`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` ->`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`competitors`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` ->`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`settings`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` ->`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`redirects`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` ->`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`files`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`() `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// robots.txt + llms.txt`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` ->`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`indexing`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`() `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// IndexNow`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` ->`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`bulkEditor`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` ->`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`setupWizard`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`()`})]}),`\n`]})})})]})]}),`\n`,_jsxs(Tip,{children:[_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`--dry-run`}),` to preview the changes without writing anything to disk:`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`php`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` artisan`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` filarank:install`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --dry-run`})]}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`2`,id:`manual-installation`,children:`Manual installation`}),`\n`,_jsx(_components.p,{children:`Prefer to wire things up by hand? The manual steps below are exactly what the installer automates:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`php`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` artisan`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` vendor:publish`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --tag=filarank-migrations`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`php`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` artisan`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` migrate`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Optionally publish the config, views, or translations:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`php`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` artisan`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` vendor:publish`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --tag=filarank-config`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`php`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` artisan`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` vendor:publish`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --tag=filarank-views`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`php`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` artisan`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` vendor:publish`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --tag=filarank-translations`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Once installed, continue to `,_jsx(_components.a,{href:`/usage`,children:`Wire SEO Fields in Filament`}),` to prepare your model, add the SEO form section, show the score column, and render tags on your frontend.`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Need to tune site-wide defaults or disable checks? See `,_jsx(_components.a,{href:`/configuration`,children:`FilaRank Configuration`}),` after wiring up your resources.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Install FilaRank on Filament","description":"Install the Filament SEO plugin with composer and the interactive filarank:install command. Includes dry-run mode.","href":"/quickstart"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Prerequisites","slug":"prerequisites","depth":2,"children":[]},{"title":"Install the package","slug":"install-the-package","depth":2,"children":[]},{"title":"Manual installation","slug":"manual-installation","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"filarank","siteName":"FilaRank","title":"Install FilaRank on Filament - FilaRank","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-10T21:56:24.469Z","gitLastModified":"2026-10-10T21:56:15.000Z","originalFileLocation":"quickstart.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Install the Filament SEO plugin with composer and the interactive filarank:install command. Includes dry-run mode.\">\u003cmeta data-mint-head name=\"keywords\" content=\"Filament SEO, Laravel SEO plugin, Filament meta tags, SERP preview, readability analysis, GEO AEO, AI SEO, rank tracking, XML sitemap, robots.txt, IndexNow, llms.txt\">\u003cmeta data-mint-head name=\"application-name\" content=\"FilaRank\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/filarank/yaV22AOZYQksaToZ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/filarank/yaV22AOZYQksaToZ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/filarank/yaV22AOZYQksaToZ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/filarank/yaV22AOZYQksaToZ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/filarank/yaV22AOZYQksaToZ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/filarank/yaV22AOZYQksaToZ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/filarank/yaV22AOZYQksaToZ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/filarank/yaV22AOZYQksaToZ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/filarank/yaV22AOZYQksaToZ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Install FilaRank on Filament - FilaRank\">\u003cmeta data-mint-head property=\"og:description\" content=\"Install the Filament SEO plugin with composer and the interactive filarank:install command. Includes dry-run mode.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FilaRank Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.filarank.com/quickstart\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://filarank.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Install+FilaRank+on+Filament\u0026amp;description=Install+the+Filament+SEO+plugin+with+composer+and+the+interactive+filarank%3Ainstall+command.+Includes+dry-run+mode.\u0026amp;theme=443a216977671563f0e2a8a7\u0026amp;signature=11821e3c52b3189eb952ea02255e1bcf07741733fad5b1abe934d99aa58c45c9\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Install FilaRank on Filament - FilaRank\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Install the Filament SEO plugin with composer and the interactive filarank:install command. Includes dry-run mode.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://filarank.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Install+FilaRank+on+Filament\u0026amp;description=Install+the+Filament+SEO+plugin+with+composer+and+the+interactive+filarank%3Ainstall+command.+Includes+dry-run+mode.\u0026amp;theme=443a216977671563f0e2a8a7\u0026amp;signature=11821e3c52b3189eb952ea02255e1bcf07741733fad5b1abe934d99aa58c45c9\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/filarank/yaV22AOZYQksaToZ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FilaRank\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.filarank.com/quickstart\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/quickstart.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.filarank.com/#organization\",\"name\":\"FilaRank\",\"url\":\"https://docs.filarank.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/filarank/81YWTuFT7FSXkBmD/logo/filarank-logo.png?fit=max\u0026auto=format\u0026n=81YWTuFT7FSXkBmD\u0026q=85\u0026s=85f0df4a113e61a216219264b0ab2b65\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.filarank.com#website\",\"name\":\"FilaRank\",\"url\":\"https://docs.filarank.com\",\"publisher\":{\"@id\":\"https://docs.filarank.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.filarank.com/quickstart#webpage\",\"url\":\"https://docs.filarank.com/quickstart\",\"name\":\"Install FilaRank on Filament\",\"description\":\"Install the Filament SEO plugin with composer and the interactive filarank:install command. Includes dry-run mode.\",\"dateModified\":\"2026-10-10T21:56:15.000Z\",\"isPartOf\":{\"@id\":\"https://docs.filarank.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.filarank.com/quickstart#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.filarank.com/quickstart#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting Started\",\"item\":\"https://docs.filarank.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Install FilaRank on Filament\",\"item\":\"https://docs.filarank.com/quickstart\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.filarank.com/quickstart#article\",\"headline\":\"Install FilaRank on Filament\",\"name\":\"Install FilaRank on Filament\",\"description\":\"Install the Filament SEO plugin with composer and the interactive filarank:install command. Includes dry-run mode.\",\"url\":\"https://docs.filarank.com/quickstart\",\"mainEntityOfPage\":{\"@id\":\"https://docs.filarank.com/quickstart#webpage\"},\"dateModified\":\"2026-10-10T21:56:15.000Z\",\"publisher\":{\"@id\":\"https://docs.filarank.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.filarank.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FilaRank\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"FilaRank\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/quickstart.md","siteName":"FilaRank","nav":{"global":null,"pages":[{"group":"Getting Started","pages":[{"title":"FilaRank - Filament SEO Toolkit","description":"Live SEO scoring, GEO/AEO analysis, AI fixes, sitemap indexes, robots.txt, IndexNow, and head tags for Filament admin panels.","href":"/index"},{"title":"Install FilaRank on Filament","href":"/quickstart"},{"title":"Upgrade to v3","description":"Publish v3 migrations, move the sitemap to /sitemap.xml, and pick up robots.txt, llms.txt, IndexNow, and bulk SEO.","href":"/upgrading"},{"title":"FilaRank","href":"/readme"}]},{"group":"Usage","pages":[{"title":"Wire SEO Fields in Filament","href":"/usage"},{"title":"FilaRank Configuration","href":"/configuration"},{"title":"Custom SEO Checks in FilaRank","href":"/custom-checks"},{"title":"Title templates and social","href":"/title-templates"}]},{"group":"Analysis","pages":[{"title":"GEO / AEO scoring","href":"/geo-aeo"},{"title":"Multiple Focus Keyphrases","href":"/multiple-keywords"},{"title":"Cornerstone Content in FilaRank","href":"/cornerstone-content"},{"title":"Readability Language Packs","href":"/language-packs"}]},{"group":"Crawl \u0026 indexing","pages":[{"title":"XML sitemap","href":"/sitemap"},{"title":"robots.txt and llms.txt","href":"/crawl-files"},{"title":"IndexNow","href":"/indexnow"},{"title":"Bulk SEO","href":"/bulk-seo"}]},{"group":"Site health","pages":[{"title":"Redirect Manager \u0026 404 Capture","href":"/redirect-manager"},{"title":"Internal Linking \u0026 Orphan Reports","href":"/internal-linking"},{"title":"Keyword Cannibalization Detection","href":"/cannibalization"},{"title":"Technical audit","href":"/technical-audit"},{"title":"Structured data","href":"/structured-data"}]},{"group":"Research","pages":[{"title":"Keyword research","href":"/keyword-research"},{"title":"Rank tracking","href":"/rank-tracking"},{"title":"Backlinks","href":"/backlinks"},{"title":"Competitors","href":"/competitors"}]},{"group":"AI","pages":[{"title":"AI features","href":"/ai"}]}]},"basePath":"","title":"Install FilaRank on Filament - FilaRank","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":[],"chunks":[]}