2.1 Configure

The qaskx-cli has three important configuration directories and files, named:

  • “.qaskx” located in your home root directory and is a directory containing global setting files
  • “qaskx-config.yaml” located in your projects “.well-known” directory
  • “devops.json” located in your projects “.well-known” directory. This is not strictly a qaskx-cli file as it is related to rediOps

The good news is that qaskx-cli can help in setting up the configuration files, minimizing your effort.

Let’s get started on setup for you.

Inside a local project

Open up a terminal window of the root folder of a project.

Running the command qaskx-cli setup init will create a directory named .qaskx in your home directory if one does not exist. The folder will contain a global configuration file named dotqaskx-config.json

If the project is under Git control then the command will create a new folder (if it does not exist) named “.well-known” and create file “qaskx-config.yaml” within this directory.

You will be prompted to set some initial values. You can edit the values in the files manually if you so wish but please do so with care and understanding of the field purpose and acceptable values.

qaskx-cli setup init

If the project is not under Git control (not recommended) then use the following command. The command will create a new folder (if it does not exist) named “.well-known” and create file “qaskx-config.yml” within this directory.

You will be prompted for initial values to be set.

qaskx-cli setup init -c .well.known

The last step is to create devops.json file that represents the rediOps schema. Execute the following command, which will create a “devops.json” file in the “.well-known” directory.

qaskx-cli rediops new

To verify that the “devops.json” file contains correct data, you can execute the following commands one by one.

qaskx-cli rediops get -s base
qaskx-cli rediops get -s repository

To get more values into the devops.json file, then consider using the migrate command.
The “setup migrate” and “rediops migrate” command are explained in the next section.

No local project

If you have no project, please clone a project to get started.

Future projects

When you create or clone a future project which has no qaskx-cli configuration file you would repeat the above command.

Outcome

After running the configure setup command you will have a configuration file.

By itself this is not useful and will have few benefits until sections of the devops.json file are supplied with values.

Have a look at the current contents of the configuration file using your favourite IDE.

The tutorial chapter gives you some ideas of what is possible and you can change the values to suit your situation.

The next step of migrate could help you migrate settings.