Workstation API - v0.6.2
    Preparing search index...

    Interface ConfigDefinition

    A composable configuration fragment. Prefer the exported helpers to constructing resources manually.

    interface ConfigDefinition {
        afterApply?: readonly TaskDefinition[];
        aliases?: Readonly<Record<string, string>>;
        id?: string;
        machines?: Readonly<Record<string, ResourceInput>>;
        managers?: Partial<
            Record<
                Platform,
                | "mise"
                | "brew"
                | "brew-cask"
                | "apt"
                | "dnf"
                | "yum"
                | "pacman"
                | "flatpak"
                | "mas",
            >,
        >;
        resources?: ResourceInput;
        stateFile?: string;
        tasks?: Readonly<Record<string, TaskDefinition>>;
    }
    Index
    afterApply? aliases? id? machines? managers? resources? stateFile? tasks?
    afterApply?: readonly TaskDefinition[]

    Commands run sequentially after successful build/upgrade, including no-change runs. Fragments append in order.

    aliases?: Readonly<Record<string, string>>

    Alternate task names; alias chains are supported and cycles rejected.

    id?: string

    Stable state namespace; set only with an explicit migration from existing path-based state.

    machines?: Readonly<Record<string, ResourceInput>>

    Additional resources keyed by exact machine name.

    managers?: Partial<
        Record<
            Platform,
            | "mise"
            | "brew"
            | "brew-cask"
            | "apt"
            | "dnf"
            | "yum"
            | "pacman"
            | "flatpak"
            | "mas",
        >,
    >

    Default package manager for tools.system on each platform.

    resources?: ResourceInput

    Shared resource declarations, evaluated in order.

    stateFile?: string

    Local ownership/backup state path. Defaults to a configuration/machine namespace under ~/.local/state/workstation/configs; do not commit it.

    tasks?: Readonly<Record<string, TaskDefinition>>

    Named commands executed explicitly with workstation .

    Settings
    Member Visibility

    On This Page
    Properties