Path to the directory storing the hooks

The pre-exit hook will run just before your build job finishes

The command hook script will replace the default implementation of running the build command.

The pre-command hook will run just before your build command runs

The post-command hook will run after the bootstrap script has run your build commands

The pre-artifact hook will run just before artifacts are uploaded

The post-artifact hook will run just after artifacts are uploaded

The pre-checkout hook will run just before your projects source code is checked out from your SCM provider

The checkout hook script will replace the default checkout routine of the bootstrap.sh script

The post-checkout hook will run after the bootstrap script has checked out your projects source code.

The environment hook will run before all other commands, and can be used to set up secrets, data, etc

The name of the agent as seen in the buildkite dashboard.

Packages added to the service's PATH environment variable

Shell commands executed as the service's main process.

Packages added to the service's PATH environment variable

Tags for the agent.

The token from your Buildkite "Agents" page

Command executed as the service's main process.

The workdir for the agent

Shell commands executed as the service's main process.

Command that buildkite-agent 3 will execute when it spawns a shell.

Command executed as the service's main process.

Whether to enable this buildkite agent

Which buildkite-agent derivation to use

Extra lines to be added verbatim to the configuration file.

Each attribute in this set specifies an option for a key in the plist. https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man5/launchd.plist.5.html

Attribute set of buildkite agents

Extra commands to run before starting buildkite.

Each attribute in this set specifies an option for a key in the plist. https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man5/launchd.plist.5.html

This optional key specifies what nice(3) value should be applied to the daemon.

OpenSSH private key

A run-time path to the key file, which is supposed to be provisioned outside of Nix store.

This required key uniquely identifies the job to launchd.

This optional key can be used to request that the service be registered with the mDNSResponder(8)

This optional key specifies the node to connect(2) or bind(2) to.

This optional key tells launchctl what type of socket to create

This optional key specifies what nice(3) value should be applied to the daemon.

This optional key specifies that launchd should adjust its log mask temporarily to LOG_DEBUG while dealing with this job.

This optional key implies SockFamily is set to "Unix"

This optional key is used to control whether your job is launched once at the time the job is loaded

This optional key specifies the user to run the job as

This optional key can be used to request that the service be registered with the mDNSResponder(8)

This required key uniquely identifies the job to launchd.

This optional key specifies the node to connect(2) or bind(2) to.

This optional key can be used to specifically request that "IPv4" or "IPv6" socket(s) be created.

This optional key specifies the mode of the socket

Add programs to the buildkite-agent environment

This optional key tells launchctl what type of socket to create

The recommended idle time out (in seconds) to pass to the job

This optional key implies SockFamily is set to "Unix"

This optional key specifies that launchd should adjust its log mask temporarily to LOG_DEBUG while dealing with this job.

This optional key causes the job to be started if any one of the listed paths are modified.

This optional key can be used to specifically request that "IPv4" or "IPv6" socket(s) be created.

This optional key specifies the mode of the socket

Environment variables passed to the service's processes.

This optional key is used to control whether your job is launched once at the time the job is loaded

The amount of time launchd waits before sending a SIGKILL signal

This optional key specifies the user to run the job as

This optional key causes the job to be started every time a filesystem is mounted.

This optional key specifies what value should be passed to umask(2) before running the job

This optional key specifies the service on the node to connect(2) or bind(2) to.

This optional key specifies whether listen(2) or connect(2) should be called on the created file descriptor

The recommended idle time out (in seconds) to pass to the job

This optional key specifies the protocol to be passed to socket(2)

This optional key causes the job to be started if any one of the listed paths are modified.

Environment variables passed to the service's processes.

This optional key specifies the service on the node to connect(2) or bind(2) to.

This optional key specifies the group to run the job as

The amount of time launchd waits before sending a SIGKILL signal

This optional key causes the job to be started every time a filesystem is mounted.

This optional key specifies what value should be passed to umask(2) before running the job

This optional key specifies whether listen(2) or connect(2) should be called on the created file descriptor

This optional key specifies whether the job participates in advanced communication with launchd

This optional key specifies the protocol to be passed to socket(2)

This configuration file only applies to the hosts listed with this key

This optional key specifies whether initgroups(3) should be called before running the job

This key was used in Mac OS X 10.4 to control whether a job was kept alive or not

This optional key specifies the group to run the job as

This optional key is a variant of SockPathName

This optional key specifies whether the job can only be run once and only once

This key maps to the first argument of execvp(3)

This configuration file only applies to hosts NOT listed with this key

This optional key specifies whether the kernel should consider this daemon to be low priority when doing file system I/O.

