PHPackages modxcms/teleport - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. modxcms/teleport ActiveLibrary[Utility & Helpers](/categories/utility) modxcms/teleport ================ An extensible scripting and packaging toolkit for MODX Revolution v2.0.4(3y ago)5711522[10 issues](https://github.com/modxcms/teleport/issues)[4 PRs](https://github.com/modxcms/teleport/pulls)1MITPHPPHP >=7.0 Since Nov 2Pushed 1y ago16 watchersCompare [ Source](https://github.com/modxcms/teleport)[ Packagist](https://packagist.org/packages/modxcms/teleport)[ RSS](/packages/modxcms-teleport/feed)WikiDiscussions 1.x Synced yesterday READMEChangelogDependencies (7)Versions (23)Used By (1) Teleport ======== [](#teleport) Teleport is an extensible scripting toolkit for working with one or more local MODX Revolution installations. Teleport currently functions primarily as a packaging toolkit which extends the MODX Transport APIs and provides commands for extracting and injecting customizable snapshots of MODX deployments. But it can be extended easily to perform an infinite variety of actions related to MODX. MODX Revolution 3.x ------------------- [](#modx-revolution-3x) Please use the [`2.x`](https://github.com/modxcms/teleport/tree/2.x) branch and releases for MODX 3.x support. Requirements ------------ [](#requirements) In order to use Teleport, your environment must at least meet the following requirements: - PHP >= 5.4 - MODX Revolution >= 2.1 (MySQL) You must also be able to run PHP using the CLI SAPI. NOTE: At the current time, various Teleport Extract tpls only support MySQL deployments of MODX Revolution. Usage on Linux environments with the PHP posix extension can take advantage of advanced user-switching features. Teleport strives to be a multi-platform tool, and currently works equally well in Linux and OS X environments. Windows support is unknown at this time; Windows contributors wanted. Installation ------------ [](#installation) There are several methods for installing Teleport. The easiest way to get started is by installing the Teleport Phar distribution. *IMPORTANT: Using any of the installation methods, make sure you are running Teleport as the same user PHP runs as when executed by the web server. Failure to do so can corrupt your MODX site by injecting and/or caching files with incorrect file ownership.* ### Download and Install Phar [](#download-and-install-phar) Create a working directory for Teleport and cd to that directory, e.g. ``` mkdir ~/teleport/ && cd ~/teleport/ ``` Download the latest [`teleport.phar`](http://modx.s3.amazonaws.com/releases/teleport/teleport.phar "teleport.phar") distribution of Teleport into your Teleport working directory. Create a Profile of a MODX site: ``` php teleport.phar --action=Profile --name="MyMODXSite" --code=mymodxsite --core_path=/path/to/mysite/modx/core/ --config_key=config ``` Extract a Snapshot from the MODX site you just profiled: ``` php teleport.phar --action=Extract --profile=profile/mymodxsite.profile.json --tpl=phar://teleport.phar/tpl/develop.tpl.json ``` ### Other Installation Methods [](#other-installation-methods) Alternatively, you can install Teleport using the source and [Composer](http://getcomposer.org/). Learn more about using [git clone](doc/install/git-clone.md) or a [release archive](doc/install/releases.md). *IMPORTANT: If you want to use the Teleport HTTP Server you cannot use the Phar distribution. You MUST use one of the other installation methods.* ### Teleport in your PATH [](#teleport-in-your-path) With any of the installation methods you can create an executable symlink called teleport pointing to bin/teleport, or directly to the teleport.phar. You can then simply type `teleport` instead of `bin/teleport` or `php teleport.phar` to execute the teleport application. Basic Usage ----------- [](#basic-usage) In all of the usage examples that follow, call teleport based on how you have installed the application. For example, if you installed from source, substitute `bin/teleport` for `php teleport.phar`; if you have created an executable symlink to the teleport.phar, substitute `teleport` for `php teleport.phar` in the sample commands. The following examples assume you have installed the teleport.phar distribution. *NOTE: **Before** using Teleport with a MODX site, you will need to **create a Teleport Profile** from the installed site.* ### Create a MODX Site Profile [](#create-a-modx-site-profile) You can create a Teleport Profile of an existing MODX site using the following command: ``` php teleport.phar --action=Profile --name="MySite" --code=mysite --core_path=/path/to/mysite/modx/core/ --config_key=config ``` The resulting file would be located at profile/mysite.profile.json and could then be used for Extract or Inject commands to be run against the site represented in the profile. Learn more about [Teleport Profiles](doc/use/profile.md). ### Extract a Snapshot of a MODX Site [](#extract-a-snapshot-of-a-modx-site) You can Extract a Teleport snapshot from a MODX site using the following command: ``` php teleport.phar --action=Extract --profile=profile/mysite.profile.json --tpl=phar://teleport.phar/tpl/develop.tpl.json ``` The snapshot will be located in the workspace/ directory if it is created successfully. You can also Extract a Teleport snapshot and push it to any valid stream target using the following command: ``` php teleport.phar --action=Extract --profile=profile/mysite.profile.json --tpl=phar://teleport.phar/tpl/develop.tpl.json --target=s3://mybucket/snapshots/ --push ``` In either case, the absolute path to the snapshot is returned by the process as the final output. You can use this as the path for an Inject source. *NOTE: The workspace copy is removed after it is pushed unless you pass --preserveWorkspace to the CLI command.* Learn more about the [Teleport Extract](doc/use/extract.md) Action. ### Inject a Snapshot into a MODX Site [](#inject-a-snapshot-into-a-modx-site) You can Inject a Teleport snapshot from any valid stream source into a MODX site using the following command: ``` php teleport.phar --action=Inject --profile=profile/mysite.profile.json --source=workspace/mysite_develop-120315.1106.30-2.2.1-dev.transport.zip ``` *NOTE: If the source is not within the workspace/ directory a copy will be pulled to that location and then removed after the Inject completes unless --preserveWorkspace is passed.* Learn more about the [Teleport Inject](doc/use/inject.md) Action. ### UserCreate [](#usercreate) You can create a user in a profiled MODX site using the following command: ``` php teleport.phar --action=UserCreate --profile=profile/mysite.profile.json --username=superuser --password=password --sudo --active --fullname="Test User" --email=testuser@example.com ``` *NOTE: This uses the security/user/create processor from the site in the specified profile to create a user, and the action accepts any properties the processor does.* Learn more about the [Teleport UserCreate](doc/use/user-create.md) Action. Get Started ----------- [](#get-started) Learn more about Teleport in the [documentation](doc/index.md). License ------- [](#license) Teleport is Copyright (c) MODX, LLC For the full copyright and license information, please view the [LICENSE](./LICENSE "LICENSE") file that was distributed with this source code. ### Health Score 38 — LowBetter than 83% of packages Maintenance25 Infrequent updates — may be unmaintained Popularity25 Limited adoption so far Community24 Small or concentrated contributor base Maturity68 Established project with proven stability Bus Factor1 Top contributor holds 91.3% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~174 days Recently: every ~105 days Total 21 Last Release 1145d ago Major Versions v1.6.1 → v2.0.02022-03-14 v1.6.3 → v2.0.22022-03-18 1.x-dev → v2.0.32023-01-27 PHP version history (3 changes)v1.0.0-alpha1PHP >=5.3.3 v1.3.0PHP >=5.4 v2.0.0PHP >=7.0 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/232812?v=4)[Jason Coward](/maintainers/opengeek)[@opengeek](https://github.com/opengeek) --- Top Contributors [![opengeek](https://avatars.githubusercontent.com/u/232812?v=4)](https://github.com/opengeek "opengeek (137 commits)")[![mkschell](https://avatars.githubusercontent.com/u/121744?v=4)](https://github.com/mkschell "mkschell (4 commits)")[![theboxer](https://avatars.githubusercontent.com/u/845220?v=4)](https://github.com/theboxer "theboxer (4 commits)")[![matdave](https://avatars.githubusercontent.com/u/2213127?v=4)](https://github.com/matdave "matdave (3 commits)")[![hansek](https://avatars.githubusercontent.com/u/378835?v=4)](https://github.com/hansek "hansek (1 commits)")[![Omeryl](https://avatars.githubusercontent.com/u/6556439?v=4)](https://github.com/Omeryl "Omeryl (1 commits)") ### Embed Badge ![Health badge](/badges/modxcms-teleport/health.svg) ``` [![Health](https://phpackages.com/badges/modxcms-teleport/health.svg)](https://phpackages.com/packages/modxcms-teleport) ``` ### Alternatives [friendsofphp/php-cs-fixer A tool to automatically fix PHP code style 13.5k245.4M24.0k](/packages/friendsofphp-php-cs-fixer)[composer/composer Composer helps you declare, manage and install dependencies of PHP projects. It ensures you have the right stack everywhere. 29.5k193.1M3.0k](/packages/composer-composer)[symfony/framework-bundle Provides a tight integration between Symfony components and the Symfony full-stack framework 3.6k246.0M11.1k](/packages/symfony-framework-bundle)[rector/rector-src Instant Upgrade and Automated Refactoring of any PHP code 136400.8k14](/packages/rector-rector-src)[friendsoftypo3/content-blocks TYPO3 CMS Content Blocks - Content Types API | Define reusable components via YAML 101466.4k45](/packages/friendsoftypo3-content-blocks)[civicrm/civicrm-core Open source constituent relationship management for non-profits, NGOs and advocacy organizations. 751284.3k37](/packages/civicrm-civicrm-core) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)