Skip to content

pdk config

pdk config loads the same resolved project configuration used by Prodockit's build commands and reports the settings and local inputs it finds.

Synopsis

Use the reporting form interactively or add --check in automation.

pdk config [--config-file PATH] [--check]

Working directory

Run this command from the project root, where zensical.toml is located. Use --config-file PATH to inspect a different project configuration; paths inside that file are resolved relative to the configuration's directory.

From the wrong directory, the command exits with Error: project configuration not found: .../zensical.toml. Change directory or supply the intended configuration path.

Options

Table 40.1 lists the configuration-report controls.

1. Configuration-check options

Option Behaviour
-f, --config-file PATH Read another Zensical configuration; defaults to zensical.toml.
--check Exit non-zero for invalid settings or missing project inputs.
-h, --help Show installed help and exit.

Behaviour

Recognised Prodockit settings are checked for their value types. Write boolean values as true or false, without quotes; "false" is a string, not a boolean. Text settings such as [document].page_size require a string, and [document].extra_css requires a list of strings. Errors name the setting to correct. PDF generation also rejects these invalid types rather than silently changing their meaning.

Authoring syntax inside HTML comments is ignored, like examples inside code blocks. Only active syntax should require an extension. Diagnostics uses the same checks, so a commented-out reference does not trigger an extension repair.

PDF-only settings are read from pdk-pdf.toml. Legacy project.extra.pdf_* values remain readable as deprecated fallbacks; pdk-pdf.toml wins per setting, and pdk diag identifies values to migrate.

The command validates Prodockit settings, configured source files, navigation, stylesheets, JavaScript, citation style, and renderer paths without building the website or PDF. Check mode is suitable for CI because actionable findings produce a non-zero exit status.

The command is read-only. Use the reported setting path to correct the source configuration, or use pdk diag --apply when Diagnostics offers a specific bounded correction.

Use these commands when the configuration report identifies broader work:

  • pdk diag includes the configuration result within the complete project health report.
  • pdk pdf consumes the resolved PDF settings.