Installation

Linux / macOS

You can install it using Homebrew:

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

If you previously installed it via brew install lfr-cli (formula) or brew install liferay-cli, run brew uninstall lfr-cli then brew install --cask lfr-cli to migrate to the new cask.

Windows

You can install it using Winget:

winget install lgdd.lfr-cli

Alternatively, go to the release page and download the .exe file corresponding to your architecture, then move it to the folder of your choice. Make sure that the chosen folder is included in the %PATH% environment variable.

Prior to v3.3.1, the release page provided .zip archives instead of .exe files.

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.