Installation

Run the following installer to download the Aergie binary:

Linux

wget https://raw.githubusercontent.com/IQ2i/aergie/master/install -O - | bash

macOS

curl -sS https://raw.githubusercontent.com/IQ2i/aergie/master/install | bash

Autocomplete

Aergie provide a completion tool to facilitate its use.

bash

First, ensure that you install bash-completion using your package manager.

Then, run the following command:

ae completion bash > /etc/bash_completion.d/ae

zsh

To use zsh completion, you must enable it in your configuration by adding this line:

autoload -Uz compinit && compinit

Then, run the following command:

ae completion zsh > "${fpath[1]}/_ae"

How to use Aergie

The first thing to do is to create a file at the root of your project. The file can have several possible names:

• .aergie.yml
• .aergie.yaml

Then you just need to declare two blocks:

commands (require)

This is where you can declare the different commands that allow you to work on your project.
A command is form with:

	Description	Example (see example below)
name	This is the key of the command element	start
help	Sentence to describe what the command does	help: Start docker compose
steps	An array with each action to be carried out	steps: [docker-compose up -d]

Example:

commands:
    start:
        help: Start docker compose
        steps:
            - docker-compose up -d

    stop:
        help: Stop docker compose
        steps:
            - docker-compose stop

    install:
        help: Install my application
        steps:
            - ${php} composer install
            - ...

variables (optional)

You can declare variables to use in your steps:

variables:
    php: docker exec -it php_container_name

commands:
    install:
        help: Install my application
        steps:
            - ${php} composer install