Environment Variables

Arkenv allows parsing arguments with environment variables.

The EnvironmentVariableFeature is installed by default.


val port: Int by argument()

The corresponding environment variable will then be called PORT.

Either rely on the default name that is derived from the property name, or specify names in the argument call.

Additional names

Provide additional names for the argument as shown below. Arkenv accepts a variety of different formats.

val port: Int by argument("--additional-name", "additionalName", "ADDITIONAL_NAME")


Env prefix

Define a prefix that applies to all environment variable names.

The previous port example will then become SOME_PREFIX_PORT.

  • Argument: --arkenv-env-prefix
  • Code: EnvironmentVariableFeature(envPrefix = "some_prefix")
Dot env files
Docker Secrets