key: viewSchema

description: Defaults to 'Schema'.


key: permission

description: The suffix is optional, and where not specified will default to '.READ'.

type: string


key: columnNameIsDeleted

description: Defaults to 'CodeGeneration.IsDeleted'.


key: columnNameTenantId

description: Defaults to 'CodeGeneration.TenantId'.


key: columnNameOrgUnitId

description: Defaults to 'CodeGeneration.OrgUnitId'.


key: columnNameRowVersion

description: Defaults to 'CodeGeneration.RowVersion'.


key: columnNameCreatedBy

description: Defaults to 'CodeGeneration.CreatedBy'.


key: columnNameCreatedDate

description: Defaults to 'CodeGeneration.CreatedDate'.


key: columnNameUpdatedBy

description: Defaults to 'CodeGeneration.UpdatedBy'.


key: columnNameUpdatedDate

description: Defaults to 'CodeGeneration.UpdatedDate'.


key: columnNameDeletedBy

description: Defaults to 'CodeGeneration.UpdatedBy'.


key: columnNameDeletedDate


key: QueryJoin

description: The 'QueryJoin' object defines a join to another (or same) table within a query. The 'Type' defines the join type, such as inner join, etc. The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required (for example duplicate name).

type: object

enum: Inner Left Right Full

type: array


key: schema

description: Defaults to 'Table.Schema'; i.e. same schema.


key: alias

description: Will automatically default where not specified.


key: type

description: Defaults to 'Inner'.


key: includeColumns

description: Where not specified this indicates that all 'Columns' are to be included.


key: excludeColumns

description: Where not specified this indicates no 'Columns' are to be excluded.


key: aliasColumns

description: Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'


key: columnNameIsDeleted

description: Defaults to 'CodeGeneration.IsDeleted'.


key: columnNameTenantId

description: Defaults to 'CodeGeneration.TenantId'.


key: columnNameOrgUnitId

description: Defaults to 'CodeGeneration.OrgUnitId'.


key: columnNameRowVersion


key: columnNameCreatedBy

description: Defaults to 'CodeGeneration.CreatedBy'.


key: columnNameCreatedDate


key: columnNameUpdatedBy

description: Defaults to 'CodeGeneration.UpdatedBy'.


key: columnNameUpdatedDate


key: columnNameDeletedBy

description: Defaults to 'CodeGeneration.UpdatedBy'.


key: columnNameDeletedDate


key: QueryJoinOn

description: The 'QueryJoinOn' object defines the join on characteristics for a join within a query.


key: toSchema

description: Defaults to 'Table.Schema'; i.e. same schema. See also 'ToTable' and 'ToColumn' as these all relate.


key: toTable

description: Defaults to 'Table.Name'; i.e. primary table. See also 'ToSchema' and 'ToColumn' as these all relate.


key: toColumn

description: Defaults to 'Name'; i.e. assumes same name. See also 'ToSchema' and 'ToTable' as these all relate.


key: QueryOrder

description: The 'QueryOrder' object that defines the query order.

enum: Ascending Descending


key: name

description: See also 'Schema' and 'Table' as these all relate.


key: schema

description: Defaults to 'Query.Schema'.


key: table

description: Defaults to 'Table.Name'; i.e. primary table. See also 'Schema' and 'Column' as these all relate.


key: order

description: Defaults to 'Ascending'.


key: QueryWhere

description: The 'QueryWhere' object defines an additional where 'Statement' to be added.


description: A configuration file for Queryfirst (https://queryfirst.net), named qfconfig.json

enum: CSharp TsInterfaceFromDto

type: boolean


key: options

description: Generators are loosely coupled. Options are passed as a string dictionary. Only strings here sorry.


key: makeSelfTest

description: Should QueryFirst add a selfTest method to the generated code? You will need add xunit and QueryFirst.CoreLib nugets to your project.


key: repoSuffix

description: Suffix to append to the query base name to get the generated repository class name


key: dtoSuffix

description: Suffix to append to the query base name to get the result class name


description: Location(s) where custom commands will be loaded from.

type: null string array


description: Location(s) where custom assertions will be loaded from.


description: Location(s) where page object files will be loaded from.


Location of an external globals module which will be loaded and made available to the test as a property globals on the main client instance.


key: globals

description: An object which will be made available on the main test api, throughout the test execution

type: integer


key: abortOnAssertionFailure

description: This controls whether to abort the test execution when an assertion failed and skip the rest. It's being used in waitFor commands and expect assertions


key: abortOnElementLocateError

description: This controls whether to abort the test execution when an element cannot be located; an error is logged in all cases, but this also enables skipping the rest of the testcase; It's being used in element commands such as .click() or .getText()


key: waitForConditionPollInterval

description: This will overwrite the default polling interval (currently 500ms) for waitFor commands and expect assertions that use retry


key: waitForConditionTimeout

description: Default timeout value in milliseconds for waitFor commands and implicit waitFor value for expect assertions


key: throwOnMultipleElementsReturned

description: This will cause waitFor commands on elements to throw an error if multiple elements are found using the given locate strategy and selector


description: By default a warning is printed if multiple elements are found using the given locate strategy and selector; set this to true to suppress those warnings


key: asyncHookTimeout

description: Controls the timeout value for async hooks. Expects the done() callback to be invoked within this time or an error is thrown


key: unitTestsTimeout

description: Controls the timeout value for when running async unit tests. Expects the done() callback to be invoked within this time or an error is thrown


key: customReporterCallbackTimeout

description: Controls the timeout value for when executing the global async reporter. Expects the done() callback to be invoked within this time or an error is thrown


key: retryAssertionTimeout

description: Automatically retrying failed assertions - You can tell Nightwatch to automatically retry failed assertions until a given timeout is reached, before the test runner gives up and fails the test.


key: dotenv

description: Configuration settings for the dotenv module - a zero-dependency module that loads environment variables from a .env file into process.env. More details on https://www.npmjs.com/package/dotenv


description: Persist the same globals object between runs or have a (deep) copy of it per each test; this can be useful when persisting data between test suites is needed, such as a cookie or session information


description: The location where the JUnit XML report files will be saved. Set this to false if you want to disable XML reporting


description: A string or array of folders (excluding subfolders) where the tests are located.


description: Used when running in parallel to determine if the output should be collected and displayed at the end.


description: Used to disable colored output in the terminal.


description: Used when running in parallel to specify the delay (in milliseconds) between starting the child processes


key: selenium

description: An object containing Selenium Server related configuration options

type: object array

type: string boolean


description: Whether or not to automatically start the Selenium/WebDriver session. If running unit tests, this should be set tot false.


description: End the session automatically when the test is being terminated, usually after a failed assertion.


Skip the remaining test cases from the current test suite, when one test case fails.


description: Whether or not to run individual test files in parallel.

type: boolean object

type: string number

type: string array


key: workers

description: Automatically compute the number of workers based on CPU cores with "auto" or manually specify the number of workers


description: Pass node arguments to individual workers (all of the process.execArgv using "auto" or selectively pass node arguments via ["--inspect"])


description: Specifies which test runner to use: default|mocha

default: default


key: webdriver

description: Defines options used to connect to the WebDriver/Selenium server


description: Time to wait (in ms) before starting to check the Webdriver server is up and running


description: Maximum number of ping status check attempts before returning a timeout error


description: Interval (in ms) to use between status ping checks when checking if the Webdriver server is up and running


description: The entire time (in ms) to wait for the Node.js process to be created and running (default is 2 min), including spawning the child process and checking the status


description: A url which can be used later in the tests as the main url to load.


key: silent

description: set to false if you want to show the extended http traffic command logs from the WebDriver server.


key: output

description: Used to disable terminal output completely.


description: Set this to false if you'd like to only see the test case name displayed and pass/fail status.


description: Set this to true if you'd like to see timestamps next to the logging output


description: Set this to true if you'd like to not display errors during the execution of the test (they are shown at the end always).


key: screenshots

description: Take error and failure screenshots during test execution


description: Used to enable showing the Base64 image data in the (verbose) log when taking screenshots.


key: exclude

description: An array of folders or file patterns to be skipped (relative to the main source folder).


key: filter

description: Folder or file pattern to be used when loading the tests. Files that don't match this pattern will be ignored.


key: skipgroup

description: Skip a group of tests (a subfolder); can be a list of comma-separated values (no space)


key: skiptags

description: Skip tests by tag name; can be a list of comma-separated values (no space)


description: Use xpath as the default locator strategy


description: The top level object of the `architect.yml`; defines a deployable Architect Component.

errorMessage: must contain only lower alphanumeric and single hyphens in the middle; max length 32

type: number

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

pattern: must be an interpolation ref ex. $__arc__{{ secrets.example }}

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

errorMessage: must be of the format <engine>:<version> (e.g. postgres:13)

format: uri

required: path port

required: command port

required: command path

not: Only one of host_path, key is allowed, or none should exist

not: Only one of buildpack, dockerfile is allowed, or none should exist

errorMessage: must contain alphanumeric characters ([a-z0-9A-Z]), could contain dashes (-) and alphanumerics between.

not: Only one of build, image is allowed, or none should exist

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.


key: name

description: Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32


key: description

description: A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for.


key: keywords

description: Additional search terms to be used when the component is indexed so that others can find it more easily.


key: author

description: The name or handle of the author of the component as a developer contact.


key: homepage

description: The url that serves as the informational homepage of the component (i.e. a github repo).


key: secrets

description: A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.


key: outputs

description: A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.


key: databases

description: A database represents a stateful service powered by one of several supported database engines.

additionalProperties: must contain only lower alphanumeric and single hyphens in the middle; max length 32


key: services

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.


key: tasks

description: A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.


key: dependencies

description: A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)


