CITYTECH, Inc.

The CQ5 Groovy Console provides an interface for running Groovy scripts within the CQ5 container. Scripts can be created to manipulate content in the JCR, call OSGi services, or perform arbitrary tasks using the available APIs.

• CQ 5.4 or 5.5 running on localhost:4502
• Maven 2.x+
• cURL for automated deployment (optional)

1. Download the latest release from GitHub.

2. Install package via CQ5 Package Manager.

3. Verify the installation by navigating to /etc/groovyconsole.html on the target CQ5 instance.

OR

1. Install the console package (NOTE: if cURL is not installed, the package can be uploaded manually via Package Manager)

   a. If you already have the Groovy bundle installed in the Felix container:

   mvn install -P local-author
   

   b. If you do not have the Groovy bundle installed:

   mvn install -P install-groovy,local-author
   

   NOTE: if you are running CQ 5.4, add the profile 'cq5.4' to the above Maven commands to resolve the correct dependencies.

   mvn install -P cq5.4,local-author
   

2. Verify the installation.

Additional build profiles may be added in the project's pom.xml to support deployment to non-localhost CQ5 servers.

Sample code:

getPage('/content/geometrixx').recurse { page ->
    println "${page.title} - ${page.path}"
}

Additional sample scripts can be found in src/main/scripts.

Please contact Mark Daugherty with any questions.

Follows Semantic Versioning guidelines.

Copyright 2012 CITYTECH, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.