aem Command Line Reference

Installation

$ npm install -g @adobe/aem-cli

Usage

$ aem --help

Help output:

Usage: aem <command> [options]

Commands:
  aem up      Run a AEM development server
  aem import  Run the AEM import server

Options:
  --version                Show version number                         [boolean]
  --log-file, --logFile    Log file (use "-" for stdout)  [array] [default: "-"]
  --log-level, --logLevel  Log level
  [string] [choices: "silly", "debug", "verbose", "info", "warn", "error"] [default: "info"]
  --help                   Show help                                   [boolean]

use <command> --help to get command specific details.

for more information, find our manual at https://github.com/adobe/helix-cli

Available Commands

• up
• import

up

Server Options

• --port
  Start development server on port
  Default: 3000
• --addr
  Bind development server on address. Use * to bind to any address and allow external connections.
  Default: "127.0.0.1"
• --stop-other, --stopOther
  Stop other AEM CLI running on the above port
  Default: true
• --tls-cert, --tlsCert
  File location for your .pem file for local TLS support
• --tls-key, --tlsKey
  File location for your .key file for local TLS support

AEM Options

• --url, --pagesUrl, --pages-url
  The origin URL to fetch content from.
• --livereload
  Enable automatic reloading of modified sources in the browser.
  Default: true
• --no-livereload, --noLiveReload
  Disable live-reload
• --open
  Open a browser window at specified path
  Default: "/"
• --no-open, --noOpen
  Disable automatic opening of browser window
• --print-index, --printIndex
  Prints the indexed records for the current page.
  Default: false
• --cache
• --forward-browser-logs, -–forwardBrowserLogs
  Forward browser console logs to terminal
  Default: false

Options

• --version
  Show version number
  Default: boolean
• --log-file, --logFile
  Log file (use "-" for stdout)
  Default: "-"
• --log-level, --logLevel
  Log level
  Choices: "silly", "debug", "verbose", "info", "warn", "error"
  Default: "info"
• --site-token, --siteToken
  Site token to be used by the cli to access the website
• --alpha-cache, --alphaCache
  Path to local folder to cache the responses (alpha feature, may be removed without notice)
• --allow-insecure, --allowInsecure
  Whether to allow insecure requests to the server
  Default: false
• --cookies
  Proxy all cookies in requests. By default, only the hlx-auth-token cookie is proxied.
  Default: false
• --html-folder, --htmlFolder
  Serve HTML files from this folder without extensions (e.g., /folder/file serves folder/file.html or folder/file.plain.html) use this to preview content changes if you do not have access to the authoring system. Can be helpful for Developing with AI Tools
• --help
  Show help
  Default: boolean

import

Server Options

• --port
  Start import server on port
  Default: 3001
• --addr
  Bind import server on address. Use * to bind to any address and allow external connections.
  Default: "127.0.0.1"
• --stop-other, --stopOther
  Stop other AEM CLI running on the above port
  Default: true
• --tls-cert, --tlsCert
  File location for your .pem file for local TLS support
• --tls-key, --tlsKey
  File location for your .key file for local TLS support

AEM Importer Options

• --open
  Open a browser window at specified path
  Default: "/tools/importer/helix-importer-ui/index.html"
• --no-open, --noOpen
  Disable automatic opening of browser window
• --cache
  Path to local folder to cache the responses
• --ui-repo, --uiRepo
  Git repository for the AEM Importer UI. A fragment may indicate a branch other than main.
  Default: "https://github.com/adobe/helix-importer-ui"
• --skip-ui, --skipUI
  Do not install the AEM Importer UI
  Default: false
• --headers-file, --headersFile
  Location of a custom .json file containing headers to be used with all proxy requests

Options

• --version
  Show version number
  Default: boolean
• --log-file, --logFile
  Log file (use "-" for stdout)
  Default: "-"
• --log-level, --logLevel
  Log level
  Choices: "silly", "debug", "verbose", "info", "warn", "error"
  Default: "info"
• --dump-headers, --dumpHeaders
  Dump request headers to console for debugging
  Default: false
• --allow-insecure, --allowInsecure
  Whether to allow insecure requests to the server
  Default: true
• --help
  Show help
  Default: boolean