key: interfaces

description: A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.


additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.


key: DatabaseSpec

description: Component databases let you quickly spin up a database for your service


description: Human readable description


key: type

description: The type engine and version of database software needed for data storage.


description: The connection uri of an existing database to use instead of provisioning a new one


key: SecretDefinitionSpec

description: Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).


key: required

description: Denotes whether the secret is required.


description: A human-friendly description of the secret.


key: default

description: Sets a default value for the secret if one is not provided


key: LivenessProbeSpec

description: Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.


description: The number of times to retry a health check before the container is considered healthy.


description: The number of times to retry a failed health check before the container is considered unhealthy.


key: timeout

description: The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s


key: interval

description: The time period in seconds between each health check execution. You may specify any value between: 5s and 300s


description: Delays the check from running for the specified amount of time


key: path

description: [Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set).


key: command

description: Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set).


key: port

description: [Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set).


key: VolumeSpec

description: Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.


description: Directory at which the volume will be mounted inside the container.


description: A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set).


key: key

description: A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).


key: description

description: Human-readable description of volume


key: readonly

description: Marks the volume as readonly.


key: BuildSpec

description: An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.

default: Dockerfile

required: buildpack dockerfile


key: context

description: The path to the directory containing the source code relative to the `architect.yml` file.


key: buildpack

description: Option to use buildpack to build an image.


key: args

description: Build args to be passed into `docker build`.


key: dockerfile

description: The path to the Dockerfile relative to the `build.context`


key: target

description: The stage to build in the Dockerfile


key: IngressTlsSpec

description: Configuration for custom certificate.

required: crt key


key: crt

description: Custom certificate.


description: Custom certificate key.


key: ca

description: Custom certificate ca.


description: Configuration for custom certificate.


key: IngressSpec

description: An ingress exposes an interface to external network traffic through an architect-deployed gateway.


key: enabled

description: Marks the interface as an ingress.


key: subdomain

description: The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.


key: path

description: The path of the interface used for path based routing


description: IP addresses that are allowed to access the interface


key: private

description: Marks the ingress as private behind Architect authentication


key: ScalingMetricsSpec

description: Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.


key: cpu

description: The cpu usage required to trigger scaling.


key: memory

description: The memory usage required to trigger scaling.


key: ScalingSpec

description: Configuration that dictates the scaling behavior of a service.


description: The target minimum number of service replicas.


description: The target maximum number of service replicas.


key: KubernetesDeploySpec

description: Configuration that dictates the kubernetes deploy overrides.


key: DeploySpec

description: Configuration that dictates the deploy overrides.


key: ServiceInterfaceSpec

description: A service interface exposes service functionality over the network to other services within the same component. If you would like to expose services on the network to external components, see the ComponentInterfaceSpec

default: http


key: description

description: A human-readable description of the interface.


key: host

description: The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host.


key: port

description: Port on which the service is listening for traffic.


key: protocol

description: Protocol that the interface responds to


key: username

description: A Basic Auth username required to access the interface


key: password

description: A Basic Auth password required to access the interface


description: The path of the interface


key: url

description: The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url.


key: sticky

description: Denotes that if this interface is made external, the gateway should use sticky sessions


key: ServiceSpec

description: A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

required: build image


key: enabled

description: Determines if the service should be running.


key: interfaces

description: A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.


key: volumes

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.


key: replicas

description: A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field.


description: A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments.


description: Human readable description


key: image

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)


key: command

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.


key: entrypoint

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.


key: language

description: The dominant programming language used; this is for informational purposes only.


key: environment

description: A set of key-value pairs or secret definitions that describes environment variables and their values.


key: cpu

description: The cpu required to run a service or a task


key: memory

description: The memory required to run a service or a task.


description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.


key: labels

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.


description: A specific service name which will override the service name specified in the component.


key: TaskSpec

description: A Task represents a recurring and/or exiting runtime (e.g. crons, schedulers, triggered jobs). Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.

format: cron

format: must be a valid cron expression


key: schedule

description: A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI.


key: DependencySpec

description: An empty object that optionally supports specifying a tag for backwards compatibility.


key: ComponentInterfaceSpec

description: Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.


key: description

description: A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for.


key: host

description: The host that the component interface should forward to.


key: port

description: The port that the component interface should forward to.


key: protocol

description: The protocol by which the component interface can be connected to.


key: username

description: The Basic Auth username by which a component interface can be connected to.


key: password

description: The Basic Auth password by which a component interface can be connected to.


key: url

description: The url that the component interface should forward to.


key: sticky

description: If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running.


key: OutputDefinitionSpec

description: Components can define output fields that can be used to share configuration with consuming components.


description: A human-friendly description of the output field.


key: value

description: Value of the output to be passed to upstream consumers


key: ComponentSpec

description: The top level object of the `architect.yml`; defines a deployable Architect Component.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.


key: name

description: Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32


description: A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for.


key: keywords

description: Additional search terms to be used when the component is indexed so that others can find it more easily.


key: author

description: The name or handle of the author of the component as a developer contact.


key: homepage

description: The url that serves as the informational homepage of the component (i.e. a github repo).


key: secrets

description: A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec


key: outputs

description: A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.


key: databases

description: A database represents a stateful service powered by one of several supported database engines.


key: services

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.


key: tasks

description: A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.


key: dependencies

description: A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)


key: interfaces

description: A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.


additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.


description: Component databases let you quickly spin up a database for your service


key: description

description: Human readable description


key: type

description: The type engine and version of database software needed for data storage.


description: The connection uri of an existing database to use instead of provisioning a new one


description: Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).


key: required

description: Denotes whether the secret is required.


description: A human-friendly description of the secret.


key: default

description: Sets a default value for the secret if one is not provided


description: Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.


description: The number of times to retry a health check before the container is considered healthy.


description: The number of times to retry a failed health check before the container is considered unhealthy.


key: timeout

description: The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s


key: interval

description: The time period in seconds between each health check execution. You may specify any value between: 5s and 300s


description: Delays the check from running for the specified amount of time


key: path

description: [Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set).


key: command

description: Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set).


key: port

description: [Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set).


description: Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.


description: Directory at which the volume will be mounted inside the container.


description: A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set).


key: key

description: A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).


description: Human-readable description of volume


key: readonly

