Skip to content
PtahDocs
v0.8.1
Page type: reference

Atlas-compatible output and redaction

Template data shapes and credential redaction rules for ptah-compat format output.

Atlas-compatible --format output uses the Atlas data shape expected by existing templates. Each command page lists the fields its own report exposes; this page owns the shared URL and redaction behavior.

A URL rendered directly in a Go template is a redacted string:

{{ .Env.URL }}

{{ json . }} emits an Atlas-shaped URL object with these fields where they apply:

Scheme, User, Host, Path, RawQuery, Fragment, RawPath,
RawFragment, ForceQuery, OmitHost, Schema

Schema is present for SQLite URLs.

Ptah removes URL userinfo passwords. Query parameters whose keys look like passwords, tokens, secrets, or API keys are replaced with xxxxx before the URL reaches template output.

Redaction protects the recognized URL fields. A template can still print any other data the command intentionally exposes, so review custom formats before using them in shared CI logs.