Aqua Template CLI

Automatically generates a project template of the specified language/technology.

---

Index

• Dependencies
• Installation
• How to Use
  • Basic usage
  • Help
  • Display languages
• Custom templates
  • Customizing a template
  • Adding a template

---

Dependencies

• Ubuntu
• C++17
• G++
• Make

---

Installation

In this root directory, compile the project with the make command:

$ make

Then, install it (make it useable from anywhere as a command):

$ sudo make install

If you wish to change the installation locations and/or the command name, modify the PREFIX and TARGET variables in Makefile.

Finally, to add auto-completion to the aqua-template command, run the bash script:

$ source ./scripts/add_completion.sh

or, simply:

$ . ./scripts/add_completion.sh

---

How to Use

This tool can be called with some command line arguments as:

Basic usage

For generating a project, simply type:

$ aqua-template

You'll be asked for the project name and its language/technology.

Alternatively, you can pass those info by arguments:

$ aqua-template -n <project-name> -l <language>

or

$ aqua-template --name=<project-name> --language=<language>

Example:

$ aqua-template -n "Hello World Project" --language=cpp

Help

In order to display help about the tool and all arguments type:

$ aqua-template -h

or

$ aqua-template --help

Display languages

To display all template languages/technologies available for generation type:

$ aqua-template -d

or

$ aqua-template --display

---

Custom templates

In order to customize or add templates, navigate into the template's save path: /usr/local/etc/aqua-template/templates

Customizing a template

To customize a template, simply modify the base project of the language/technology in the save path.

Adding a template

Simply add your language/technology template root directory to the save path. Then, when you use the command aqua-template, the added template will be available for generation.