# Getting started with aux4

## What's aux4?

_aux4_ is a CLI (Command-line Interface) generator, used to create high-level scripts and automate your daily tasks.

## Install

```bash
> curl https://aux4.sh | sh
```

## IDEs

Add support for _aux4_ in your favorite IDE.

### Visual Studio Code

- [aux4 Visual Studio Code Extension](https://marketplace.visualstudio.com/items?itemName=aux4.aux4)

### Vim/Neovim

- [aux4 Vim Plugin](https://github.com/aux4/vim)

## How to use

_aux4_ is a command-line interface generator tool designed to be extremely simple to learn and use.
It requires creating a `.aux4` file using JSON format. It all starts from the `profiles` array.

```json
{
  "profiles": [
    ...
  ]
}
```

Each `profile` has a _name_ and a _list of commands_. But the most important profile is the _main_ one.

```json
{
  "profiles": [
    {
      "name": "main",
      "commands": [
        ...
      ]
    }
  ]
}
```

The `command` is defined by its _name_, followed by a _sequence of command-line instructions_ that will be executed, and a _help section with its documentation_.

```json
{
  "profiles": [
    {
      "name": "main",
      "commands": [
        {
          "name": "<COMMAND NAME>"
          "execute": [
            "<FIRST COMMAND-LINE INSTRUCTION>",
            "<SECOND COMMAND-LINE INSTRUCTION>",
            "..."
          ],
          "help": {
            "text": "<DESCRIPTION OF THE COMMAND>"
          }
        }
      ]
    }
  ]
}
```