Documentation

Status: draft. Choose a path by what you need to do.

Tutorials: learn through a first task

• Make your first judgment: install, ask one Noul question and interpret its typed answer.
• Make your first local policy decision: compare synthetic answers with an inclusive threshold, without a service call.

How-to: complete a task

• Install the library or CLI.
• Call from synchronous Python or asynchronous Python.
• Handle failed library calls.
• Connect VS Code, Cursor, Claude Code, Desktop or Codex.
• Use judgevet through Pi's CLI access.
• Diagnose installation, input and connection failures.
• Read questions from files and state from files or stdin.
• Apply an acceptance policy in the CLI.
• Construct, decode and evaluate a policy in Python.
• Own synchronous and asynchronous adapter lifecycles.
• Handle local policy errors.

• Review staged Git changes.

• Deploy a CLI job or integrate the library in a serverless runtime.

Reference: look up a contract

• Question types, typed answers, adapters and ports.
• CLI options, inputs, output and exit codes.
• MCP tool schemas and answers.
• Policy types, JSON grammar and evaluation.
• Supported imports and compatibility.
• Configuration defaults and precedence.
• Diagnostic events and caller correlation.
• Service, transport and local policy errors.
• Terms and meanings.
• The installed typing marker.
• Credential inputs and precedence.
• Data disclosure and diagnostic limits.

Explanation: understand the decisions

• Choose between Noul, Choice and Score.
• Understand local acceptance policies and threshold tradeoffs.
• Distinguish local checks, live observations and model quality.
• Security boundaries and caller responsibilities.
• Choose an entry point and understand ownership.

Maintainers

Start with contributor setup for a fresh checkout. Maintainer procedures cover wheel verification and release operations. They are separate from package use. The former release-guide path remains a pointer for existing links. STATUS holds current verification evidence; users do not need its linked issue history to follow the task guides.