This optional key specifies whether the job participates in advanced communication with launchd

This optional key specifies what file should be used for data being supplied to stdin when using stdio(3).

This configuration file only applies to the hosts listed with this key

This optional key specifies whether initgroups(3) should be called before running the job

This key was used in Mac OS X 10.4 to control whether a job was kept alive or not

This optional key is a variant of SockPathName

This optional key specifies what file should be used for data being sent to stdout when using stdio(3).

This optional key specifies that launchd should instruct the kernel to have the job wait for a debugger to attach before any code in the job is executed.

This optional key specifies whether the job can only be run once and only once

This key maps to the first argument of execvp(3)

This configuration file only applies to hosts NOT listed with this key

This optional key specifies whether the kernel should consider this daemon to be low priority when doing file system I/O.

This optional key is used to specify a directory to chroot(2) to before running the job.

This key specifies that the job should be spawned into a new security audit session rather than the default session for the context is belongs to

This optional key specifies what file should be used for data being supplied to stdin when using stdio(3).

This optional key specifies what file should be used for data being sent to stderr when using stdio(3).

This flag causes launchd to use the glob(3) mechanism to update the program arguments before invocation.

This optional key specifies what file should be used for data being sent to stdout when using stdio(3).

This optional key is used to specify Mach services to be registered with the Mach bootstrap sub-system

This configuration file only applies to sessions of the type specified

This optional key specifies that launchd should instruct the kernel to have the job wait for a debugger to attach before any code in the job is executed.

This optional key is used to specify a directory to chroot(2) to before running the job.

The maximum amount of cpu time (in seconds) to be used by each process.

The maximum amount of cpu time (in seconds) to be used by each process.

This key specifies that the job should be spawned into a new security audit session rather than the default session for the context is belongs to

Resource limits to be imposed on the job

Resource limits to be imposed on the job

This optional key is used to specify Mach services to be registered with the Mach bootstrap sub-system

This flag causes launchd to use the glob(3) mechanism to update the program arguments before invocation.

This optional key specifies what file should be used for data being sent to stderr when using stdio(3).

This configuration file only applies to sessions of the type specified

The largest size (in bytes) core file that may be created.

The largest size (in bytes) core file that may be created.

This optional key can be used to request that the datagram socket join a multicast group

The largest size (in bytes) file that may be created.

The largest size (in bytes) file that may be created.

The maximum amount of cpu time (in seconds) to be used by each process.

The maximum amount of cpu time (in seconds) to be used by each process.

When a job dies, launchd kills any remaining processes with the same process group ID as the job

Resource limits to be imposed on the job

Resource limits to be imposed on the job

This optional key is used to specify a directory to chdir(2) to before running the job.

This optional key can be used to request that the datagram socket join a multicast group

The largest size (in bytes) core file that may be created.

The largest size (in bytes) core file that may be created.

This optional key causes the job to be started every N seconds

The maximum size (in bytes) of the data segment for a process; this defines how far a program may extend its break with the sbrk(2) system call.

The maximum size (in bytes) of the data segment for a process; this defines how far a program may extend its break with the sbrk(2) system call.

The largest size (in bytes) file that may be created.

The largest size (in bytes) file that may be created.

When a job dies, launchd kills any remaining processes with the same process group ID as the job

This optional key is used to specify a directory to chdir(2) to before running the job.

This optional key causes the job to be started every N seconds

The maximum size (in bytes) of the stack segment for a process; this defines how far a program's stack segment may be extended

The maximum size (in bytes) of the stack segment for a process; this defines how far a program's stack segment may be extended

The maximum size (in bytes) of the data segment for a process; this defines how far a program may extend its break with the sbrk(2) system call.

The maximum size (in bytes) of the data segment for a process; this defines how far a program may extend its break with the sbrk(2) system call.

The maximum size (in bytes) which a process may lock into memory using the mlock(2) function.

The maximum size (in bytes) which a process may lock into memory using the mlock(2) function.

Specifies higher-level event types to be used as launch-on-demand event sources

This key maps to the second argument of execvp(3)

The maximum size (in bytes) of the stack segment for a process; this defines how far a program's stack segment may be extended

The maximum size (in bytes) of the stack segment for a process; this defines how far a program's stack segment may be extended

Much like the WatchPaths option, this key will watch the paths for modifications

The maximum size (in bytes) which a process may lock into memory using the mlock(2) function.

The maximum size (in bytes) which a process may lock into memory using the mlock(2) function.

Specifies higher-level event types to be used as launch-on-demand event sources

This key maps to the second argument of execvp(3)

This optional key is used to control whether your job is to be kept continuously running or to let demand and conditions control the invocation

