Weave Code
Sidecar Laravel Package
statamic/sidecar
Sidecar bridges Laravel Actions and Statamic, letting you reuse existing action classes as Statamic actions. Run custom logic from the control panel, CLI, or code without duplicating classes, while keeping actions clean, discoverable, and easy to test.
Edit your static site generator's markdown content in the Statamic Control Panel
Frequently asked questions about Sidecar
- What does the statamic/sidecar package actually do?
- Sidecar is a bridge between Laravel Actions and Statamic. It lets you reuse action classes you already have as Statamic actions, so custom logic can be triggered from the Statamic Control Panel, the CLI, or directly from your own code. The goal is to avoid maintaining two versions of the same class and to keep actions clean, discoverable, and easy to test.
- How do I install statamic/sidecar in a Laravel application?
- Install it with Composer as a normal Statamic add-on: composer require statamic/sidecar. Because it is a Statamic add-on, it expects to run inside a Laravel application with Statamic already installed and configured. After installing, follow the add-on's setup notes and make sure your existing action classes are autoloadable so Sidecar can discover them.
- Do I have to rewrite my existing Laravel Actions to use them inside Statamic?
- No. Reusing your existing action classes instead of duplicating them is the entire point of the package. You point Sidecar at actions you have already written and tested, and it exposes them as Statamic actions. That means one class serves your application code, your CLI commands, and the Control Panel.
- Can Sidecar actions be run from the command line or from my own code, not just the Control Panel?
- Yes. Sidecar is designed around three entry points: the Statamic Control Panel, the CLI, and plain code. The same action class behaves the same way regardless of how it is invoked. This makes it practical to trigger logic manually from the CP while also calling it from a scheduled command or another service class.
- How does Sidecar keep action classes clean, discoverable, and testable?
- By keeping the logic in a single action class rather than spreading it across Statamic-specific wrappers. Because the class is a standard Laravel Action, you can unit test it the way you test any other action, without booting the Control Panel. Discoverability comes from Sidecar registering those classes as available Statamic actions.
- Is Sidecar a replacement for Laravel Actions or for Statamic's built-in actions?
- Neither. It is a bridge, not a replacement. Laravel Actions remains the place where your logic lives, and Statamic remains the place where the action is surfaced to editors and administrators. Sidecar simply connects the two so you do not have to write parallel implementations.
- Which Laravel and Statamic versions does Sidecar support?
- Sidecar is a Statamic add-on, so its Laravel and PHP support tracks the Statamic release you are running. Rather than guessing, check the require constraints in the package's composer.json and the repository's release notes before upgrading. When you upgrade Statamic across a major version, verify Sidecar compatibility at the same time.
- Can Sidecar actions work with content stored outside Statamic, such as markdown files?
- Yes, because a Sidecar action is still just your own PHP class, so it can read and write files, call APIs, or transform content wherever it lives. Sidecar only supplies the bridge that lets you trigger that class from the Control Panel, the CLI, or code. Any file or content handling is up to the action you write.
- Is statamic/sidecar safe to use in production?
- It is a thin bridge, so the risk profile mostly reflects the actions you expose rather than the package itself. Test each action in isolation first, since the same class can be invoked from the Control Panel, the CLI, and application code. Also make sure Control Panel access is governed by Statamic's permissions so only the right users can trigger sensitive logic.
- How is statamic/sidecar maintained, and where do I report bugs or request features?
- The package lives in the official Statamic GitHub organisation at github.com/statamic/sidecar, which is the right place for issues, pull requests, and feature discussions. Check the repository's releases and CHANGELOG before upgrading to see what changed. For day-to-day usage questions, the Statamic community channels are usually the fastest route.
Weaver
How can I help you explore Laravel packages today?