Weave Code
Statamic Sync Laravel Package
insight-media/statamic-sync
A Statamic addon from Insight Media for synchronizing content between your site and external sources or environments. Configure mappings, run syncs via Artisan commands or the control panel, and keep entries, assets, and related data consistent and repeatable.
A console command to keep your local Statamic project in sync with the production version.
Frequently asked questions about Statamic Sync
- What is insight-media/statamic-sync?
- It is a Statamic addon from Insight Media that provides a console command for keeping a local Statamic project synchronized with a production version. It is designed around configurable mappings so entries, assets, and related data can be pulled in a repeatable way. Syncs can be triggered through Artisan or the control panel.
- How do I install insight-media/statamic-sync?
- Install it with Composer by running composer require insight-media/statamic-sync in your Statamic project. As a Statamic addon it should be discovered by the framework, but check the repository README for any required publish or configuration steps. Commit your composer.json and composer.lock changes so other environments install the same version.
- Which Laravel and Statamic versions does it support?
- The provided package context does not list explicit version constraints, so check the composer.json requirements in the repository before installing. Confirm that your Laravel and Statamic versions satisfy those constraints. If you are on an older Statamic release, review the package tags and release notes for a compatible version.
- How do I run a sync from the command line?
- The addon exposes an Artisan console command, which you run from your local project to pull data from the configured source. The exact command signature and available options are documented in the README, so use that as the reference. Run it in a local or staging environment first to confirm the mappings behave as expected.
- What kind of content can statamic-sync synchronize?
- The package is described as keeping entries, assets, and related data consistent between environments. What actually moves depends on the mappings you configure, so define those deliberately rather than assuming everything is included. Review the sync output after each run to verify the expected collections and assets were updated.
- How does configuration and mapping work in statamic-sync?
- You configure mappings that describe which source data corresponds to which local content, making the sync repeatable instead of ad hoc. Keep the mapping configuration in version control so the same rules apply across machines. Start with a narrow mapping for one collection or asset container, verify the result, then expand.
- Is it safe to run against production?
- The intended direction is pulling production content into your local project, so treat production credentials carefully and use a read-only or restricted account where possible. Back up your local database and assets before the first run in case mappings overwrite existing content. Test the command on a staging copy before pointing it at a live site.
- Can I use it with staging or multiple environments?
- Yes, the concept applies to any environment you can reach and configure, not just production. Use environment-specific configuration and credentials so each environment points at the correct source. Keep separate mappings where staging content differs structurally from production.
- Does statamic-sync work from the Statamic control panel?
- The addon description states that syncs can be run via Artisan commands or the control panel. The control panel option is convenient for quick refreshes, but the console command remains the better choice for scripted or repeatable workflows. Check the README for any permissions or setup needed for the control panel integration.
- How is insight-media/statamic-sync maintained, and what are the alternatives?
- Review the GitHub repository for recent commits, releases, and open issues to judge maintenance activity before adopting it. If it does not fit your needs, alternatives include Statamic's own multi-environment workflows, custom import commands, or a bespoke content migration script. Because the package is environment-focused, evaluate it against your deployment and content promotion process.
Weaver
How can I help you explore Laravel packages today?