Qaskx Cmd Config

The qaskx-config.json file is the local configuration file for qaskx-cli. It contains configuration options for you environment including your organisation details and the location of templates and policies.

A typical configuration file looks like the below:

{
    "GitProvider": "gitea",
    "GitHost": "https://tea.merebox.com",
    "GitApi": "https://tea.merebox.com/api/v1",
    "GitOrg": "Cupboard",
    "GitRepoUser": "jadams",
    "GitBranch": "main",
    "GitUserEmail": "j.adams@example.com",
    "TemplateHost": "https://tea.merebox.com/qaskx/qaskx.template.git",
    "TemplateFolder": "~\\Projects.shared\\qaskgo.template",
    "TemplateName": "base",
    "TemplateLocalStorage": "~\\.qaskx\\template_storage",
    "Organisation": "Example enterpises",
    "Name": "Jsoeph Adams",
    "BusinessUnit": "IT & Oprations",
    "Team": "Foundations",
    "ServiceOwner": "Foundling",
    "ServiceOwnerEmail": "founders@example.com",
    "ServiceDomain": "qaskx",
    "PrimaryProgramLanguage": "go",
    "LintApiLevel": "warn",
    "InstallationID": "070cbef1-e65c-4953-aa55-cf334d21a6c0",
	"PolicyUrl": "https://qaskx.one/policy/",
    "CheckUpdate": true,
    "UpdateUrl": "https://qaskx.one/updater/"
}

An explanation of field and values explained below.

Field Purpose Values Example
GitProvider Allows multiple VCS providers to be supported git, gitea “GitProvider”: “gitea”
GitHost Hosting FQDN for Git Domain URL “GitHost”: “https://tea.merebox.com”
GitApi Conneting to VCS by API API URL “GitApi”: “https://tea.merebox.com/api/v1"
GitOrg The organisation path in Git Valid value for the repo “GitOrg”: “Cupboard”
GitRepoUser The VCS / Git repsitory user name Valid Git name “GitRepoUser”: “jadams”
GitBranch Default branch to create Any valid branch value “GitBranch”: “main”
GitUserEmail “GitUserEmail”: “j.adams@example.com”
TemplateHost “TemplateHost”: “https://tea.merebox.com/qaskx/qaskx.template.git"
TemplateFolder* Under review Local path “TemplateFolder”: “~\Projects.shared\qaskgo.template”
“TemplateName”: “base”
TemplateLocalStorage Local storage of templates from the internet Local path “TemplateLocalStorage”: “~\.qaskx\template_storage”
Organisation “Organisation”: “Example enterprises”
“Name”: “Joseph Adams”
“BusinessUnit”: “IT & Operations”
“Team”: “Foundations”
ServiceOwner “ServiceOwner”: “Foundling”
ServiceOwnerEmail “ServiceOwnerEmail”: “founders@exmaple.com”
ServiceDomain A category or domain for the services being developed “ServiceDomain”: “qaskx”
PrimaryProgramLanguage Programming language associated with projects go “PrimaryProgramLanguage”: “go”
“LintApiLevel”: “warn”
PolicyUrl Base path of the policy files URL with route “/” terminated “PolicyUrl”: “https://qaskx.one/policy/"
CheckUpdate Checks for software updates on start true, false “CheckUpdate”: true
UpdateUrl The base path for update checking URL route “/” terminated “UpdateUrl”: “https://qaskx.one/updater/"