Weave Code
Statamic Gpt Spell Corrector Laravel Package
govigilant/statamic-gpt-spell-corrector
A Statamic addon that uses OpenAI's GPT models to proofread and spell-check your content, helping editors catch typos, grammar issues, and awkward phrasing before publishing.
Automatically correct spelling in Statamic Bard fields using OpenAI
Frequently asked questions about Statamic Gpt Spell Corrector
- How do I install the Statamic GPT spell corrector addon?
- Install it with Composer using composer require govigilant/statamic-gpt-spell-corrector. Then register the addon if your Statamic version requires it, publish any provided configuration, and add your OpenAI API key. Check the repository README for the exact registration and publish commands for your Statamic version.
- Where do I configure the OpenAI API key?
- The addon typically reads an OpenAI API key from your environment, such as OPENAI_API_KEY, and exposes it through a published config file. Add the key to your .env file and never commit it to source control. If you use multiple environments, set separate keys or restrict usage per environment.
- Does this addon work with Laravel applications?
- Yes. Statamic is built on Laravel, so this addon is installed and configured like other Composer packages in a Laravel project. You manage it through your Laravel environment, config, and deployment workflow. It does not replace Laravel; it extends Statamic's Bard field editing experience.
- Which Statamic versions are supported?
- Support depends on the addon's Composer constraints, so check the require section in its composer.json and the repository README before installing. Confirm compatibility with your installed Statamic and PHP versions. If you are on an older Statamic release, test in a staging environment first.
- How does the addon correct spelling in Bard fields?
- It sends Bard field content to OpenAI's GPT models for proofreading and returns corrected text for the editor to review. This helps catch typos, grammar issues, and awkward phrasing before publishing. Because AI output can be imperfect, editors should still review suggested changes.
- Can I customize the GPT model or correction prompt?
- Where the addon exposes configuration, you can usually adjust settings such as the OpenAI model and prompt behavior in the published config file. Use a model that balances quality and cost for your editorial workflow. Review the README for the exact configuration keys available in your version.
- Is my content sent to OpenAI when I use this addon?
- Yes. The addon relies on the OpenAI API, so the Bard content being proofread is sent to OpenAI for processing. Review OpenAI's data usage policies and your organization's privacy requirements before enabling it on sensitive content. Avoid sending confidential material unless your policies explicitly allow it.
- Does it correct spelling automatically when saving content?
- The addon is designed to help editors proofread Bard content, but whether corrections run automatically or through an explicit editor action depends on its configuration and UI integration. In most editorial workflows, you should let an editor review changes before publishing. Check the README for the exact behavior in your installed version.
- What does it cost to run the GPT spell checker?
- Costs come from OpenAI API usage rather than the Composer package itself. Pricing depends on the model you select and the amount of text processed, measured in tokens. Monitor usage in your OpenAI account and choose a cost-effective model for routine proofreading.
- How do I test or debug the addon in a Laravel project?
- Start by verifying your OpenAI API key, config publishing, and network access from the server. Use Laravel logging and Statamic's error output to inspect failed API calls, and consider faking HTTP requests in automated tests to avoid real OpenAI usage. If requests fail, check rate limits, quotas, and model availability in your OpenAI account.
Weaver
How can I help you explore Laravel packages today?