description: Marks the volume as readonly.


description: An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.


key: context

description: The path to the directory containing the source code relative to the `architect.yml` file.


key: buildpack

description: Option to use buildpack to build an image.


key: args

description: Build args to be passed into `docker build`.


key: dockerfile

description: The path to the Dockerfile relative to the `build.context`


key: target

description: The stage to build in the Dockerfile


description: Configuration for custom certificate.


key: crt

description: Custom certificate.


description: Custom certificate key.


key: ca

description: Custom certificate ca.


description: Configuration for custom certificate.


description: An ingress exposes an interface to external network traffic through an architect-deployed gateway.


key: enabled

description: Marks the interface as an ingress.


key: subdomain

description: The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.


description: The path of the interface used for path based routing


description: IP addresses that are allowed to access the interface


key: private

description: Marks the ingress as private behind Architect authentication


description: Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.


key: cpu

description: The cpu usage required to trigger scaling.


key: memory

description: The memory usage required to trigger scaling.


description: Configuration that dictates the scaling behavior of a service.


description: The target minimum number of service replicas.


description: The target maximum number of service replicas.


description: Configuration that dictates the kubernetes deploy overrides.


description: Configuration that dictates the deploy overrides.


description: A service interface exposes service functionality over the network to other services within the same component. If you would like to expose services on the network to external components, see the ComponentInterfaceSpec


key: description

description: A human-readable description of the interface.


key: host

description: The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host.


key: port

description: Port on which the service is listening for traffic.


key: protocol

description: Protocol that the interface responds to


key: username

description: A Basic Auth username required to access the interface


key: password

description: A Basic Auth password required to access the interface


key: path

description: The path of the interface


key: url

description: The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url.


key: sticky

description: Denotes that if this interface is made external, the gateway should use sticky sessions


description: A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.


description: Determines if the service should be running.


key: interfaces

description: A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.


key: volumes

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.


key: replicas

description: A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field.


description: A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments.


description: Human readable description


key: image

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)


key: command

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.


key: entrypoint

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.


key: language

description: The dominant programming language used; this is for informational purposes only.


key: environment

description: A set of key-value pairs or secret definitions that describes environment variables and their values.


key: cpu

description: The cpu required to run a service or a task


key: memory

description: The memory required to run a service or a task.


description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.


key: labels

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.


description: A specific service name which will override the service name specified in the component.


description: A Task represents a recurring and/or exiting runtime (e.g. crons, schedulers, triggered jobs). Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.


key: schedule

description: A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI.


description: An empty object that optionally supports specifying a tag for backwards compatibility.


description: Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.


key: description

description: A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for.


key: host

description: The host that the component interface should forward to.


key: port

description: The port that the component interface should forward to.


key: protocol

description: The protocol by which the component interface can be connected to.


key: username

description: The Basic Auth username by which a component interface can be connected to.


key: password

description: The Basic Auth password by which a component interface can be connected to.


key: url

description: The url that the component interface should forward to.


key: sticky

description: If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running.


description: Components can define output fields that can be used to share configuration with consuming components.


description: A human-friendly description of the output field.


key: value

description: Value of the output to be passed to upstream consumers


description: The top level object of the `architect.yml`; defines a deployable Architect Component.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.


key: name

description: Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32


description: A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for.


key: keywords

description: Additional search terms to be used when the component is indexed so that others can find it more easily.


key: author

description: The name or handle of the author of the component as a developer contact.


key: homepage

description: The url that serves as the informational homepage of the component (i.e. a github repo).


key: secrets

description: A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec


key: outputs

description: A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.


key: databases

description: A database represents a stateful service powered by one of several supported database engines.


key: services

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.


key: tasks

description: A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.


key: dependencies

description: A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)


key: interfaces

description: A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.


additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.


key: rootDir

description: If given, all the file paths in the collected type info will be resolved relative to this directory.


key: tsConfig

description: Path to your project's tsconfig file. This is required for several other options like implicit this instrumentation and type inference using static analysis.


key: instrumentCallExpressions

description: Try to find even more types by combining static analysis with the runtime analysis. TypeWiz will try to use TypeScript's inferred types when determining the type of a function argument.


key: instrumentImplicitThis

description: Find type of this in non-class member functions. Requires common.tsConfig to be set


key: skipTwizDeclarations

description: Don't add a declaration of $_$twiz to instrumented files.


key: prefix

description: A prefix that will be added in front of each type applied. You can use a javascript comment to mark the automatically added types. The prefix will be added after the colon character, just before the actual type.


key: extends

description: Name of configuration to extend from.


key: all

description: Whether or not to instrument all files (not just the ones touched by your test suite).


key: check-coverage

description: Check whether coverage is within thresholds, fail if not


key: extension

description: List of extensions that nyc should attempt to handle in addition to .js

default: .js .cjs .mjs .ts .tsx .jsx


key: include

description: List of files to include for coverage.


key: exclude

description: List of files to exclude for coverage.


key: reporter

description: The names of custom reporter to show coverage results.


key: report-dir

description: Where to put the coverage report files.

default: ./coverage


key: skip-full

description: Don't show files with 100% statement, branch, and function coverage


key: temp-dir

description: Directory to output raw coverage information to.


key: CodeGeneration

description: The 'CodeGeneration' object defines global properties that are used to drive the underlying database-driven code generation.

enum: None PascalCase SnakeKebabToPascalCase

enum: Common Business Autonomous

enum: NameOnly NameAndKey

enum: None Absolute Relative RelativeOrAbsolute

enum: NameOnly NameAndKey NameAndGlobalId


key: schema

description: This is used as the default 'Schema' for all child objects.


key: columnNameIsDeleted

description: Defaults to 'IsDeleted'.


key: columnNameTenantId

description: Defaults to 'TenantId'.


key: columnNameOrgUnitId

description: Defaults to 'OrgUnitId'.


key: columnNameRowVersion

description: Defaults to 'RowVersion'.


key: columnNameCreatedBy

description: Defaults to 'CreatedBy'.


key: columnNameCreatedDate

description: Defaults to 'CreatedDate'.


key: columnNameUpdatedBy

description: Defaults to 'UpdatedBy'.


key: columnNameUpdatedDate

description: Defaults to 'UpdatedDate'.


key: columnNameDeletedBy

description: Defaults to 'UpdatedBy'.


key: columnNameDeletedDate

description: Defaults to 'UpdatedDate'.


key: orgUnitJoinSql

description: Defaults to '[Sec].[fnGetUserOrgUnits]()'.


key: checkUserPermissionSql

description: Defaults to '[Sec].[spCheckUserHasPermission]'.


key: getUserPermissionSql

description: Defaults to '[Sec].[fnGetUserHasPermission]'.


key: cdcSchema

description: Defaults to 'XCdc' (literal).


key: cdcAuditTableName

description: Defaults to 'CdcTracking' (literal).


key: cdcIdentifierMappingTableName

description: Defaults to 'CdcIdentifierMapping' (literal).


key: cdcIdentifierMappingStoredProcedureName

description: Defaults to 'spCreateCdcIdentifierMapping' (literal).


key: jsonSerializer

description: Defaults to 'Newtonsoft'. This can be overridden within the 'Entity'(s).


key: hasBeefDbo

description: Defaults to 'true'.


key: autoDotNetRename

description: Defaults 'SnakeKebabToPascalCase' that will remove any underscores or hyphens separating each word and capitalize the first character of each; e.g. 'internal-customer_id' would be renamed as 'InternalCustomerId'. The 'PascalCase' option will capatilize the first character only.


key: entityScope

description: Defaults to 'Common' for backwards compatibility; 'Autonomous' is recommended. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible).


key: eventSubjectRoot

description: Used to enable the sending of messages to the likes of EventHub, Service Broker, SignalR, etc. This can be extended within the 'Entity'(s).


key: eventSubjectFormat

description: Defaults to 'NameAndKey' (being the event subject name appended with the corresponding unique key.)'.


key: eventActionFormat

