Appearance

Hubtel AQUA ​

AQUA is a powerful command-line interface (CLI) tool designed to streamline development workflows. It provides a variety of utilities to support both frontend and backend developers, making it easier to set up projects, install templates, manage repositories and run various applications

Features: ​

  • Frontend:
    • Scaffold Next.js and Nuxt.js projects.
  • Backend:
    • Install .NET templates for backend development.
  • Applications:
    • Quick access to various applications (PS-Simulator, DevDocs and CCI Portal)
  • Repository Management:
    • Create repositories directly from the CLI.

Before Installation ​

You will need to create an .npmrc file in your root directory(/home/your-username/) with the necessary credentials in order to install the package. Follow the documentation on setting up credential to access internal packages here. Skip this step if you have already done so.

Installation ​

Open your terminal and run the following command to install the package globally:

bash
npm install -g @hubtel/aqua-cli

Usage ​

To use, you will be first prompted to login using a unique code provided by Microsoft after which the cli will be launched. AQUA can be used in both interactive and non-interactive modes to cater to different developer preferences.

Interactive Mode ​

In interactive mode, AQUA will prompt you through the necessary steps to create projects or repositories. You can easily make selections without needing to specify all arguments upfront.

To use interactive mode, simply run the following command:

bash
aqua

AQUA will prompt you with various choices based on the action you're performing, such as selecting options or confirming configurations.

Non-Interactive Mode ​

In non-interactive mode, you specify all necessary options directly in the command, making it ideal for automation or batch operations. Below are the list of commands and the corresponding actions:

Creating a new frontend project ​

To create a new project with the CLI tool, use the following command:

bash
aqua new-frontend-project --framework [projectname]

Arguments:

  • projectname: Specify the name for your new project.

Options:

  • --next: Use the Next.js framework for the project.
  • --nuxt: Use the Nuxt.js framework for the project.

Example:
Creating a new project named my-app using the Next.js framework and the default template:

bash
aqua new-frontend-project --next my-app

Install dotnet Templates ​

To install dotnet templates:

bash
aqua install-dotnet-template --template=[templateName] --version[version]

Options:

  • [templateName]:
    The name of the template you want to install. The available options are: Api, KafkaHost, UnitTests, ProgrammableServicesBasic, BackgroundJob

  • [version]:
    Specify the version of the template you want to install. The available versions are: 3.1, 6.0 and 8.0

Creating Repositories ​

Repository creation is performed in interactive mode. Run the following command:

aqua
  • Select the "Repositories & Pipelines" option
  • Then select the type of repository you would like to create
  • Follow the prompts and select the appropriate Reveiwer and Permission groups to complete the creation of the repository