liferay-cli

Liferay CLI

Liferay CLI - lfr - is an unofficial tool written in Go that helps you create & manage Liferay projects.

Why?

I needed a subject to play with Go. Writing a CLI tool is fun - especially with Cobra - and I wanted to explore how to distribute it using GitHub Actions (and GoReleaser).

Also, I get sometimes frustrated by Blade and wanted to focus on providing:

• Better performances (cf. benchmarks)
• Better support for Maven
• Shorter commands
• More consistent commands names and ordering
• Details after any command execution
• Shell completion

Getting Started

Checkout the release page to download the binary for your distribution.

Examples:

Get a completion script for your shell:

lfr completion bash

bash, zsh, fish and powershell are supported.

Run a diagnosis:

lfr diagnose
# or shorter
lfr diag

The output of this command will list your installations of Java, Blade and Docker. It will also display how much space are being used by cached bundles and docker images.

Create a Liferay workspace:

lfr create workspace liferay-workspace
# or shorter
lfr create ws liferay-workspace
# or even shoter
lfr c ws liferay-workspace

Create a client extension:

lfr create client-extension
# or shorter
lfr create cx
# or event shorter
lfr c cx

Since client extensions are available as samples in liferay-portal repo, it will checkout the subdirectory containing them under $HOME/.lfr/liferay-portal.

Run a Gradle or Maven task:

lfr exec [tasks...]

# Gradle example
lfr exec build

# Maven example
lfr exec clean install

Shortcuts for common tasks:

# Build
lfr build
#or shorter
lfr b

# Deploy
lfr deploy
# or shorter
lfr d

Start Liferay and follow the logs:

lfr start
lfr logs -f

Benchmarks

Using Hyperfine.

Create Workspace

Create MVC Portlet

Create Service Builder

License

MIT