API Reference / @gtkx/config / @gtkx/config / DeployFlatpakOptions

Type Alias: DeployFlatpakOptions ​

DeployFlatpakOptions = object

Defined in: packages/config/src/deploy.ts:546

The deploy.flatpak options: runtime, sandbox permissions, build and distribution of the Flatpak.

Properties ​

base? ​

optional base?: string

Defined in: packages/config/src/deploy.ts:588

Optional Flatpak base application ID.

Default Value ​

None: the manifest has no base

baseVersion? ​

optional baseVersion?: string

Defined in: packages/config/src/deploy.ts:594

Branch of the base application.

Default Value ​

None: the manifest has no base-version

branch? ​

optional branch?: string

Defined in: packages/config/src/deploy.ts:600

Exported application branch.

Default Value ​

"stable"

buildCommands? ​

optional buildCommands?: string[]

Defined in: packages/config/src/deploy.ts:624

Additional shell commands appended to the application's Flatpak build commands.

Default Value ​

[]

cleanup? ​

optional cleanup?: string[]

Defined in: packages/config/src/deploy.ts:618

Patterns added to the cleanup defaults. An empty array disables cleanup.

Default Value ​

[], on top of /include, /share/pkgconfig, *.la and *.a

finishArgs? ​

optional finishArgs?: string[]

Defined in: packages/config/src/deploy.ts:612

Sandbox permissions added to the defaults. A negation such as --nosocket=fallback-x11 removes the matching default.

Default Value ​

[], on top of --share=ipc, --socket=wayland, --socket=fallback-x11 and --device=dri

Example ​

ts
finishArgs: ["--share=network", "--filesystem=xdg-documents"],

lockfile? ​

optional lockfile?: string

Defined in: packages/config/src/deploy.ts:649

Lockfile path relative to the project root.

Default Value ​

The package manager's standard lockfile, such as pnpm-lock.yaml

mode? ​

optional mode?: "prebuilt" | "source"

Defined in: packages/config/src/deploy.ts:552

Package local build output or build from a pinned Git source inside the SDK.

Default Value ​

"prebuilt"

modules? ​

optional modules?: unknown[]

Defined in: packages/config/src/deploy.ts:630

Additional Flatpak manifest modules built before the application module.

Default Value ​

[]

nodeExtension? ​

optional nodeExtension?: string

Defined in: packages/config/src/deploy.ts:576

Node.js SDK extension used in source mode.

Default Value ​

"org.freedesktop.Sdk.Extension.node26"

packageManager? ​

optional packageManager?: "npm" | "pnpm" | "yarn"

Defined in: packages/config/src/deploy.ts:643

Package manager used for offline source builds.

Default Value ​

Detected from the first lockfile found: pnpm-lock.yaml, yarn.lock, then package-lock.json

runtime? ​

optional runtime?: string

Defined in: packages/config/src/deploy.ts:558

Flatpak runtime ID.

Default Value ​

"org.gnome.Platform"

runtimeRepo? ​

optional runtimeRepo?: string

Defined in: packages/config/src/deploy.ts:655

Runtime repository URL embedded in the bundle.

Default Value ​

"https://dl.flathub.org/repo/flathub.flatpakrepo"

runtimeVersion? ​

optional runtimeVersion?: string

Defined in: packages/config/src/deploy.ts:564

Flatpak runtime branch.

Default Value ​

"51"

sdk? ​

optional sdk?: string

Defined in: packages/config/src/deploy.ts:570

Build SDK ID.

Default Value ​

"org.gnome.Sdk"

sdkExtensions? ​

optional sdkExtensions?: string[]

Defined in: packages/config/src/deploy.ts:582

Additional SDK extension IDs included in the build environment.

Default Value ​

[]

shouldEmitBundle? ​

optional shouldEmitBundle?: boolean

Defined in: packages/config/src/deploy.ts:661

Emit a .flatpak bundle in addition to the local repository.

Default Value ​

true

shouldInstall? ​

optional shouldInstall?: boolean

Defined in: packages/config/src/deploy.ts:667

Install the built application into the current user's Flatpak installation.

Default Value ​

false

shouldUseRofilesFuse? ​

optional shouldUseRofilesFuse?: boolean

Defined in: packages/config/src/deploy.ts:673

Allow flatpak-builder to use rofiles-fuse. Set to false where FUSE is unavailable.

Default Value ​

true

source? ​

optional source?: DeployFlatpakSourceOptions

Defined in: packages/config/src/deploy.ts:636

Git repository and revision used for source builds.

Default Value ​

{}: the origin remote at the tagged or current commit