Much like the WatchPaths option, this key will watch the paths for modifications

This key lets one override the default throttling policy imposed on jobs by launchd

This optional key is used to control whether your job is to be kept continuously running or to let demand and conditions control the invocation

The maximum number of open files for this process

The maximum number of open files for this process

This optional key specifies whether the kernel should consider this daemon to be low priority when doing file system I/O when the process is throttled with the Darwin-background classification.

This key lets one override the default throttling policy imposed on jobs by launchd

The presence of this key specifies that the daemon expects to be run as if it were launched from inetd.

This optional key specifies whether the kernel should consider this daemon to be low priority when doing file system I/O when the process is throttled with the Darwin-background classification.

The maximum number of open files for this process

The maximum number of open files for this process

This optional key is used to specify additional environment variables to be set before running the job.

This optional key is used to specify launch on demand sockets that can be used to let launchd know when to run the job

The presence of this key specifies that the daemon expects to be run as if it were launched from inetd.

This optional key is used to specify additional environment variables to be set before running the job.

This optional key is used to specify launch on demand sockets that can be used to let launchd know when to run the job

This flag instructs launchd that the job promises to use vproc_transaction_begin(3) and vproc_transaction_end(3) to track outstanding transactions that need to be reconciled before the process can safely terminate

The maximum size (in bytes) to which a process's resident set size may grow

The maximum size (in bytes) to which a process's resident set size may grow

This optional key describes, at a high level, the intended purpose of the job

This flag instructs launchd that the job promises to use vproc_transaction_begin(3) and vproc_transaction_end(3) to track outstanding transactions that need to be reconciled before the process can safely terminate

The maximum size (in bytes) to which a process's resident set size may grow

The maximum size (in bytes) to which a process's resident set size may grow

The maximum number of simultaneous processes for this user id

The maximum number of simultaneous processes for this user id

This optional key describes, at a high level, the intended purpose of the job

This flag corresponds to the "wait" or "nowait" option of inetd

The maximum number of simultaneous processes for this user id

The maximum number of simultaneous processes for this user id

The name of the user account

This optional key is used as a hint to launchctl(1) that it should not submit this job to launchd when loading a job or jobs

This flag corresponds to the "wait" or "nowait" option of inetd

This optional key causes the job to be started every calendar interval as specified

This optional key is used as a hint to launchctl(1) that it should not submit this job to launchd when loading a job or jobs

This optional key causes the job to be started every calendar interval as specified

The group's name

Name of the runner to configure

The name of the cask to install.

The name of the formula to install.

Agent name, usually the same as the hostname.

When clone_target is unspecified, this is the name of a formula repository to tap from GitHub using HTTPS

The user's UID.

The user's primary group.

The group's GID.

Name of the local AutoSSH session

Name of symlink

The flake reference from is rewritten to.

Replace any existing runner with the same name

Whether to make the user account hidden.

Name of symlink

The flake reference to be rewritten.

Name of symlink

The user's home directory

Name of the user to ensure.

Create the home directory when creating the user.

A short description of the user account, typically the user's full name

The flake input from is rewritten to.

The group's members.

The set of system-wide known SSH hosts

Name of symlink

This optional key can be used to request that the service be registered with the mDNSResponder(8)

The user's shell

Name of symlink

Name of the runner group to add this runner to (defaults to the default runner group)

Definition of per-user launchd agents

Whether the from reference needs to match exactly

Name of symlink

The set of packages that should be made availabe to the user

Name of symlink

This optional key specifies the node to connect(2) or bind(2) to.

Packages added to the service's PATH environment variable

This optional key tells launchctl what type of socket to create

This optional key implies SockFamily is set to "Unix"

Definition of per-user launchd agents

This optional key can be used to specifically request that "IPv4" or "IPv6" socket(s) be created.

Shell commands executed as the service's main process.

This optional key specifies the mode of the socket

Text of the file.

User under which to run the service

Group under which to run the service

This optional key specifies the service on the node to connect(2) or bind(2) to.

This optional key specifies whether listen(2) or connect(2) should be called on the created file descriptor

Command executed as the service's main process.

Text of the file.

The github-runner package to use.

This optional key specifies the protocol to be passed to socket(2)

Text of the file.

Tag list.

Working directory, available as $GITHUB_WORKSPACE during workflow runs and used as a default for repository checkouts

Path of the source file.

Whether to enable GitHub Actions runner

Repository to add the runner to

This optional key is a variant of SockPathName

Extra labels in addition to the default (unless disabled through the noDefaultLabels option)

Whether this file should be generated

Path of the source file.

