Optional app.yml manifest for Snowflake App Runtime¶

The optional app.yml manifest tells the remote build how to install, build, run, and package your application, along with optional profile metadata. When you don’t provide it, Snowflake auto-detects build and run behavior from your project layout (for example, package.json for Node.js). Hand-edit app.yml when you need to customize those install, build, run, or packaging steps, or to set the app’s display profile. Name the file app.yml and place it in your application source.

For deploy configuration, the Snowflake CLI uses a separate snowflake.yml project file that snow app setup creates and snow app deploy reads. See Getting started with Snowflake App Runtime and snow app setup.

app.yml reference¶

Top-level structure¶

install:
  commands:
    - [ <command>, <arg>, ... ]
build:
  commands:
    - [ <command>, <arg>, ... ]
run:
  command: [ <command>, <arg>, ... ]
artifacts:
  - src: <glob_pattern>
    dest: <destination_path>
profile:
  icon: <relative_path_to_icon>
  label: <display_label>
  description: <description_text>

All top-level keys are optional. Snowflake ignores unknown keys.

Keys¶

install¶

Commands Snowflake runs during the install phase, before the build. Each entry under commands is an argv-style list, passed directly without a shell. Use install for setup steps such as installing dependencies.

install:
  commands:
    - [ npm, ci ]

build¶

Commands Snowflake runs during the build phase. Each entry under commands is an argv-style list.

build:
  commands:
    - [ npm, run, build ]

run¶

The entry-point command that starts the application container. command is an argv-style list.

run:
  command: [ node, server.js ]

artifacts¶

Copy rules that move files produced by the build into the final package. Each entry has these fields:

• src: Glob pattern, relative to the build working directory, that matches the files to copy. The pattern supports ** for recursive matching (provided by the doublestar library). For example, dist/** matches every file under dist at any depth.
• dest: Destination path within the package. Set dest to . to flatten matched files into the package root by basename. Set dest to any other path to preserve the directory structure of the matched files relative to the glob base, rooted at dest.

Only files that match the glob are copied; directories themselves aren’t copied. To include a directory tree, use **.

artifacts:
  - src: "dist/**"
    dest: "."
  - src: "package.json"
    dest: "."

profile¶

Presentation metadata surfaced alongside the deployed service.

• icon: Relative path to a .png or .svg file inside the package. The path must not contain ...
• label: Short display label.
• description: Longer human-readable description.

The label and description values appear in the additional_properties column of SHOW APPLICATION SERVICES.

profile:
  icon: assets/logo.png
  label: Customer Portal
  description: Web UI for the customer-facing portal.

Validation during remote build¶

When your project includes app.yml and you run a remote build (for example snow app deploy or an artifact build that reads uploaded source), Snowflake loads and validates the manifest from the stage. If the file is missing, Snowflake can still auto-detect build and run behavior from your project layout.

If app.yml is present but invalid, the build fails before a new package version is published. Common causes include:

• YAML syntax errors.
• Invalid profile.icon values (path traversal, absolute paths, or unsupported image formats).

The error message includes parser details, for example:

Application service manifest (app.yaml) cannot be parsed. '<details>'.

Example¶

install:
  commands:
    - [ npm, ci ]
build:
  commands:
    - [ npm, run, build ]
run:
  command: [ node, dist/server.js ]
artifacts:
  - src: "dist/**"
    dest: "."
profile:
  icon: assets/logo.png
  label: Customer Portal
  description: Customer portal web UI.