AEM Bulk Package Installer

A powerful Visual Studio Code extension designed for AEM (Adobe Experience Manager) developers. It allows you to select one or multiple AEM packages (.zip) or OSGi bundles (.jar) directly from the VS Code File Explorer and easily upload, install, or backup them to your local AEM server, or select paths in any active editor to create, build, and replicate packages on demand.

Features

• Upload & Install Packages: Quickly deploy multiple .zip packages to AEM without leaving VS Code.
• Install OSGi Bundles: Deploys .jar bundles directly via the AEM OSGi Console.
• Replicate Packages & Bundles: Trigger replication of packages directly from Author to Publish, or deploy OSGi bundles directly to your Publish instance.
• Install & Replicate (Combo Action): A combined action to install packages/bundles on the Author instance and simultaneously replicate them to the Publish instance.
• Create & Build Packages from Editor: Select a list of JCR paths (one per line) in any active editor and right-click to instantly create, build, or replicate custom AEM content packages on your target environments.
• Backup Packages: Modify properties to append a -backup version, re-build it on the AEM server, and download the current state into your local workspace.
• Multi-Environment Support: Configure multiple AEM environments (e.g. local, dev, stage, prod) and easily select the target environment during deployments.
• Production Safeguard: Mark environments as production (isProd: true) to require an explicit confirmation modal before performing any actions.
• Bulk Operations: Select multiple files in your workspace and trigger actions for all of them at once. Visual progress notification tracks the success or failure of each file.

Before You Start

Make sure your AEM environments are set up properly.

1. Go to VS Code Settings (Ctrl+, or Cmd+,).
2. Search for AEM Bulk Installer.
3. Configure your AEM environments under Aem Bulk Installer: Environments.
   • By default, a single environment named local is configured pointing to http://localhost:4502 (Author) and http://localhost:4503 (Publish).
   • You can add, edit, rename, or remove environments from the Settings editor.
   • Each environment includes:
     • Name: The display name of the environment (e.g. local, dev, stage, prod).
     • Is Prod: Check this box to mark the environment as production. This triggers a confirmation dialog before any deployment action.
     • Author Config: AEM Author instance connection details (url, port, username, password).
     • Publish Config: AEM Publish instance connection details (url, port, username, password).

Step-by-Step Usage

1. Open your code project in VS Code that contains your compiled .zip Content Packages or .jar OSGi bundles.
2. Open the VS Code File Explorer view.
3. Locate the files you want to deploy.
4. Select File(s):
   • Left-click a single file.
   • For bulk operations, hold down Ctrl (or Cmd on Mac) and click on multiple .zip or .jar files.
5. Right-Click any of the selected files to open the context menu.
6. Look for the AEM group at the bottom of the menu and choose one of the available commands:
   • AEM: Upload file(s): Only uploads the package to the AEM Author Package Manager (doesn't install).
   • AEM: Install file(s): Uploads and immediately installs the package or OSGi bundle on the AEM Author instance.
   • AEM: Backup package(s): Creates a backup clone from AEM (available for .zip files only).
   • AEM: Replicate file(s): Uploads and replicates packages from Author to Publish (.zip), or installs OSGi bundles directly to the Publish instance (.jar).
   • AEM: Install + Replicate file(s): Uploads, installs, and replicates packages on both Author and Publish (.zip), or installs OSGi bundles on both Author and Publish instances (.jar).
7. Select Target Environment: If multiple AEM environments are configured, you will be prompted to select the target environment via a QuickPick list. If the selected environment is marked as production (isProd: true), a modal confirmation prompt will appear asking for confirmation before any action is performed.
8. Look at the bottom right corner of VS Code to see a native Progress Notification window indicating the status of the operation for each file.

Creating Packages from Editor Selection

1. Open any text file or code file containing AEM JCR paths listed one per line (e.g., /content/wknd, /content/dam/wknd).
2. Select the paths you want to include in your package.
3. Right-click the selected text to open the editor context menu.
4. Choose one of the available commands:
   • AEM: Create Package: Creates the package container on the Author instance and updates its filters with the selected paths.
   • AEM: Create + Build Package: Creates the package, updates the filters, and runs a build.
   • AEM: Create + Build + Replicate Package: Creates the package, updates the filters, builds it, and replicates it to the Publish instance.
5. Complete the input prompts when prompted:
   • Package Name: The name of the package.
   • Category (Group): The group name (defaults to my_packages).
   • Version: The package version (defaults to 1.0.0).
6. Select your target AEM environment to execute the actions.

Requirements

• VS Code 1.80.0 or higher.
• A running local AEM instance (AEM 6.5+ or AEM as a Cloud Service SDK) reachable by your system.

Installation

You can install the AEM Bulk Package Installer extension through any of the following methods:

1. From the Marketplace (Recommended)

Get the extension from the official extension marketplaces:

2. Manual Installation (.vsix)

You can download the compiled .vsix package of the latest release and install it manually:

1. Download the latest .vsix file from the GitHub Releases page.
2. Open VS Code, open the Extensions view (Ctrl+Shift+X or Cmd+Shift+X).
3. Click on the ... (Views and More Actions) menu in the top-right corner of the Extensions view.
4. Select Install from VSIX... and choose the downloaded file.

3. Build from Source

If you prefer to build the extension from source, follow these steps:

1. Clone the repository:

   git clone https://github.com/akio333/aem-bulk-pkg-install.git
   cd aem-bulk-pkg-install
   

2. Install dependencies:

   npm install
   

3. Package the extension:

   npm run package
   

   This will compile the TypeScript source, bundle the code with esbuild, and generate a .vsix file (e.g., aem-bulk-pkg-install-X.Y.Z.vsix) in the project root directory.

4. Install the generated .vsix: Install the generated .vsix file into your VS Code environment via the Install from VSIX... option.

License

This extension is licensed under the terms described in the LICENSE file.