Skip to content

ph guardrails ​

Guardrails on this machine: status, check <policy pack>, serve; install (sudo): install, uninstall

This page is generated from ph guardrails --help by npm run gen in site/, so do not edit it by hand.

status ​

text
ph guardrails status               Hook server, active policy, managed settings

check ​

text
ph guardrails check <package dir> [--tier platform|organization|project]
                                        Check a policy package (rule format v1, tighten or loosen) and say who may publish it
                                        (--tier overrides the manifest level; "company" is the old name of platform)

selftest ​

text
ph guardrails selftest             Acceptance scenarios sent to the running hook server (no model calls)

audit ​

text
ph guardrails audit [--days N] [--rule <id>] [--samples K]
                                        On-machine audit: counts by rule; --rule adds masked context samples (to review false blocks)

feedback ​

text
ph guardrails feedback <rule id> --note "<why it was blocked wrongly>"
                                        Report a false block to Ryoma (Security gets it right away; the note is masked before sending)

serve ​

text
ph guardrails serve [--port N]     Run the hook server (the LaunchAgent runs this command; run it by hand to try it)

install ​

text
sudo ph guardrails install --tara <url> --keys <ed25519:…> [--ryoma <url>] [--policy <name>]
                            [--org <uuid>] [--managed-hooks-only] [--audit-upload]
                            [--device-token-file <file> | --device-token <token> --device-org <slug>]
                                        Install on this machine (macOS, Linux, Windows; MDM runs this same command): managed
                                        settings, the hook server service, and a Phillip copy owned by the administrator.
                                        A device token (ph org device-token create) lets the hook server load the organization's
                                        policies before anyone has signed in; a signed-in user's own login is used when there is one.
                                        Prefer --device-token-file or PHILLIP_GUARDRAILS_DEVICE_TOKEN + PHILLIP_GUARDRAILS_DEVICE_ORG:
                                        an argument shows in the process list

uninstall ​

text
sudo ph guardrails uninstall       Remove it and restore the previous managed settings
text
Three tiers, platform -> organization -> project: platform staff set the floor, an organization admin and a project admin only tighten it.
An allow rule (a loosening exception) only takes effect when platform staff approved it. Tara lists the policies that apply to you; with an older
Tara, the platform policy is kit-policy-corporate (PHILLIP_GUARDRAILS_POLICY) and project policy is the Guardrails package in phillip.lock (ph tara add …).