AEM Cloud CLI

Command line tool for working with AEM Cloud. Primarily used to start and stop AEM instances based on an aemcloud.yml file within a project.

Install

npm install -g @aemcloud/aemcloud-cli

Commands

• aemcloud login
• aemcloud configure
• aemcloud init
• aemcloud start
• aemcloud up
• aemcloud down
• aemcloud status
• aemcloud environment
• aemcloud environment list
• aemcloud environment delete
• aemcloud environments
• aemcloud version
• aemcloud version list
• aemcloud log
• aemcloud log list
• aemcloud log view
• aemcloud packages
• aemcloud package
• aemcloud package list
• aemcloud package update
• aemcloud build
• aemcloud ci
• aemcloud sync
• aemcloud sync start
• aemcloud sync stop

aemcloud login

login to AEM Cloud

Usage: 
  aemcloud login|l [options]

Options:
  -h, --hostname [hostname]         e.g. https://app.aem.cloud
  -a, --account [account]           e.g. hoodoo

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud configure

set defaults for the cli tool

Usage: 
  aemcloud configure|config [options]

Options:
  --hostname [hostname]             e.g. https://app.aem.cloud
  -a, --account [account]           e.g. hoodoo

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud init

create an aemcloud.yml file

Usage: 
  aemcloud init|i [options]

Options:
  -a, --account [account]           e.g. hoodoo

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud start

start an AEM environment

Usage: 
  aemcloud start [options] [environment]

Arguments:
  environment                       name of environment

Options:
  -a, --account <account>           e.g. hoodoo
  -A, --author <toggle>             toggle author instance e.g. true|false|on|off|1|0
  -p, --publish <toggle>            toggle publish instance e.g. true|false|on|off|1|0
  -d, --dispatcher <toggle>         toggle dispatcher e.g. true|false|on|off|1|0
  --aem-version <version>           specify aem version e.g. 6.4.0
  -s, --sample-content <toggle>     toggle sample_content e.g. true|false|on|off|1|0
  -P, --packages <packages>         specify a list of packages delimited by commas
  -S, --sync-root <path>            path to pom.xml
  -i, --image <image>               build image e.g. maven:3-5-jdk-8
  --script <commands>               specify one or more build commands delimited by semicolons
  --artifact-path <path>            specify build artifact output path
  --persistent <toggle>             toggle to persist AEM environment content. Defaults to true. e.g. true|false|on|off|1|0
  --skip-build-scripts              Skip build scripts defined in the config

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud up

start aem author and publish

Usage: 
  aemcloud up|u [options] [environment]

Arguments:
  environment                       name of environment

Options:
  -o, --output [log file]           path to build output log file
  -a, --account <account>           e.g. hoodoo
  -A, --author <toggle>             toggle author instance e.g. true|false|on|off|1|0
  -p, --publish <toggle>            toggle publish instance e.g. true|false|on|off|1|0
  -d, --dispatcher <toggle>         toggle dispatcher e.g. true|false|on|off|1|0
  --aem-version <version>           specify aem version e.g. 6.4.0
  -s, --sample-content <toggle>     toggle sample_content e.g. true|false|on|off|1|0
  -P, --packages <packages>         specify a list of packages delimited by commas
  -S, --sync-root <path>            path to pom.xml
  -i, --image <image>               build image e.g. maven:3-5-jdk-8
  --script <commands>               specify one or more build commands delimited by semicolons
  --artifact-path <path>            specify build artifact output path
  --persistent <toggle>             toggle to persist AEM environment content. Defaults to true. e.g. true|false|on|off|1|0
  --skip-build-scripts              Skip build scripts defined in the config

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud down

stop the running AEM environment

Usage: 
  aemcloud down|stop [options]

Options:
  -d, --delete remove persistent environment content from disk

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud status

status of environments

Usage: 
  aemcloud status|s [options] [environment]

Arguments:
  environment                       name of environment

Options:
  --wait                            Wait until the environments start

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud environment

interface with AEM environments

Usage: 
  aemcloud environment|env [options] [command]

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

