Nixpacks Build Plan

The Nixpacks build plan is the JSON representation of how a source directory will be turned into a container image. A plan declares the list of providers used, top-level `variables`, `staticAssets`, `buildImage`, and an ordered set of phases (`setup`, `install`, `build`, plus any provider- or user-defined phases) along with a `start` phase. Each phase carries `cmds`, `nixPkgs`, `nixLibs`, `nixOverlays`, `nixpkgsArchive`, `aptPkgs`, `dependsOn`, `cacheDirectories`, `onlyIncludeFiles`, and `paths`. Plans can be saved and replayed via `nixpacks build --plan plan.json` to guarantee reproducible image builds.

Nixpacks Build Plan is one of 5 APIs that Nixpacks publishes on the APIs.io network.

Tagged areas include Build Plan, JSON, Phases, and Reproducible Builds. The published artifact set on APIs.io includes API documentation and an API reference.

API entry from apis.yml

apis.yml Raw ↑
aid: nixpacks:build-plan
name: Nixpacks Build Plan
description: The Nixpacks build plan is the JSON representation of how a source directory will be turned
  into a container image. A plan declares the list of providers used, top-level `variables`, `staticAssets`,
  `buildImage`, and an ordered set of phases (`setup`, `install`, `build`, plus any provider- or user-defined
  phases) along with a `start` phase. Each phase carries `cmds`, `nixPkgs`, `nixLibs`, `nixOverlays`,
  `nixpkgsArchive`, `aptPkgs`, `dependsOn`, `cacheDirectories`, `onlyIncludeFiles`, and `paths`. Plans
  can be saved and replayed via `nixpacks build --plan plan.json` to guarantee reproducible image builds.
humanURL: https://nixpacks.com/docs/how-it-works
tags:
- Build Plan
- JSON
- Phases
- Reproducible Builds
properties:
- type: Documentation
  url: https://nixpacks.com/docs/how-it-works
- type: Reference
  url: https://nixpacks.com/docs/configuration/file