# Statamic Importer

## Package docs status

This page is generated from package source documentation in `the Capell packages repository` and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

| Field | Value |
| --- | --- |
| Composer package | `capell-app/statamic-importer` |
| Package slug | `statamic-importer` |
| Product group | Capell Operations |
| Tier | free |
| Bundle | `operations` |
| Runtime contexts | `console` |
| Capell version | `^1.0` |
| Catalogue role | extension |
| Release channel | Labs |
| Docs source | `packages/statamic-importer/docs` |
| Manifest | `capell.json` |

<!-- prettier-ignore-start -->

Moving a client's Statamic site onto one built with Capell starts here. Point it at a copy of the site on disk and each collection entry arrives as an ordinary page, with its translations and address. It runs from the command line.

A dry run writes nothing. It counts entries, sites, taxonomies, navigation, assets and templates. It also lists every field and template with no home in Capell, so you know what is left to rebuild before you start.

Each entry is remembered by its Statamic ID. Running the import again skips entries that have not changed and updates those that have. Any page someone has since edited in Capell is left alone. Every run keeps a rollback report.

Antlers templates are never run or converted. They are listed by name instead. Asset files, navigation menus and taxonomy terms are counted but not copied, and users stay behind. Unpublished entries arrive as drafts.

When the run finishes, the old entries sit in the admin area as pages, ready for layouts, with the fields and templates the dry run listed still to rebuild.

- **Price and availability:** Check current availability and price on the [Capell Marketplace listing](https://capell.app/extensions/statamic-importer).
- **Licence:** Published under MIT in `composer.json`.
- **Requires:** `PHP ^8.4`, `capell-app/admin ^1.0`, `capell-app/core ^1.0.75`, `capell-app/migration-assistant ^1.0`, `illuminate/support ^11.0|^12.0|^13.0`, `league/commonmark ^2.8.1`, `spatie/laravel-package-tools ^1.15`, `symfony/html-sanitizer ^7.0|^8.0`, `symfony/yaml ^7.4|^8.0`.
- **Install:** `composer require capell-app/statamic-importer`.

## Quick Start

1. Install the package: `composer require capell-app/statamic-importer`.
2. Run `php artisan list statamic-importer` and confirm these commands are listed: `statamic-importer:import`. Run any of them with `--help` to see its options.

## For Developers

Reading, reporting and importing are separate Actions: a confined, read-only source reader, a dry-run report with no entry content, and an executor that writes through Migration Assistant's source-key importer and rollback report.

## Configure

- **Configuration files:** `config/statamic-importer.php`.
- **Commands:** `php artisan statamic-importer:import`.

## Limits And Pitfalls

- Install the required Capell packages at the versions in `composer.json`: `capell-app/admin ^1.0`, `capell-app/core ^1.0.75`, `capell-app/migration-assistant ^1.0`.

## Screens And Workflow

Docs gap: add `docs/screenshots.json` before promoting this package with visual workflow claims.

- Admin index screen if the package has a Filament resource.
- Create/edit screen if editors create records.
- Settings/configuration screen when settings exist.
- Frontend output when the package renders public pages.
- Package detail or install intent screen when marketplace-owned.

## Install Impact

- Required packages: `capell-app/admin`, `capell-app/core`, `capell-app/migration-assistant`.
- Admin navigation: no admin page or resource contribution is declared.
- Admin/editor extensions: none declared.
- Permissions: no package permission declarations or Shield gates detected; host access rules still apply.
- Public routes: none declared.
- Database changes: no package migrations declared.
- Config: `config/statamic-importer.php`.
- Settings: no package settings declared.
- Queues or schedules: none declared.
- Cache tags: none declared.
- Commands: `statamic-importer:import`.

## Troubleshooting

| Symptom | Likely cause | Check | Fix |
| --- | --- | --- | --- |
| Package surface is missing after install | Provider or manifest is not loaded | Confirm `capell.json`, package `composer.json`, and provider registration | Reinstall the package, refresh Composer autoload, and clear host caches |

## Upgrading

No manual steps between minor versions.

Read [CHANGELOG.md](CHANGELOG.md) before upgrading.

## Next Steps

- [Package docs](README.md)
- [Overview](overview.md)
- Configuration files: [`config/statamic-importer.php`](config/statamic-importer.php).
- [Troubleshooting](#troubleshooting)
- [Developer reference](reference.md)
- [Capell content language plan](../../docs/CONTENT_LANGUAGE_PLAN.md)
- [Capell documentation design system](../../docs/DESIGN_SYSTEM.md)
- [Capell and package ERD notes](../../docs/erd/capell-and-package-erds.md)
- Related packages: [Migration Assistant](../migration-assistant/README.md).

<!-- prettier-ignore-end -->