description: Defaults to 'None' (no formatting required, i.e. as-is).


key: eventSourceRoot

description: The event source is only updated where an 'EventSourceKind' is not 'None'. This can be extended within the 'Entity'(s).


key: eventSourceKind

description: Defaults to 'None' (being the event source is not updated).


key: eventSourceFormat


key: eventOutboxTableName

description: Defaults to 'EventOutbox' (literal).


key: pathBase

description: Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'.


key: pathDatabaseSchema

description: Defaults to 'PathBase' + '.Database/Schema' (literal). For example 'Beef.Demo.Database/Schema'.


key: pathDatabaseMigrations

description: Defaults to 'PathBase' + '.Database/Migrations' (literal). For example 'Beef.Demo.Database/Migrations'.


key: pathBusiness

description: Defaults to 'PathBase' + '.Business' (literal). For example 'Beef.Demo.Business'.


key: PathCdcPublisher

description: Defaults to 'PathBase' + '.Cdc' (literal). For example 'Beef.Demo.Cdc'.


key: orgUnitImmutable

description: This is only applicable for stored procedures.


key: namespaceBase


key: namespaceCommon

description: Defaults to 'NamespaceBase' + '.Common' (literal). For example 'Beef.Demo.Common'.


key: namespaceBusiness

description: Defaults to 'NamespaceBase' + '.Business' (literal). For example 'Beef.Demo.Business'.


key: NamespaceCdcPublisher

description: Defaults to 'NamespaceBase' + '.CdcPublisher' (literal). For example 'Beef.Demo.CdcPublisher'.


key: Table

description: The 'Table' object identifies an existing database 'Table' (or 'View') and defines its code-generation characteristics.


key: schema

description: Defaults to 'CodeGeneration.Schema'.


key: alias

description: Will automatically default where not specified.


key: includeColumns

description: Where not specified this indicates that all 'Columns' are to be included.


key: excludeColumns

description: Where not specified this indicates no 'Columns' are to be excluded.


key: getAll

description: The 'GetAllOrderBy' is used to specify the 'GetAll' query sort order.


key: getAllOrderBy

description: This relates to the 'GetAll' selection.


key: merge

description: This will also require a 'Udt' (SQL User Defined Table) and 'Tvp' (.NET Table-Valued Parameter) to function.


key: efModelName

description: Defaults to 'Name'.


key: udtExcludeColumns

description: Where not specified this indicates that no 'Columns' are to be excluded.


key: entityScope

description: Defaults to 'CodeGeneration.EntityScope'. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible).


description: Defaults to 'CodeGeneration.OrgUnitImmutable'. This is only applicable for stored procedures.


key: columnNameIsDeleted

description: Defaults to 'CodeGeneration.IsDeleted'.


key: columnNameTenantId

description: Defaults to 'CodeGeneration.TenantId'.


key: columnNameOrgUnitId

description: Defaults to 'CodeGeneration.OrgUnitId'.


key: columnNameRowVersion

description: Defaults to 'CodeGeneration.RowVersion'.


key: columnNameCreatedBy

description: Defaults to 'CodeGeneration.CreatedBy'.


key: columnNameCreatedDate

description: Defaults to 'CodeGeneration.CreatedDate'.


key: columnNameUpdatedBy

description: Defaults to 'CodeGeneration.UpdatedBy'.


key: columnNameUpdatedDate

description: Defaults to 'CodeGeneration.UpdatedDate'.


key: columnNameDeletedBy

description: Defaults to 'CodeGeneration.UpdatedBy'.


key: columnNameDeletedDate


key: StoredProcedure

description: The code generation for an 'StoredProcedure' is primarily driven by the 'Type' property. This encourages (enforces) a consistent implementation for the standardised **CRUD** (Create, Read, Update and Delete) actions, as well as supporting 'Upsert', 'Merge' and ad-hoc queries as required.

enum: Get GetColl Create Update Upsert Delete Merge


key: name

description: See 'StoredProcedureName' for the actual name used in the database.


key: type

description: Defaults to 'GetColl'.


key: paging

description: This only applies where the stored procedure operation 'Type' is 'GetColl'.


key: storedProcedureName

description: Defaults to 'sp' + 'Table.Name' + 'Name'; e.g. 'spTableName' or 'spPersonGet'.


key: reselectStatement

description: Defaults to '[{{Table.Schema}}].[sp{{Table.Name}}Get]' passing the primary key column(s).


key: intoTempTable

description: A 'Select * from #TempTable' is also performed (code-generated) where the stored procedure operation 'Type' is 'GetColl'.


key: mergeOverrideIdentityColumns

description: This is used to override the default behaviour of using the primary key column(s).


key: orgUnitImmutable

description: Defaults to 'Table.OrgUnitImmutable'.


key: includeColumns

description: Where not specified this indicates that all 'Columns' are to be included. Only filters the columns where 'Type' is 'Get', 'GetColl', 'Create', 'Update' or 'Upsert'.


key: excludeColumns

description: Where not specified this indicates no 'Columns' are to be excluded. Only filters the columns where 'Type' is 'Get', 'GetColl', 'Create', 'Update' or 'Upsert'.


key: Parameter

description: The 'Parameter' is used to define a stored procedure parameter and its charateristics. These are in addition to those that are automatically inferred (added) by the selected 'StoredProcedure.Type'.

enum: EQ NE LT LE GT GE LIKE


key: column

description: Defaults to 'Name'.


key: nullable

description: Note that when the parameter value is 'NULL' it will not be included in the query.


key: operator

description: Defaults to 'EQ'.


key: Where

description: The 'Where' object defines an additional where 'Statement' to be added. This is in addition to those automatically added based on the 'StoredProcedure.Type'.


key: OrderBy

description: The 'OrderBy' object defines the query order. Only valid for 'StoredProcedure.Type' of 'GetAll'.


key: order

description: Defaults to 'Ascending'.


key: Execute

description: The _Execute_ object enables additional TSQL statements to be embedded within the stored procedure.

enum: Before After


key: location

description: Defaults to 'After'.


key: Query

description: The 'Query' object enables the definition of more complex multi-table queries ('Joins') that would primarily result in a database _View_. The primary table 'Name' for the query is required to be specified. Multiple queries can be specified for the same table(s). The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required (for example duplicate name). Additional 'Where' and 'Order' configuration can also be added as required.


key: schema

description: Defaults to 'CodeGeneration.dbo'.


key: alias

description: Will automatically default where not specified.


description: Where not specified this indicates that all 'Columns' are to be included.


description: Where not specified this indicates no 'Columns' are to be excluded.


key: aliasColumns

description: Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'


key: viewName

description: Defaults to 'vw' + 'Name'; e.g. 'vwTableName'.


key: viewSchema

description: Defaults to 'Schema'.


key: permission

description: The suffix is optional, and where not specified will default to '.READ'.


key: columnNameIsDeleted

description: Defaults to 'CodeGeneration.IsDeleted'.


key: columnNameTenantId

description: Defaults to 'CodeGeneration.TenantId'.


key: columnNameOrgUnitId

description: Defaults to 'CodeGeneration.OrgUnitId'.


key: columnNameRowVersion

description: Defaults to 'CodeGeneration.RowVersion'.


key: columnNameCreatedBy

description: Defaults to 'CodeGeneration.CreatedBy'.


key: columnNameCreatedDate

description: Defaults to 'CodeGeneration.CreatedDate'.


key: columnNameUpdatedBy

description: Defaults to 'CodeGeneration.UpdatedBy'.


key: columnNameUpdatedDate

description: Defaults to 'CodeGeneration.UpdatedDate'.


key: columnNameDeletedBy

description: Defaults to 'CodeGeneration.UpdatedBy'.


key: columnNameDeletedDate


key: QueryJoin

description: The 'QueryJoin' object defines a join to another (or same) table within a query. The 'Type' defines the join type, such as inner join, etc. The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required (for example duplicate name).


key: schema

description: Defaults to 'Table.Schema'; i.e. same schema.


