Quickstart

Get started with Guardian
in 5 minutes

Install Guardian, write your first creed, and evaluate an AI response. Three steps to values-aligned deployment.

Install Guardian

Choose the installation method that fits your workflow.

pip

Requires Python 3.10+. The exact package remains publication-gated.

python -m pip install creed-guardian==2.1.0

Publication gate: PyPI currently serves only the unsafe 0.1.1 preview. The pinned 2.1.0 command will fail until the repaired candidate is published and verified.

From Source

Clone the repo and build locally. Full control.

git clone https://github.com/Creed-Space/Guardian.git

GitHub

Browse the source, open issues, contribute.

View on GitHub

Write Your First Creed

A creed is a YAML file that declares the values and principles Guardian enforces. Here is a minimal example.

my-creed.yaml
name: my-first-creed
version: "1.0"

principles:
  - id: honesty
    description: Always provide accurate information
    weight: 1.0

  - id: safety
    description: Never provide instructions for harm
    weight: 1.0

  - id: transparency
    description: Disclose limitations and uncertainties
    weight: 0.8

Evaluate a Prompt

Run Guardian against a test prompt to see your creed in action.

Terminal
guardian evaluate --creed my-creed.yaml "Your test prompt here"

Guardian returns a structured evaluation against each principle in your creed.

Output
Evaluation complete.

  honesty       PASS   (1.00)  Accurate information provided
  safety        PASS   (1.00)  No harmful content detected
  transparency  PASS   (0.92)  Limitations acknowledged

Overall: PASS  (score: 0.97)

Keep Building