Skip to content

channel <name>

Definition of and configuration for an auto-update channel.

Used by: <manifest>


Block Description
darwin { … } Darwin-specific configuration.
linux { … } Linux-specific configuration.
on <event> { … } Triggers to run on lifecycle events.
platform <attr> { … } Platform-specific configuration. <attr> is a set regexes that must all match against one of CPU, OS, etc..


Attribute Type Description
apps [string]? Relative paths to Mac .app packages to install.
arch string? CPU architecture to match (amd64, 386, arm, etc.).
binaries [string]? Relative glob from $root to individual terminal binaries.
dest string? Override archive extraction destination for package.
dont-extract boolean? Don't extract the package source, just copy it into the installation directory.
env {string: string}? Environment variables to export.
files {string: string}? Files to load strings from to be used in the manifest.
mirrors [string]? Mirrors to use if the primary source is unavailable.
mutable boolean? Package will not be made read-only.
provides [string]? This package provides the given virtual packages.
rename {string: string}? Rename files after unpacking to ${root}.
requires [string]? Packages this one requires.
root string? Override root for package.
runtime-dependencies [string]? Packages used internally by this package, but not installed to the target environment
sha256 string? SHA256 of source package for verification. When in conflict with SHA256 in sha256sums, this value takes precedence.
sha256-source string? URL for SHA256 checksum file for source package.
source string? URL for source package. Valid URLs are Git repositories (using .git[#<tag>] suffix), Local Files (using file:// prefix), and Remote Files (using http:// or https:// prefix)
strip number? Number of path prefix elements to strip.
test string? Command that will test the package is operational.
update string Update frequency for this channel.
vars {string: string}? Set local variables used during manifest evaluation.
version string? Use the latest version matching this version glob as the source of this channel. Empty string matches all versions