https://github.com/iq2i/aergie

An easy alternative to makefile
https://github.com/iq2i/aergie

cli development go makefile

Last synced: about 2 months ago
JSON representation

An easy alternative to makefile

• Host: GitHub
• URL: https://github.com/iq2i/aergie
• Owner: IQ2i
• License: mit
• Created: 2020-09-30T06:50:47.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-02-25T10:26:31.000Z (almost 2 years ago)
• Last Synced: 2024-11-05T23:12:58.391Z (3 months ago)
• Topics: cli, development, go, makefile
• Language: Go
• Homepage:
• Size: 125 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


[![Continuous Integration](https://github.com/IQ2i/aergie/workflows/Continuous%20Integration/badge.svg?branch=master)](https://github.com/IQ2i/aergie/actions)

[![Go Report Card](https://goreportcard.com/badge/github.com/IQ2i/aergie)](https://goreportcard.com/report/github.com/IQ2i/aergie)

# Installation

Run the following installer to download the Aergie binary:

## Linux

```bash

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

```

## macOS

```bash

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:

```bash

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:

```bash

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:

```yaml

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:

```yaml

variables:

    php: docker exec -it php_container_name

commands:

    install:

        help: Install my application

        steps:

            - ${php} composer install

```