Skip to content

Environment Variables

Pakyas follows the standard 12-factor app configuration principles.

VariableDescription
PAKYAS_API_KEYYour API Key (pk_live_... or pk_test_...). Required unless using --public_id.
PAKYAS_PUBLIC_IDCheck UUID for --public_id flag. No authentication required when using this.
PAKYAS_ORG(Optional) Organization slug or ID to scope checks to.
PAKYAS_PROJECT(Optional) Project slug or ID to scope checks to.

These variables affect the behavior of the pakyas CLI.

VariableDefaultDescription
PAKYAS_CONFIG_DIR~/.config/pakyasLocation of local config files.
PAKYAS_NO_COLORfalseDisable colored output.
PAKYAS_API_URLhttps://api.pakyas.com(Self-hosted only) API endpoint.
.env.example
PAKYAS_API_KEY=pk_live_xxxxx
PAKYAS_PROJECT=production