Adobe

Managing AEM Packages from the CLI

Code New 1

After the umpteenth time of having to check this excellent reference of the cURL commands for AEM to upload a package, I finally thought “this is silly”. So, I created a small script to make it easier to manage packages via the command line.
The AEM Package Manager is just that, a small script to help you manage scripts from the command line. This script is useful for many occasions, such as:

  • Exchanging content packages
  • Installing a dependency package outside the build
  • Or when you just want something quicker and easier than using the AEM web UI to upload a package

Using the script is as simple as:

  • Downloading the script from GitHub
  • Making it executable
  • Putting it in your system path

Once you have the script installed, you can use it as shown in the following examples:

List Packages

Lists all of the packages in the my_packages group.

danklco@EDS-Klco-MAC ~> aem-pkmgr list -g my_packages
AVAILABLE PACKAGES
ForLocalContent_062216
Description:
Version:
Group: my_packages
Path: /etc/packages/my_packages/ForLocalContent_062216.zip
TagsForLocal_071416
Description:
Version:
Group: my_packages
Path: /etc/packages/my_packages/TagsForLocal_071416.zip
tes
Description:
Version: tes
Group: my_packages
Path: /etc/packages/my_packages/tes-tes.zip

Download Package

Downloads the package /etc/packages/my_packages/TagsForLocal_071416.zip.

danklco@EDS-Klco-MAC ~> aem-pkmgr download -pk /etc/packages/my_packages/TagsForLocal_071416.zip
DOWNLOADING PACKAGE /etc/packages/my_packages/TagsForLocal_071416.zip...
 % Total % Received % Xferd Average Speed Time Time Time Current
 Dload Upload Total Spent Left Speed
100 41.3M 100 41.3M 0 0 140M 0 --:--:-- --:--:-- --:--:-- 140M

Upload / Install Package

Uploads and installs the package TagsForLocal_071416.zip.

danklco@EDS-Klco-MAC ~> aem-pkmgr upload-install -pk TagsForLocal_071416.zip
UPLOADING PACKAGE TagsForLocal_071416.zip...
<crx version="1.2.2" user="admin" workspace="crx.default">
 <request>
 <param name="file" value="TagsForLocal_071416.zip"/>
 <param name="force" value="true"/>
 <param name="install" value="true"/>
 </request>
 <response>
 <data>
 <package>
 <group>my_packages</group>
 <name>TagsForLocal_071416</name>
 <version></version>
 <downloadName>TagsForLocal_071416.zip</downloadName>
 <size>43330621</size>
 <created>Wed, 20 Jul 2016 12:41:05 -0500</created>
 <createdBy>admin</createdBy>
 <lastModified>Wed, 20 Jul 2016 12:40:26 -0500</lastModified>
 <lastModifiedBy>admin</lastModifiedBy>
 <lastUnpacked>Wed, 20 Jul 2016 15:33:04 -0500</lastUnpacked>
 <lastUnpackedBy>admin</lastUnpackedBy>
 </package>
 <log>
Installing content...
Collecting import information...
Installing node types...
- rep -&gt; internal
- mix -&gt; http://www.jcp.org/jcr/mix/1.0
- nt -&gt; http://www.jcp.org/jcr/nt/1.0
- sling -&gt; http://sling.apache.org/jcr/sling/1.0
- cq -&gt; http://www.day.com/jcr/cq/1.0
- sling:Folder
- sling:Redirect
- sling:Resource
- cq:ReplicationStatus
- cq:Tag
- rep:RepoAccessControllable
Installing privileges...
Importing content...
- /
- /etc
- /etc/tags
[... trim ...]
saving approx 0 nodes...
Package imported.
Package installed in 55497ms.
 </log>
 </data>
 <status code="200">ok</status>
 </response>
</crx>

Hopefully, this helps you manage AEM packages via the command line. You can find more detailed usage documentation on the GitHub site.
If you have any questions or you’d like to see something added, leave a comment here or create an issue.

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Dan Klco, Adobe Digital Marketing Technical Director

Dan is a certified Adobe Digital Marketing Technologist, Architect, and Advisor, having led multiple successful digital marketing programs on the Adobe Experience Cloud. He's passionate about solving complex problems and building innovative digital marketing solutions. Dan is a PMC Member of the Apache Sling project, frequent Adobe Beta participant and committer to ACS AEM Commons, allowing a unique insight into the cutting edge of the Adobe Experience Cloud platform.

More from this Author

Subscribe to the Weekly Blog Digest:

Sign Up
Follow Us
TwitterLinkedinFacebookYoutubeInstagram