Limit how many jobs can be handled concurrently by this service. 0 (default) simply means don't limit.

List of Node.js runtimes the runner should support.

Overwrite the URL for the GitLab instance

Path of the source file.

Whether this file should be generated

Docker image to be used.

Absolute path to a directory where builds will be stored in context of selected executor (Locally, Docker, SSH).

Each attribute in this set specifies an option for a key in the plist. https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man5/launchd.plist.5.html

Extra packages to add to PATH of the service to make them available to workflows.

Whether this file should be generated

The group's description.

Runner-specific command script executed before code is pulled.

Disables adding the default labels

This optional key can be used to request that the datagram socket join a multicast group

The public key data for the host

A list of additional host names and/or IP numbers used for accessing the host's ssh service

Runner-specific command script executed after code is pulled, just before build executes.

This optional key specifies what nice(3) value should be applied to the daemon.

Text of the file.

Add a custom host-to-IP mapping.

Runner-specific command script executed after code is pulled and just after build executes.

The full path to a file which contains either

• a fine-grained personal access token (PAT),
• a classic PAT
• or a runner registration token

Changing this option or the tokenFile’s content triggers a new runner registration

Select executor, eg. shell, docker, etc

This required key uniquely identifies the job to launchd.

Register to run untagged builds; defaults to true when tagList is empty.

By default, nix-darwin will check that programs

Bind-mount a volume and create it if it doesn't exist prior to mounting.

Text of the file.

This optional key specifies that launchd should adjust its log mask temporarily to LOG_DEBUG while dealing with this job.

When set to true Runner will only run on pipelines triggered on protected branches.

This optional key is used to control whether your job is launched once at the time the job is loaded

This optional key specifies the user to run the job as

Disable all container caching.

Path of the source file.

Text of the file.

Modify the service

This public key is an SSH certificate authority, rather than an individual host's key.

The recommended idle time out (in seconds) to pass to the job

Text of the file.

Whitelist allowed images.

The user-friendly name for the system, set in System Preferences > Sharing > Computer Name

The path to the public key file for the host

What is the maximum timeout (in seconds) that will be set for job when using this Runner. 0 (default) simply means don't limit.

This optional key is used to specify Mach services to be registered with the Mach bootstrap sub-system

List of store paths to make accessible.

This optional key causes the job to be started if any one of the listed paths are modified.

When set to true Runner will disable the possibility of using the CI_DEBUG_TRACE feature.

This optional key specifies what value should be passed to umask(2) before running the job

The amount of time launchd waits before sending a SIGKILL signal

This optional key causes the job to be started every time a filesystem is mounted.

Whether this file should be generated

Path of the source file.

Environment variables passed to the service's processes.

Extra environment variables to set for the runner, as an attrset.

Regex substring to match the app name (optional).

This optional key specifies the group to run the job as

Whether this file should be generated

Path of the source file.

Path of the source file.

Give extended privileges to container.

List of DNS servers for this interface.

Whitelist allowed services.

This optional key specifies whether the job participates in advanced communication with launchd

MTU to set for this interface, automatically set if not specified

List of commands to run before interface setup.

This key was used in Mac OS X 10.4 to control whether a job was kept alive or not

This optional key specifies whether initgroups(3) should be called before running the job

Whether this file should be generated

This configuration file only applies to the hosts listed with this key

If enabled, causes the following behavior:

• Passes the --ephemeral flag to the runner configuration script
• De-registers and stops the runner with GitHub after it has processed one job
• Restarts the service after its successful exit
• On start, wipes the state directory and configures a new runner

You should only enable this option if tokenFile points to a file which contains a personal access token (PAT)

Whether this file should be generated

List of commands to run after interface setup.

This key maps to the first argument of execvp(3)

This optional key specifies whether the job can only be run once and only once

List of commands to run before interface shutdown.

Whether to allow read access to FHS paths like /etc and /var.

List of peers associated with this interface.

This configuration file only applies to hosts NOT listed with this key

List of paths that should be read-only inside the sandbox.

This optional key specifies whether the kernel should consider this daemon to be low priority when doing file system I/O.

List of paths that should be read/write inside the sandbox.

List of commands to run after interface shutdown

This optional key specifies what file should be used for data being supplied to stdin when using stdio(3).

This optional key specifies what file should be used for data being sent to stdout when using stdio(3).

This optional key specifies that launchd should instruct the kernel to have the job wait for a debugger to attach before any code in the job is executed.

This optional key is used to specify a directory to chroot(2) to before running the job.

This key specifies that the job should be spawned into a new security audit session rather than the default session for the context is belongs to

Limit number of concurrent requests for new jobs from GitLab.

