Skip to content

ktock/vscode-buildx-debugger

Repository files navigation

vscode-buildx-debugger experiment

VS Code extension for interactive debugging of Dockerfile based on Docker Buildx (under proposal).

Features

  • Breakpoints and step execution
  • Inspecting steps
  • Interactive shell on a step with your own debugigng tools
  • Rootless execution

Requirements

Extension Settings

In the launch configuration (e.g. launch.json on VS Code), the following properties are provided.

  • program string REQUIRED : Absolute path to Dockerfile.
  • stopOnEntry boolean : Automatically stop after launch. (default: true)
  • target string : Target build stage to build.
  • build-args array : Build-time variables.
  • ssh array : Allow forwarding SSH agent to the build. Format: default|<id>[=<socket>|<key>[,<key>]]
  • secrets array : Expose secret value to the build. Format: id=secretname,src=filepath
  • root string : Root directory for controller server.
  • controller-mode string : Mode to launch the controller (local vs remote(default))
  • server-config string : Path to the controller server configuration file.

Common and mandatory properties are the following (see VS Code documentation for details).

  • type : Type of debugger to use. Must be dockerfile.
  • request : The request type. launch is only supported as of now.
  • name : The reader-friendly name of this configuration.

Known Issues

Release Notes

TBD