Commands:
  list                              list AEM environments
  delete [options] [environment]    delete the specified environment
  help [command]                    display help for command

aemcloud environment list

list AEM environments

Usage: 
  aemcloud environment list [options]

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud environment delete

delete the specified environment

Usage: 
  aemcloud environment delete [options] [environment]

Arguments:
  environment                       name of environment

Options:
  -c, --context [path/to/aem/project]path to directory with aemcloud.yml file
  -a, --all                         remove AEM content for all environments in this directory

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud environments

list AEM environments

Usage: 
  aemcloud environments [options]

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud version

interface with available AEM versions

Usage: 
  aemcloud version|versions [options] [command]

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

Commands:
  list [options]                    list available AEM versions
  help [command]                    display help for command

aemcloud version list

list available AEM versions

Usage: 
  aemcloud version list [options]

Options:
  -a, --account [account]           e.g. hoodoo

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud log

interact with AEM logs

Usage: 
  aemcloud log|logs [options] [command]

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

Commands:
  list [options]                    list available log files
  view [options] [log_path]         prints the log
  help [command]                    display help for command

aemcloud log list

list available log files

Usage: 
  aemcloud log list [options]

Options:
  -i, --instance <author|publish>   AEM instance e.g. author
  -a, --account [account]           the account the remote environment is in. e.g. hoodoo
  -e, --environment [environment]   the name of the remote environment. e.g. build-12345678
  --remote                          list possible logs for a remote environment

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud log view

prints the log

Usage: 
  aemcloud log view [options] [log_path]

Arguments:
  log_path                          path to log file to view, defaults to /crx-quickstart/logs/error.log

Options:
  -i, --instance <author|publish>   AEM instance e.g. author
  -f, --follow                      follow the log file
  -n, --number <line_count>         number of lines
  -a, --account [account]           the account the remote environment is in. e.g. hoodoo
  -e, --environment [environment]   the name of the remote environment. e.g. build-12345678
  --remote                          list possible logs for a remote environment

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud packages

list packages

Usage: 
  aemcloud packages [options]

Options:
  -b, --build-packages              show build packages instead of user packages
  -a, --account [account]           e.g. hoodoo

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud package

interface with AEM packages

Usage: 
  aemcloud package [options] [command]

Options:
  -a, --account [account]           e.g. hoodoo
  -b, --build-packages              show build packages instead of user packages

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

Commands:
  list [options]                    list packages
  update [options]                  download latest packages and install into running instances
  help [command]                    display help for command

aemcloud package list

list packages

Usage: 
  aemcloud package list [options]

Options:
  -b, --build-packages              show build packages instead of user packages
  -a, --account [account]           e.g. hoodoo

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud package update

download latest packages and install into running instances

Usage: 
  aemcloud package update [options]

Options:
  -r, --running [environment]       name of running environment to update
  -n, --new [environment]           name of environment in config to pull package list from
  -a, --account [account]           e.g. hoodoo

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud build

build current project and install

Usage: 
  aemcloud build [options] [environment]

Arguments:
  environment                       name of environment

Options:
  -o, --output [log file]           path to build output log file

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud ci

execute current project pipeline

Usage: 
  aemcloud ci [options]

Options:
  -o, --output [log file]           path to build output log file
  --only [step]                     run only specified step
  --skip [step]                     skip specified step

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud sync

sync with jcr

Usage: 
  aemcloud sync [options] [command]

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

Commands:
  start [environment]               start jcr/filesystem bidirectional sync
  stop [environment]                stop jcr/filesystem bidirectional sync
  help [command]                    display help for command

aemcloud sync start

start jcr/filesystem bidirectional sync

Usage: 
  aemcloud sync start [options] [environment]

Arguments:
  environment                       name of environment

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command

aemcloud sync stop

stop jcr/filesystem bidirectional sync

Usage: 
  aemcloud sync stop [options] [environment]

Global Options:
  -V, --version                     output the version number
  -v, --verbose                     output debug information
  -h, --help                        display help for command