- What is jeffersongoncalves/screentest-cli used for?
- It is a CLI tool for automated screenshot generation of Filament plugins. It captures light and dark theme screenshots with Puppeteer, can auto-seed data, and updates the README with the generated images. It is built with Laravel Zero and is intended for developer workflows around visual checks and plugin documentation.
- How do I install jeffersongoncalves/screentest-cli?
- Install it with Composer using the package name jeffersongoncalves/screentest-cli. Because it is a Laravel Zero CLI application, you can require it in a project or install it globally depending on how you want to run the command. Follow the README for the recommended global versus local installation and any post-install setup.
- Does screentest-cli require Laravel or Filament?
- The tool is built with Laravel Zero, so it runs as a standalone PHP CLI and does not require a full Laravel application just to execute. Its main target is screenshot generation for Filament plugins, so you will normally use it in a Filament plugin development context. Check the README and composer.json for exact PHP and Laravel Zero constraints.
- Do I need Node.js and Puppeteer installed?
- Yes, browser capture is handled by Puppeteer, so you need a working Node.js environment and a compatible browser binary. Make sure Puppeteer can launch in the environment where you run the CLI, especially on CI runners or minimal containers. The README should list any additional dependency or setup steps.
- How does it capture light and dark theme screenshots?
- It uses Puppeteer to automate a browser and capture screenshots in both light and dark themes. The CLI orchestrates the capture workflow, including preparing data so the screens are populated. The generated images are then used for plugin documentation.
- Can it seed data before taking screenshots?
- Yes, the tool includes auto-seeding so screenshots are captured with data instead of empty states. This is useful for Filament plugin documentation where realistic content matters. Confirm the seeding details and configuration in the README before relying on it in automated runs.
- How does it update my README with screenshots?
- The CLI can update the README as part of its screenshot workflow, refreshing the images used in your plugin documentation. This reduces manual copy-and-paste work after UI changes. Review the README for expected markers, paths, or configuration around README updates.
- What Laravel and PHP versions are supported?
- Compatibility is driven mainly by the package's PHP and Laravel Zero requirements rather than a specific Laravel application version. Check composer.json and the README for the supported PHP and Laravel Zero versions. Also verify that the Filament plugin you are testing matches your Filament version.
- Can I run screentest-cli in CI or automated workflows?
- It is a command-line tool, so it can be scripted in CI or other automated environments where browser automation is available. You will need Node, Puppeteer, and a compatible browser in the runner, plus any setup required for the Filament plugin being captured. Check the README for recommended CI flags, environment variables, or headless browser settings.
- Is screentest-cli maintained, and how does it compare with Laravel Dusk or Pest?
- Check the GitHub repository for releases, commit activity, and open issues to judge maintenance status. For general browser testing, Laravel Dusk or Pest browser tests are alternatives; screentest-cli is narrower and focuses on Filament screenshot documentation in light and dark themes. You can use it alongside those tools rather than as a full test suite replacement.