Installation

Linux / macOS

You can install it using Homebrew:

brew tap lgdd/homebrew-tap
brew install lfr-cli

if you already installed it using brew install liferay-cli, make sure to run brew update to be able to update to the latest version matching the new name.

Windows

For Windows, go to the release page and download the zip file corresponding to your architecture. Then extract lfr.exe from the archive and move to the folder of your choice. Make sure that the chosen folder is included in the %PATH% environment variable.

Support for Scoop and Chocolately are on the roadmap.

Completions

lfr completion [bash|zsh|fish|powershell]

To load completions for Bash, Zsh, fish and PowerShell:

Bash:

source <(lfr completion bash)
# To load completions for each session, execute once:
# Linux:
lfr completion bash > /etc/bash_completion.d/lfr
# macOS:
lfr completion bash > /usr/local/etc/bash_completion.d/lfr

Zsh:

# If shell completion is not already enabled in your environment,
# you will need to enable it.  You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrc
# To load completions for each session, execute once:
lfr completion zsh > "${fpath[1]}/_lfr"
# You will need to start a new shell for this setup to take effect.

fish:

lfr completion fish | source
# To load completions for each session, execute once:
lfr completion fish > ~/.config/fish/completions/lfr.fish

PowerShell:

lfr completion powershell | Out-String | Invoke-Expression
# To load completions for every new session, run:
lfr completion powershell > lfr.ps1
# and source this file from your PowerShell profile.