key: alias


key: type

description: Defaults to 'Inner'.


key: includeColumns


key: excludeColumns


key: aliasColumns


key: columnNameIsDeleted

description: Defaults to 'CodeGeneration.IsDeleted'.


key: columnNameTenantId

description: Defaults to 'CodeGeneration.TenantId'.


key: columnNameOrgUnitId

description: Defaults to 'CodeGeneration.OrgUnitId'.


key: columnNameRowVersion


key: columnNameCreatedBy

description: Defaults to 'CodeGeneration.CreatedBy'.


key: columnNameCreatedDate


key: columnNameUpdatedBy

description: Defaults to 'CodeGeneration.UpdatedBy'.


key: columnNameUpdatedDate


key: columnNameDeletedBy

description: Defaults to 'CodeGeneration.UpdatedBy'.


key: columnNameDeletedDate


key: QueryJoinOn

description: The 'QueryJoinOn' object defines the join on characteristics for a join within a query.


key: toSchema

description: Defaults to 'Table.Schema'; i.e. same schema. See also 'ToTable' and 'ToColumn' as these all relate.


key: toTable

description: Defaults to 'Table.Name'; i.e. primary table. See also 'ToSchema' and 'ToColumn' as these all relate.


key: toColumn

description: Defaults to 'Name'; i.e. assumes same name. See also 'ToSchema' and 'ToTable' as these all relate.


key: QueryOrder

description: The 'QueryOrder' object that defines the query order.


key: name

description: See also 'Schema' and 'Table' as these all relate.


key: schema

description: Defaults to 'Query.Schema'.


key: table

description: Defaults to 'Table.Name'; i.e. primary table. See also 'Schema' and 'Column' as these all relate.


key: order

description: Defaults to 'Ascending'.


key: QueryWhere

description: The 'QueryWhere' object defines an additional where 'Statement' to be added.


description: ZEIT Now project configuration file

required: src use

enum: GET HEAD POST PUT DELETE CONNECT OPTIONS TRACE PATCH


key: alias

description: domain names (optionally including subdomains) added to the account, or a string for a suffixed URL using .now.sh or a Custom Deployment Suffix


key: env

description: environment keys and values


description: name for the deployment


key: version

description: the Now Platform version that the deployment should use and is known to work with


key: scope

description: an ID or slug for teams, or an email address, username, or ID for users


description: environment variables passed to the invoked Serverless Functions


description: environment variables passed to the Build processes


key: builds

description: a list of build descriptions whose src references valid source files


key: items

description: build description


key: src

description: A glob expression or pathname. If more than one file is resolved, one build will be created per matched file. It can include `*` and `**`.


key: use

description: A npm module to be installed by the build process. It can include a semver compatible version (e.g.: `@org/proj@1`).


key: config

description: An object including arbitrary metadata to be passed to the Builder.


key: routes

description: a list of route definitions


description: route definition


description: A PCRE-compatible regular expression that matches each incoming pathname (excluding querystring).


key: methods

description: A set of HTTP method types. If no method is provided, requests with any HTTP method will be a candidate for the route.


key: dest

description: A destination pathname or full URL, including querystring, with the ability to embed capture groups as $1, $2…


key: headers

description: A set of headers to apply for responses.


key: status

description: A status code to respond with. Can be used in tandem with `Location:` header to implement redirects.


key: continue

description: A boolean to change matching behavior. If true, routing will continue even when the src is matched.


key: regions

description: the deployment regions of the Serverless Functions that get created as a result of the build steps


description: region identifier


key: public

description: When set to true, both the source view and logs view will be publicly accessible (when the user is authenticated with ZEIT).


key: github

description: Git integration options


key: enabled

description: When set to false, Now for GitHub will not deploy the given project regardless of the GitHub app being installed.


key: autoAlias

description: When set to false, Now for GitHub will not apply the alias upon merge.


key: silent

description: When set to true, Now for GitHub will stop commenting on pull requests and commits.


key: autoJobCancelation

description: When set to false, Now for GitHub will always build pushes in sequence without cancelling a build for the most recent commit.


