Configuration¶
PDK is configured through environment variables. To avoid setting them in every terminal, in the MCP server and in
the hook, they can be written in a TOML file, by default ~/.pdk/config.toml (another file can be pointed to with
PDK_CONFIG). A variable that is already set in the environment takes precedence over the file.
Settings¶
Key in |
Environment variable |
Default and meaning |
|---|---|---|
|
|
|
|
|
The standard install path of each operating system ( |
|
|
Read from |
|
|
|
|
|
|
|
|
The newest bundle. Which bundle to validate against when several are extracted; the |
|
|
On. Once a day PDK asks GitHub’s public API for the latest release and says when a newer one is out (on
the next command, in |
Example:
gateway_url = "http://127.0.0.1:8088"
ignition_home = "D:/Ignition"
pdk doctor reports which settings the file applied, and flags unknown keys.
Other variables¶
PDK_GATEWAY_TOKENThe module’s access token. Normally PDK reads it from
<ignition_home>/data/pdk-gateway.token, which the module rewrites on every start; set this variable only if that file is not readable by your user. On Linux and macOS the file is readable only by the gateway’s user and group: join that group, or set this variable.pdk gateway restartstill waits for the new token in the file, since this value does not change on restart.PDK_EYES_IDLE_SSeconds without use after which the MCP server closes its browser (default 120), releasing its Perspective session.
Gateway settings¶
The sandbox and the target project are not configured in PDK but on the gateway, in ignition.conf, so that a
client cannot change them:
-Dpdk.sandbox=<project>The only project PDK writes to. Without it the module is read-only.
-Dpdk.target=<project>Optional. The project that receives finished views through
promote --to-project target. It must differ from the sandbox; otherwise it is ignored.-Dignition.allowunsignedmodules=trueRequired because the PDK module is not signed.
The client reads the sandbox and target names from the module (uv run pdk gateway health).