Cord Tools CLI

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

Install

npm install -g @cord-tools/cord-cli

Commands

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

cord login

login to Cord Tools

Usage: 
  cord login|l [options]

Options:
  -h, --hostname [hostname]         e.g. https://app.cord.tools
  -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

cord configure

set defaults for the cli tool

Usage: 
  cord configure|config [options]

Options:
  --hostname [hostname]             e.g. https://app.cord.tools
  -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

cord clone

clone a cord environment to your machine

Usage: 
  cord clone [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

cord init

create a configuration file (cord.yml)

Usage: 
  cord 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

cord start

start an AEM environment

Usage: 
  cord 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

cord up

start aem author and publish

Usage: 
  cord 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

cord down

stop the running AEM environment

Usage: 
  cord 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

cord status

status of environments

Usage: 
  cord 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

cord environment

interface with AEM environments

Usage: 
  cord 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

cord environment list

list AEM environments

Usage: 
  cord environment list [options]

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

cord environment delete

delete the specified environment

Usage: 
  cord environment delete [options] [environment]

Arguments:
  environment                       name of environment

Options:
  -c, --context [path/to/aem/project]path to directory with a configuration 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

cord environments

list AEM environments

Usage: 
  cord environments [options]

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

cord version

interface with available AEM versions

Usage: 
  cord 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

cord version list

list available AEM versions

Usage: 
  cord 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

cord log

interact with AEM logs

Usage: 
  cord 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

cord log list

list available log files

Usage: 
  cord 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

cord log view

prints the log

Usage: 
  cord 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

cord packages

list packages

Usage: 
  cord 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

cord package

interface with AEM packages

Usage: 
  cord 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

cord package list

list packages

Usage: 
  cord 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

cord package update

download latest packages and install into running instances

Usage: 
  cord 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

cord build

build current project and install

Usage: 
  cord 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

cord ci

execute a project pipeline under .cord/pipelines

Usage: 
  cord ci [options] [pipeline]

Arguments:
  pipeline                          pipeline file to run under `.cord/pipelines`

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

cord sync

sync with jcr

Usage: 
  cord 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

cord sync start

start jcr/filesystem bidirectional sync

Usage: 
  cord 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

cord sync stop

stop jcr/filesystem bidirectional sync

Usage: 
  cord sync stop [options] [environment]

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