This flag causes launchd to use the glob(3) mechanism to update the program arguments before invocation.

This optional key specifies what file should be used for data being sent to stderr when using stdio(3).

Port to listen on, randomly selected if not specified.

This configuration file only applies to sessions of the type specified

List of IP addresses for this interface.

A list of verbatim OpenSSH public keys that should be added to the user's authorized keys

A list of files each containing one OpenSSH public key that should be added to the user's authorized keys

The set of system-wide known SSH hosts

The maximum amount of cpu time (in seconds) to be used by each process.

The maximum amount of cpu time (in seconds) to be used by each process.

Extra command-line flags passed to gitlab-runner register

The local hostname, or local network name, is displayed beneath the computer's name at the top of the Sharing preferences pane

Resource limits to be imposed on the job

Resource limits to be imposed on the job

The largest size (in bytes) core file that may be created.

The largest size (in bytes) core file that may be created.

The public key for this peer.

Controls the routing table to which routes are added

The fully qualified domain name (FQDN) of this host

The largest size (in bytes) file that may be created.

The largest size (in bytes) file that may be created.

Path to file containing this interface's private key.

Whether to allow network access inside the sandbox.

Either the fully qualified domain name (FQDN), or just the host name if it does not exists

When a job dies, launchd kills any remaining processes with the same process group ID as the job

This optional key causes the job to be started every N seconds

This optional key is used to specify a directory to chdir(2) to before running the job.

The maximum size (in bytes) of the data segment for a process; this defines how far a program may extend its break with the sbrk(2) system call.

The maximum size (in bytes) of the data segment for a process; this defines how far a program may extend its break with the sbrk(2) system call.

List of IP addresses associated with this peer.

Custom environment variables injected to build environment

Whether to bring up this interface automatically during boot.

IP and port to connect to this peer at.

Whether to allow localhost network access inside the sandbox.

The maximum size (in bytes) of the stack segment for a process; this defines how far a program's stack segment may be extended

The maximum size (in bytes) of the stack segment for a process; this defines how far a program's stack segment may be extended

Absolute path to a file with environment variables used for gitlab-runner registration

Specifies higher-level event types to be used as launch-on-demand event sources

The maximum size (in bytes) which a process may lock into memory using the mlock(2) function.

The maximum size (in bytes) which a process may lock into memory using the mlock(2) function.

This key maps to the second argument of execvp(3)

This optional key is used to control whether your job is to be kept continuously running or to let demand and conditions control the invocation

Multiple GitHub Runners

Much like the WatchPaths option, this key will watch the paths for modifications

List of Homebrew formula repositories to tap

List of Homebrew formulae to install

List of Homebrew casks to install

Optional, path to file containing the pre-shared key for this peer.

This key lets one override the default throttling policy imposed on jobs by launchd

The maximum number of open files for this process

The maximum number of open files for this process

This optional key specifies whether the kernel should consider this daemon to be low priority when doing file system I/O when the process is throttled with the Darwin-background classification.

This optional key is used to specify launch on demand sockets that can be used to let launchd know when to run the job

The presence of this key specifies that the daemon expects to be run as if it were launched from inetd.

This optional key is used to specify additional environment variables to be set before running the job.

The maximum size (in bytes) to which a process's resident set size may grow

The maximum size (in bytes) to which a process's resident set size may grow

This optional key describes, at a high level, the intended purpose of the job

This flag instructs launchd that the job promises to use vproc_transaction_begin(3) and vproc_transaction_end(3) to track outstanding transactions that need to be reconciled before the process can safely terminate

Additional arguments passed to each module in addition to ones like lib, config, and pkgs, modulesPath

The maximum number of simultaneous processes for this user id

The maximum number of simultaneous processes for this user id

This optional key is used as a hint to launchctl(1) that it should not submit this job to launchd when loading a job or jobs

This flag corresponds to the "wait" or "nowait" option of inetd

Interval in seconds to send keepalive packets

This optional key causes the job to be started every calendar interval as specified

Data Source Name for tracking of all system level errors to Sentry.

Name of the user the AutoSSH session should run as

Use the given name instead of the hostname to identify ourselves to the server.

Use the given name instead of the hostname to identify this screen in the configuration.

Defines the mapping from system users to database users

Keep folders on top when sorting by name

The path to the nixpkgs sources used to build the system

Keep folders on top when sorting by name on the desktop

Ensures that the specified users exist and have at least the ensured permissions

The workspace name to match (optional).

Map workspaces to specific monitors

Apple menu > System Preferences > Users and Groups > Login Options

Displays login window as a name and password field instead of a list of users