Skip to main content

ArconQ File

The .arconq file is a configuration file used by the ArconQ CLI tool. It is expected to exist in the current folder, or it can be provided using the "-f, --file" parameter with a relative or absolute path argument to the file. As a convention, this file follows the YAML format, providing a human-readable and structured way to represent data.

File example

version: '0.1.0'

apps:
  amazing-app:
    description: Description of my app
    runtime: dotnet6
    arguments: -port=9090
    tags:
      - ReleaseCandidate
      - NeedsDatabase
    configFile: ./LoadMeasurementSender/config.json
    configSchemaFile: ./LoadMeasurementSender/config-schema.json
    build:
      project: ./src/project-path
      output: ./custom-path/artifacts
      buildArguments: -c Debug

The file contains the following elements:

  1. version - The version of the CLI tool syntax targeted by the file.
  2. apps - A list of applications, required and cannot be empty. This section contains configurations for different applications.
  3. amazing-app - An alias for the application, which is required. It is a unique identifier for the specific application.
  4. description - An optional description of the application. If not provided, the default alias is used.
  5. runtime - An optional runtime type for the application. Supported values are: dotnet6, dotnet7, dotnet8. If not specified, he default value is dotnet6.
  6. arguments - An optional custom arguments for the application.
  7. tags - An optional list of tags for application revision. Tags are metadata (keyword or term) and can be used to categorize revisions. You can learn more about tags in this article.
  8. configFile - An optional path to the application's configuration file in JSON format. This file allows users to specify application settings and parameters that can be customized for different environments or instances. It is utilized to define key-value pairs that the application will read at runtime, enabling dynamic configuration management.
  9. configSchemaFile - An optional path to the JSON schema file used to validate the application's configuration. This ensures that the configuration adheres to the defined structure and types.
  10. build - An optional build configuration for the application.
  • project - An optional relative path to the .arconq file to the folder containing the application's project. The default is the current directory.
  • output - An optional relative path to the .arconq file to the directory where the build artifacts will be generated. The default is ".arq-artifacts" in the current directory.
  • buildArguments - An optional custom arguments for the build process. The arguments given in this parameter have the highest priority. If an output path is specified in the buildArguments, it will overwrite the value entered in the output field.