description: A configuration file for Qodana (https://jetbrains.com/qodana), named qodana.yaml or qodana.yml

enum: default php-migration

required: name version licenses


key: profile

description: A profile is some template set of checks to run with Qodana analysis


key: name

description: The profile name (embedded or located in the project)


key: path

description: The path to the profile file relative to the project root


key: include

description: The inspections to run in addition to those from the profile


description: The ID of the inspection to be added


key: exclude

description: The inspections or paths to exclude from analysis


description: The ID of the inspection to exclude, or 'All'


key: paths

description: The path in which to disable the inspection, relative to the project root. Omitting the paths disables the inspection everywhere


key: script

description: The default running scenario


description: The name of the script


key: parameters

description: The parameters to pass to the script


key: licenseRule

description: A license rule to apply for license compatibility checks in Qodana


key: keys

description: The list of project license SPDX IDs


key: allowed

description: The list of allowed dependency licenses for the project


key: prohibited

description: The list of prohibited dependency licenses for the project


key: dependencyIgnore

description: A dependency to ignore for license checks in Qodana


description: The name of a dependency to ignore


key: dependencyOverride

description: A dependency metadata to override for license checks in Qodana


description: The dependency name


key: version

description: The dependency version


key: url

description: The dependency homepage


key: licenses

description: The dependency licenses


key: customDependency

description: A dependency to add to license checks to Qodana


key: license

description: A license to apply for license compatibility checks in Qodana


key: key

description: The SPDX ID of the license


description: The license homepage


key: dotnet

description: Configuration for .NET solutions and projects


key: solution

description: The name of a .NET solution inside the Qodana project


key: project

description: The name of a .NET project inside the Qodana project


key: configuration

description: The name of a configuration to be used for .NET solution or project


key: platform

description: The name of a platform to be used for .NET solution or project


key: dot-net


description: The version of the file format


key: profile

description: The profile configuration for Qodana analysis


key: failThreshold

description: The number of problems that causes Qodana to exit with code 255


key: script

description: The run scenario. 'default' by default


key: exclude

description: The inspections and paths that are excluded from analysis


key: include

description: The inspections and paths that are added to those from the profile


key: linter

description: The linter (Docker image) to run for Qodana CLI / any CI extensions


key: bootstrap

description: The command to run inside Docker before the analysis starts


key: properties

description: Set JVM properties to be used while running Qodana


key: licenseRules

description: A list of license rules to apply for license checks


description: The configuration for .NET solutions and projects


description: The schema for `ezd`


key: env

description: Environment variables to set for all tasks


description: Configure and run shell tasks


key: description

description: Describes the task for the user


description: Environment variables to set while executing these specific commands


key: commands

description: A list of commands to execute within the local shell


description: Configure and run `docker-seq` tasks


key: file

description: Path to a `docker-seq.yml` file


key: config

description: Embedded `docker-seq.yml` configuration


key: volumes

description: Declare docker volumes to use within docker_seq tasks


key: driver

description: Specify volume driver name


key: label

description: Set metadata for a volume


key: opt

description: Set driver specific options


key: nullable-boolean

description: Copy of definition from https://json.schemastore.org/base.json#/definitions/nullable-boolean


key: nullable-timezone

description: Copy of definition from https://json.schemastore.org/base.json#/definitions/nullable-timezone


key: global-permalink

description:
The global permalink format
https://jekyllrb.com/docs/permalinks/#global

default: date


key: collection-permalink

description:
The collection permalink format
https://jekyllrb.com/docs/permalinks/#collections

examples: /:collection /:path /:name /:title /:output_ext


key: source

description:
A directory to read files from for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration


key: destination

description:
A directory to write files to for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration


key: safe

description:
Whether to enable non-whitelisted plugins and symbolic links for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration


description:
Whether to disable caching to disk for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration


description:
Whether to ignore a theme configuration for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration


key: exclude

description:
Excluded directories and files from the conversion for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration

default: Gemfile Gemfile.lock node_modules vendor/bundle/ vendor/cache/ vendor/gems/ vendor/ruby/


key: items

description:
An excluded directory or file from the conversion for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration


key: include

description:
Included directories and files in the conversion for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration


description:
An included directory or file in the conversion for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration


description:
Keeped files when clobbering for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration

default: .git .svn


description:
A keeped file when clobbering for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration


key: timezone

description:
A time zone for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration


key: encoding

description:
An encoding for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration


key: defaults

description:
The front matter defaults
https://jekyllrb.com/docs/configuration/options/#global-configuration


description:
The front matter default
https://jekyllrb.com/docs/configuration/front-matter-defaults/


key: scope

description:
The scope
https://jekyllrb.com/docs/configuration/front-matter-defaults/


key: path

description:
The file path for this scope
https://jekyllrb.com/docs/configuration/front-matter-defaults/


key: type

description:
The page type for this scope
https://jekyllrb.com/docs/configuration/front-matter-defaults/


key: values

description:
The front matter default values
https://jekyllrb.com/docs/configuration/front-matter-defaults/


key: layout

description:
The layout to use
https://jekyllrb.com/docs/configuration/front-matter-defaults/


key: output

description:
Enable/disable output
https://jekyllrb.com/docs/configuration/front-matter-defaults/


key: date

description:
The date for pages
https://jekyllrb.com/docs/configuration/front-matter-defaults/


key: categories

description:
The categories for pages
https://jekyllrb.com/docs/configuration/front-matter-defaults/


key: tags

description:
The tags for pages
https://jekyllrb.com/docs/configuration/front-matter-defaults/


description:
Plugin directories for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


description:
A plugin directory for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


description:
Layout directories for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


description:
A layout directory for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


Whether to process and render draft posts for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


key: future

description:
Whether to publish posts or collection documents with a future date for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


key: unpublished

description:
Whether to publish posts that were marked as unpublished for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


key: lsi

description:
Whether to produce an index for related posts for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


description:
A number of posts to publish for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


description:
Whether to use polling for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


key: quiet

description:
Whether to hide a normal output while building for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


key: verbose

description:
Whether to write a verbose output while building for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


key: incremental

description:
Whether to enable the experimental incremental build feature for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


key: profile

description:
Whether to render profile generation to help identify performance bottlenecks for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


description:
Whether to fail build if there is a YAML syntax error in a page's front matter for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


key: baseurl

description:
A base URL for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options


key: port

description:
A port to listen on for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options


key: host

description:
A hostname to listen on for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options

default: localhost


key: livereload

description:
Whether to reload pages on the browser when its content was changed for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options


description:
File glob patterns for LiveReload to ignore for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options


key: items

description:
A file glob patter for LiveReload to ignore for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options


description:
A minimum delay before automatically reloading page for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options


description:
A maximum delay before automatically reloading page for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options


description:
Whether to open a site's URL in the browser for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options


key: detach

description:
Whether to detach a server from a terminal for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options


description:
Whether to skip an initial site build which occurs before the server is started for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options


description:
Whether to show directory listing instead of an index file for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options


key: collections

description:
The collections to group several site pages
https://jekyllrb.com/docs/collections/


description:
The collection
https://jekyllrb.com/docs/collections/#setup


key: output

description:
Enable/disable collection rendering
https://jekyllrb.com/docs/collections/#setup


description:
The collection's front matter sort key
https://jekyllrb.com/docs/collections/#sort-by-front-matter-key


key: order

description:
The page order list in collection
https://jekyllrb.com/docs/collections/#manually-ordering-documents


description:
A directory where to store collections for the current site
https://jekyllrb.com/docs/collections/#setup


description:
A directory to store data files for the current site
https://jekyllrb.com/docs/configuration/default/


description:
An includes directory for the current site
https://jekyllrb.com/docs/configuration/default/


description:
Markdown extensions for the current site
https://jekyllrb.com/docs/configuration/default/

default: markdown,mkdown,mkdn,mkd,md

examples: markdown mkdown mkdn mkd md


key: whitelist

description:
Whitelisted plugins for the current site
https://jekyllrb.com/docs/configuration/default/


description:
A whitelisted plugin for the current site
https://jekyllrb.com/docs/configuration/default/


key: plugins

description:
Enabled plugins for the current site
https://jekyllrb.com/docs/configuration/default/


description:
An enabled plugin for the current site
https://jekyllrb.com/docs/configuration/default/


key: markdown

description:
A markdown processor for the current site
https://jekyllrb.com/docs/configuration/default/

default: kramdown


key: highlighter

description:
A yntax highlighter for the current site
https://jekyllrb.com/docs/configuration/default/

default: rouge


description:
A post excerpt separator for the current site
https://jekyllrb.com/docs/configuration/default/


description:
A destination of the pagination pages for the current site
https://jekyllrb.com/docs/configuration/default/


key: kramdown

description:
kramdown options
https://kramdown.gettalong.org/documentation.html

examples: section subsection subsubsection paragraph subparagraph

default: mathjax

default: lsquo,rsquo,ldquo,rdquo

examples: lsquo,rsquo ldquo,rdquo


key: input

description:
The selected kramdown processor
https://jekyllrb.com/docs/configuration/markdown/

default: GFM


description:
Enable/disable interpreting line breaks literally
https://github.com/kramdown/parser-gfm#options


description:
Enabled GFM quirks
https://github.com/kramdown/parser-gfm#options


description:
Enable/disable rendering emoji amidst GFM
https://github.com/kramdown/parser-gfm#options


description:
Configuration for rendering emoji amidst GFM
https://github.com/kramdown/parser-gfm#options


description: Remote location of emoji assets


description:
The prefix used for automatically generated header IDs
https://kramdown.gettalong.org/converter/html.html


description:
Strip/leave all formatting from header text for automatic ID generation
https://kramdown.gettalong.org/converter/html.html


description:
Enable/disable automatic header ID generation
https://kramdown.gettalong.org/converter/html.html


description:
The entity output
https://kramdown.gettalong.org/converter/html.html


description:
The text that should be used for the footnote backlinks
https://kramdown.gettalong.org/converter/html.html


description:
Enable/disable inlining of the footnote backlink
https://kramdown.gettalong.org/converter/html.html


description:
The number of the first footnote
https://kramdown.gettalong.org/converter/html.html


description:
The prefix for footnote IDs
https://kramdown.gettalong.org/options.html


description:
The options that may not be set using the {::options} extension
https://kramdown.gettalong.org/options.html


description:
The output offset for headers
https://kramdown.gettalong.org/options.html


description:
Enable/disable HTML elements to native elements conversion
https://kramdown.gettalong.org/parser/kramdown.html


description:
The LaTeX commands for different header levels
https://kramdown.gettalong.org/options.html


description:
The line width when outputting the document
https://kramdown.gettalong.org/options.html


description: The pre-defined link definitions


description: The link identifier


description: The title


description:
The math engine
https://kramdown.gettalong.org/converter/html.html


description:
The math engine options
https://kramdown.gettalong.org/converter/html.html


description:
Enable/disable processing kramdown syntax in block HTML tags
https://kramdown.gettalong.org/parser/kramdown.html


description:
Enable/disable processing kramdown syntax in span HTML tags
https://kramdown.gettalong.org/parser/kramdown.html


description:
Enable/disable removing block HTML tags
https://kramdown.gettalong.org/options.html


description:
Leave/remove line breaks between CJK characters
https://kramdown.gettalong.org/converter/html.html


description:
Enable/disable removing span HTML tags
https://kramdown.gettalong.org/options.html


description:
The HTML entity names or code points for smart quote output
https://kramdown.gettalong.org/converter/html.html


description:
The syntax highlighter
https://kramdown.gettalong.org/converter/html.html


description:
The syntax highlighter options
https://kramdown.gettalong.org/converter/html.html


key: template

description:
The name of an ERB template file that should be used to wrap the output or the ERB template itself
https://kramdown.gettalong.org/converter/html.html


description:
The levels that are used for the table of contents
https://kramdown.gettalong.org/converter/html.html


description:
Enable/disable transliterating header text before generating the ID
https://kramdown.gettalong.org/converter/html.html


description:
The mapping from typographical symbol to output characters
https://kramdown.gettalong.org/converter/html.html


key: hellip

description:
Typographical symbol
https://kramdown.gettalong.org/converter/html.html


key: mdash


key: ndash


key: laquo


key: raquo


key: liquid

description:
Liquid options
https://jekyllrb.com/docs/configuration/liquid/

enum: lax warn strict

default: warn


description:
The response to errors
https://jekyllrb.com/docs/configuration/liquid/


description:
Enable/disable non-existing filters catch
https://jekyllrb.com/docs/configuration/liquid/


description:
Enable/disable non-assigned variables catch
https://jekyllrb.com/docs/configuration/liquid/


key: sass

description:
Sass options
https://github.com/jekyll/jekyll-sass-converter#configuration-options

enum: sassc sass-embedded

default: sassc

default: compact

enum: nested compact compressed expanded

enum: never always development

default: always


key: implementation

description:
The implementation to use
https://github.com/jekyll/jekyll-sass-converter#configuration-options


key: style

description:
The style of CSS-output
https://github.com/jekyll/jekyll-sass-converter#configuration-options


description:
The path with Sass partials
https://github.com/jekyll/jekyll-sass-converter#configuration-options


description:
The additional paths with Sass partials
https://github.com/jekyll/jekyll-sass-converter#configuration-options


description:
Enable/disable including line number and filename of the source in compiled CSS file
https://github.com/jekyll/jekyll-sass-converter#configuration-options


key: sourcemap

description:
Control when source maps shall be generated
https://github.com/jekyll/jekyll-sass-converter#configuration-options


key: webrick

description:
WEBrick options
https://docs.ruby-lang.org/en/2.4.0/WEBrick.html


key: headers

description:
The custom headers for this site
https://docs.ruby-lang.org/en/2.4.0/WEBrick.html


key: rdiscount

description:
RDiscount options
https://rdoc.info/github/davidfstr/rdiscount/RDiscount


key: extensions

description:
The enabled extensions
https://rdoc.info/github/davidfstr/rdiscount/RDiscount


key: redcarpet

description:
Redcarpet options
https://github.com/vmg/redcarpet


description:
The enabled extensions
https://github.com/vmg/redcarpet#and-its-like-really-simple-to-use


key: title

description: Human-readable name of the tool that will be visible to people in the list of tools.

examples:
AsyncAPI Generator
Cupid


key: description

description: By default scripts read description of repository there project is stored. You can override this behaviour by providing custom description.


key: websiteUrl

description: You can provide URL to the website where your project hosts some demo or project landing page.


key: docsUrl

description: You can provide URL to project documentation in case you have more than just a readme file.


key: repoUrl

description: You can provide URL to project codebase in case you have more than one tool present inside single repository.


key: language

description: The language referred to is the runtime language selected by the user, not the generator or library language. For example, the Generator written in JavaScript generates Python code from the JavaScript template and the result of generation is a Python app, so the language for Generator is specified as Python. But for the Bundler library, users need to know if it can be integrated into their TypeScript codebase, so its language is specified as TypeScript. If some language in the schema's enum is omitted, it can be added through a pull request to the AsyncAPI website repository.

enum: Go Java JavaScript HTML C/C++ C# Python TypeScript Kotlin Scala Markdown YAML R Rubby Rust Shell Groovy


key: technology

description: Provide a list of different technologies used in the tool. Put details useful for tool user and tool contributor.

enum:
Node js
Hermes
React JS
.NET
ASP.NET
Springboot
AWS
Docker
Node-red
Maven
Saas
Kubernetes-native
Scala
Azure
Jenkins
Flask


key: categories

description: Categories are used to group tools by different use case, like documentation or code generation. If have a list of fixed categories. If you use different one that your tool lands under "other" category. Feel free to add your category through a pull request to AsyncAPI website repository.

enum: api code-first code-generator converter directory documentation-generator editor ui-component dsl framework github-action mocking-and-testing validator compare-tool other cli bundler ide-extension


key: hasCommercial

description: Indicate if your tool is open source or commercial offering, like SAAS for example


description: A File defining what sounds play when sound event is triggered

default: sound

enum: sound event

type: string object


key: soundPath

description:
The path to a sound file from the "namespace/sounds" folder (excluding the .ogg file extension). Uses forward slashes.
The namespace defaults to minecraft but it can be changed by prepending a namespace and separating it with a :


key: $schema

description: Allow $schema because additionalProperties is false


key: additionalProperties

description: A sound event. The name is usually separated in categories (such as "entity.enderman.stare")


key: replace

description:
Used only in resource packs.
True if the sounds listed in sounds should replace the sounds listed in the default sounds.json for this sound event
False if the sounds listed should be added to the list of default sounds.
Default is false


key: subtitle

description: Translated as the subtitle of the sound if Show Subtitles is enabled ingame.


key: sounds

description: The sound files this sound event uses. One of the listed sounds is randomly selected to play when this sound event is triggered.


key: items

description: A sound file. This Object is used only when the sound requires additional Strings.


key: volume

description:
The volume for playing this sound. Value is a decimal between 0.0 and 1.0
Default is 1.0


key: pitch

description:
Plays the pitch at the specified value.
Default is 1.0


key: weight

description:
The chance that this sound is selected to play when this sound event is triggered.
Example: putting 2 in for the value would be like placing in the name twice.
Default is 1


key: stream

description:
True if this sound should be streamed from its file. It is recommended that this is set to "true" for sounds that have a duration longer than a few seconds to avoid lag. Used for all sounds in the "music" and "record" categories (except Note Block sounds), as (almost) all the sounds that belong to those categories are over a minute long. Setting this to false allows many more instances of the sound to be ran at the same time while setting it to true only allows 4 instances (of that type) to be ran at the same time.
Default is false


description:
Modify sound reduction rate based on distance. Used by portals, beacons, and conduits.
Default is 16


key: preload

description:
True if this sound should be loaded when loading the pack instead of when the sound is played. Used by the underwater ambience.
Default is false


key: type

description:
"sound" causes the value of "name" to be interpreted as the name of a file
"event" causes the value of "name" to be interpreted as the name of an already defined event.
Default is "sound"


key: editor

description:
An editor to modify cheatsheets
https://github.com/cheat/cheat#cheatpaths


key: colorize

description:
Whether cheatsheets should be colorized
https://github.com/cheat/cheat#cheatpaths


key: style

description:
A color schema applied for cheatsheets
https://github.com/cheat/cheat#cheatpaths

enum: abap algol algol_nu api arduino autumn average base16-snazzy borland bw catppuccin-frappe catppuccin-latte catppuccin-macchiato catppuccin-mocha colorful compat doom-one doom-one2 dracula emacs friendly fruity github github-dark gruvbox gruvbox-light hr_high_contrast hrdark igor lovelace manni modus-operandi modus-vivendi monokai monokailight murphy native nord onedark onesenterprise paraiso-dark paraiso-light pastie perldoc pygments rainbow_dash rose-pine rose-pine-dawn rose-pine-moon rrt solarized-dark solarized-dark256 solarized-light swapoff tango trac vim vs vulcan witchhazel xcode xcode-dark


key: formatter

description:
A formatter to format cheatsheets
https://github.com/cheat/cheat#cheatpaths


key: pager

description:
A pager to read long cheatsheets
https://github.com/cheat/cheat#cheatpaths

enum: less more


key: cheatpaths

description:
Cheatpaths
https://github.com/cheat/cheat#cheatpaths


description:
A cheatpath
https://github.com/cheat/cheat#cheatpaths


key: name

description:
A cheatpath name
https://github.com/cheat/cheat#cheatpaths


key: path

description:
A cheatpath path
https://github.com/cheat/cheat#cheatpaths


key: tags

description:
Cheatpath tags
https://github.com/cheat/cheat#cheatpaths


key: readonly

description:
Whether allow creating cheatsheets in a cheatpath
https://github.com/cheat/cheat#cheatpaths


description: JSON schema for MkDocs configuration file

default: gh-pages

default: origin

default: mkdocs

default: en

default: docs

default: site


description:
The main title for the project documentation.
https://www.mkdocs.org/user-guide/configuration/#site_name


description:
Set the canonical URL of the site. This will add a link tag with the canonical URL to the head section of each HTML page. If the 'root' of the MkDocs site will be within a subdirectory of a domain, be sure to include that subdirectory in the setting (https://example.com/foo/).
https://www.mkdocs.org/user-guide/configuration/#site_url


description:
When set, provides a link to your repository (GitHub, Bitbucket, GitLab, ...) on each page.
https://www.mkdocs.org/user-guide/configuration/#repo_url


description:
When set, provides the name for the link to your repository on each page.
https://www.mkdocs.org/user-guide/configuration/#repo_name


description:
The path from the base repo_url to the docs directory when directly viewing a page, accounting for specifics of the repository host (e.g. GitHub, Bitbucket, etc), the branch, and the docs directory itself.
https://www.mkdocs.org/user-guide/configuration/#edit_uri


description:
The more flexible variant of edit_uri.
https://www.mkdocs.org/user-guide/configuration/#edit_uri_template


description:
Set the site description. This will add a meta tag to the generated HTML header.
https://www.mkdocs.org/user-guide/configuration/#site_description


description:
Set the name of the author. This will add a meta tag to the generated HTML header.
https://www.mkdocs.org/user-guide/configuration/#site_author


key: copyright

description:
Set the copyright information to be included in the documentation by the theme.
https://www.mkdocs.org/user-guide/configuration/#copyright


description:
Set the remote branch to commit to when using gh-deploy to deploy to GitHub Pages. This option can be overridden by a command line option in gh-deploy.
https://www.mkdocs.org/user-guide/configuration/#remote_branch


description:
Set the remote name to push to when using gh-deploy to deploy to GitHub Pages. This option can be overridden by a command line option in gh-deploy.
https://www.mkdocs.org/user-guide/configuration/#remote_name


key: nav

description:
This setting is used to determine the format and layout of the global navigation for the site.
https://www.mkdocs.org/user-guide/configuration/#nav


key: theme

description:
Sets the theme and theme specific configuration of your documentation site.
https://www.mkdocs.org/user-guide/configuration/#theme


description: The string name of a known installed theme, or null if using a local custom theme.


key: locale

description: A code representing the language of your site.


description: A directory containing a custom theme. This can either be a relative directory, in which case it is resolved relative to the directory containing your configuration file or it can be an absolute directory path from the root of your local file system.


description: A list of templates to render as static pages. The templates must be located in either the theme's template directory or in the custom_dir defined in the theme configuration.


description:
The directory containing the documentation source markdown files. This can either be a relative directory, in which case it is resolved relative to the directory containing your configuration file, or it can be an absolute directory path from the root of your local file system.
https://www.mkdocs.org/user-guide/configuration/#docs_dir


description:
The directory where the output HTML and other files are created. This can either be a relative directory, in which case it is resolved relative to the directory containing your configuration file, or it can be an absolute directory path from the root of your local file system.
https://www.mkdocs.org/user-guide/configuration/#site_dir


description:
Set a list of CSS files in your docs_dir to be included by the theme. For example, the following example will include the extra.css file within the css subdirectory in your docs_dir.
https://www.mkdocs.org/user-guide/configuration/#extra_css


description:
Set a list of JavaScript files in your docs_dir to be included by the theme. See the example in extra_css for usage.
https://www.mkdocs.org/user-guide/configuration/#extra_javascript


description:
Set a list of templates in your docs_dir to be built by MkDocs. To see more about writing templates for MkDocs read the documentation about [custom themes] and specifically the section about the [available variables] to templates. See the example in extra_css for usage.
https://www.mkdocs.org/user-guide/configuration/#extra_templates


key: extra

description:
A set of key-value pairs, where the values can be any valid YAML construct, that will be passed to the template. This allows for great flexibility when creating custom themes.
https://www.mkdocs.org/user-guide/configuration/#extra


key: watch

description:
Determines additional directories to watch when running mkdocs serve.
https://www.mkdocs.org/user-guide/configuration/#watch


description:
This setting controls the style used for linking to pages within the documentation.
https://www.mkdocs.org/user-guide/configuration/#use_directory_urls


key: strict

description:
Determines how warnings are handled. Set to true to halt processing when a warning is raised. Set to false to print a warning and continue processing.
https://www.mkdocs.org/user-guide/configuration/#strict


description:
Determines the address used when running mkdocs serve. Must be of the format IP:PORT.
https://www.mkdocs.org/user-guide/configuration/#dev_addr


description:
This setting lets you enable a list of extensions beyond the ones that MkDocs uses by default (meta, toc, tables, and fenced_code).
https://www.mkdocs.org/user-guide/configuration/#markdown_extensions


key: hooks

description:
A list of paths to Python scripts (relative to mkdocs.yml) that are loaded and used as plugin instances.
https://www.mkdocs.org/user-guide/configuration/#hooks


key: plugins

description:
A list of plugins (with optional configuration settings) to use when building the site. See the Plugins documentation for full details.
https://www.mkdocs.org/user-guide/configuration/#plugins


key: INHERIT

description:
Define the parent for a configuration file. The path must be relative to the location of the primary file.
https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance


key: manifest

description: A stable URL that describes the latest release version of your manifest file. This URL is used for automatic module installation in the Foundry VTT setup screen. This manifest URL is consulted during the module update check to see whether a new version is available for download. It is important that this address remain stable, otherwise updates will not be detected.


key: library

description: The library field is a boolean that indicates whether the package is a library intended for other packages to depend on and consume. This field should be true if your package does not present any user-facing features, but rather provides functionality for other packages to utilize and rely upon. Packages with this field set to true may be hidden from third party package lists to avoid confusing users. When omitted the default value of this field is false.


key: coreTranslation

description: (undocumented)


key: newProjectRoot

description: Path where new projects will be created.


key: defaultProject

description: Default project name used in commands.


key: defaultCollection

description: The default schematics collection to use.


key: packageManager

description: Specify which package manager tool to use.

enum: npm cnpm yarn pnpm


key: warnings

description: Control CLI specific console warnings


key: versionMismatch

description: Show a warning when the global version is newer than the local one.


key: analytics

description: Share anonymous usage data with the Angular Team at Google.

type: boolean string


key: changeDetection

description: Specifies the change detection strategy.

enum: Default OnPush

default: Default

alias: c


key: displayBlock

description: Specifies if the style will contain `:host { display: block; }`.

alias: b


key: entryComponent

description: Specifies if the component is an entry component of declaring module.


key: export

description: Specifies if declaring module exports the component.


key: flat

description: Flag to indicate if a directory is created.


key: inlineStyle

description: Specifies if the style will be in the ts file.

alias: s


key: inlineTemplate

description: Specifies if the template will be in the ts file.

alias: t


key: module

description: Allows specification of the declaring module.

alias: m


key: prefix

description: The prefix to apply to generated selectors.

format: html-selector

alias: p


key: selector

description: The selector to use for the component.


key: skipImport

description: Flag to skip the module import.


key: style

description: The file extension or preprocessor to use for style files.

default: css

enum: css scss sass less styl


key: viewEncapsulation

description: Specifies the view encapsulation strategy.

enum: Emulated Native None ShadowDom

alias: v


key: skipTests

description: When true, does not create test files.


description: Specifies if declaring module exports the directive.


default: app


description: The selector to use for the directive.


key: routing

description: Generates a routing module.


key: routingScope

description: The scope for the generated routing.

enum: Child Root

default: Child


key: commonModule

description: Flag to control whether the CommonModule is imported.


description: Allows for skipping the module import.