# rocketweb/module-cms-import-export > CMS import and export CLI command extension that allows syncing CMS blocks & pages between environments `composer require rocketweb/module-cms-import-export` Canonical URL: https://packagento.com/rocketweb/module-cms-import-export ## At a glance - **Vendor**: rocketweb (https://packagento.com/rocketweb.md) - **Latest version**: 1.2.0 — released 2025-01-28 - **Pricing**: Free - **Package type**: Magento 2 module - **Status**: active, accepting new buyers ## Installation Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them. 1. **Sign in or create an account** at https://packagento.com/customer/account/. 2. **Add the package to your account.** Open https://packagento.com/rocketweb/module-cms-import-export and complete the free checkout. A licence is minted automatically. 3. **Create or pick a project, then activate the licence on it.** - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/. - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project. 4. **Add the project credentials to your Magento codebase.** Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`: ```json { "http-basic": { "packagento.com": { "username": "ppk_live_...", "password": "psk_live_..." } } } ``` Add the Packagento Composer repository to `composer.json`: ```json { "repositories": [ { "type": "composer", "url": "https://packagento.com" } ] } ``` 5. **Install and apply.** ```bash composer require rocketweb/module-cms-import-export:* bin/magento setup:upgrade bin/magento setup:di:compile bin/magento cache:flush ``` ## What it does CMS import and export CLI command extension that allows syncing CMS blocks & pages between environments ## README A tool to manage CMS content (both blocks & pages) being imported/exported between environments using the repository. This tool comes handy for build and maintenance projects. > Ideas for using this: > - allowing FED team to create a CMS block/page in admin but then modify the HTML content using proper IDEs that allow auto-complete & code-styling > - allowing simpler deployments since there is no manual copy/paste of CMS data needed > - allowing the client to modify staging content and having it ready for deployment > - having an easy way to sync up production env to staging/dev/local by exporting on production and importing on staging/dev/local ### Installation Using composer: ``` composer require rocketweb/module-cms-import-export ``` Then enable module: ``` bin/magento module:enable RocketWeb_CmsImportExport ``` Once the tool is installed, we have two workflows, depending on what we are trying to do. ### Export Usage: ``` php bin/magento cms:dump:data [options] Description: Dumps cms pages/blocks to var/sync_cms_data for further import Options: -t, --type=TYPE Which type are we dumping - block/page/all -i, --identifier[=IDENTIFIER] identifier to process (one or CSV list) -a, --importAll Flag to import all files -r, --removeAll Flag to remove all existing data ``` As you can see from the options, we need to define: - type - which can be CMS block, CMS page or both - **required** - identifier - either a CMS block or CMS page identifier - **optional** With the combination of these two, we can **export**: - all CMS content (using --type=all) - all CMS pages (using --type=page) - all CMS blocks (using --type=block) - specific CMS page or pages (using --type=page --identifier=about-us.html,no-route) - specific CMS block or blocks (using --type=block --identifier=who-are-we,homepage-carousel) > CMS Page identifier is **Url Key**! Because of that, it can have **.html** suffix - it depends on what is set in the Magento Admin CMS Edit Page. _Use the actual value from CMS Edit Page - Url Key_!If the CMS Page Url Key has **.html** suffix, then the file **%%IDENTIFIER%%** will be: **url_key_html.html** (but for export or import, you still use the value from Url Key) Once you execute the command, you will get the following folder structure: ``` var/sync_cms_data/cms/ - blocks - %%IDENTIFIER%%.html => contains the block HTML - %%IDENTIFIER%%.json => contains title, is_active, stores information - pages - %%IDENTIFIER%%.html => contains the page HTML - %%IDENTIFIER%%.json => contains title, is_ative, page_layou, content_heading ``` You can modify the HTML directly in your editor which should give you more flexibility. When you are done, commit the files (html & json) to the repository. ### Import ``` Usage: php bin/magento cms:import:data [options] Description: Import cms pages/blocks from var/sync_cms_data Options: -t, --type=TYPE Which type are we importing - block/page/all -i, --identifier[=IDENTIFIER] identifier to process (one or CSV list) -a, --importAll Flag to import all files -s, --store[STORE_CODE] Store code to process only pages/blocks specific to this store ``` This command works by using files in `var/sync_cms_data/cms/` path. As you can see from the options, we need to define: - type - which can be CMS block or CMS page - **required** - identifier - either a CMS block or CMS page identifier - **optional** There are optional parameters: - importAll - when identifiers not specified we'll import all blocks or pages - store - store code (like default) to import block(s)/pages(s) only for specific store With the combination of these two, we can **import**: - all CMS pages (using --type=page and importAll) - all CMS blocks (using --type=block and importAll) - specific CMS page or pages (using --type=page --identifier=about-us,homepage-new) - specific CMS block or blocks (using --type=block --identifier=who-are-we,homepage-carousel) - specific CMS page by store (using --type=page --identifier=about-us-default --store=default) Once you execute the command, the content will be created/updated in Magento Admin. By executing `php bin/magento cache:flush` you should be able to see the updated CMS content on frontend also! ## Recent Versions | Version | Released | |---|---| | 1.2.0 | 2025-01-28 | | 1.1.0 | 2024-01-10 | | 1.0.1 | 2023-08-03 | ## Dependencies ### Require | Package | Constraint | |---|---| | magento/module-cms | 104.0.* | | php | ^7.4\|^8.0 | ### Require (dev) | Package | Constraint | |---|---| | phpunit/phpunit | ^10.5 | | reach-digital/magento2-test-framework | ^1.7 | ## Quality Latest release (1.2.0) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers. ### Compatibility Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`. | Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 | |---|---|---|---|---| | 2.4.7 | Pass | Pass | – | – | | 2.4.8 | – | Pass | Pass | – | | 2.4.9 | – | – | Pass | 1 | ### Code Quality Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible. #### Static Analysis Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module. | Tool | Status | Findings | Summary | |---|---|---|---| | PHPCS | Fail | 59 | 6 errors, 53 warnings (ruleset: Magento2) — 5 auto-fixable with phpcbf | | PHPMD | Warning | 13 | 13 rule violations (MissingImport:11, UnusedFormalParameter:2) | | Cpd | Pass | 0 | | | Composer validate | Pass | 0 | | #### PHPStan Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases. | Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 | |---|---|---|---|---| | 2.4.7 | 24 | 24 | – | – | | 2.4.8 | – | 24 | 26 | – | | 2.4.9 | – | – | 26 | 26 | ### Tests Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately. #### Unit Tests | Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 | |---|---|---|---|---| | 2.4.7 | N/A | N/A | – | – | | 2.4.8 | – | N/A | N/A | – | | 2.4.9 | – | – | N/A | N/A | #### Integration Tests | Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 | |---|---|---|---|---| | 2.4.7 | Pass | Pass | – | – | | 2.4.8 | – | Pass | not tested | – | | 2.4.9 | – | – | 4 | Error | ### Security Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright. | Tool | Status | Findings | Summary | |---|---|---|---| | Composer audit | Pass | 0 | | | Malware scan | Pass | 0 | | ## Licence and pricing Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step. Refundable within 14 days of first purchase via https://packagento.com/account/refunds/. ## Install via Claude Code or any MCP client The Packagento MCP server can run the licence + project + Composer steps above in one tool call: ``` purchase_and_install_packages( composer_names=["rocketweb/module-cms-import-export"], project_id="proj_xxx" ) ``` This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup. ## Vendor rocketweb is a Magento 2 vendor on Packagento. See https://packagento.com/rocketweb.md for their full catalogue.