Skip to main content
Check that Python examples and documentation follow agent-centric authoring — an Agent, PraisonAIAgents, or Workflow import and instantiation should appear within the first 40 lines, before low-level module imports.

​
Quick Start

# Report compliance for examples
praisonai audit agent-centric --scan ./examples

# CI gate — exit non-zero if any file fails
praisonai audit agent-centric --check ./examples

​
Command Reference

praisonai audit agent-centric [--scan PATH | --fix PATH | --check PATH] [OPTIONS]
OptionDescription
--scan PATHScan path and print compliance report
--fix PATHRewrite non-compliant files, then re-scan
--check PATHScan and exit 1 if any file is non-compliant (CI)
--jsonOutput report as JSON
--line-limit NHeader scan line limit (default: 40)
--only-examplesScan Python examples only
--only-docsScan documentation only
-v, --verboseList each non-compliant file and reason
Exactly one of --scan, --fix, or --check is required, each with a path.

​
Examples

​
Scan with verbose output

praisonai audit agent-centric --scan ./examples/python --verbose

​
Fix non-compliant files

praisonai audit agent-centric --fix ./examples/python --verbose

​
CI check

praisonai audit agent-centric --check ./docs/features --only-docs

​
JSON output

praisonai audit agent-centric --scan ./examples --json

​
Compliance reasons

CodeMeaning
A_no_agent_importNo agent-centric import found in header
B_import_no_instantiationImport present but no instantiation
C_low_level_firstLow-level import appears before agent-centric code
D_too_advancedExample is too advanced for quick-start placement
E_wrong_folderFile in wrong folder for its content type
F_outdated_apiUses deprecated API patterns
G_non_runnableExample cannot run as written
H_duplicate_quickstartDuplicate quick-start block
I_instantiation_too_lateAgent instantiation beyond --line-limit

Doctor CLI

Runtime health checks including MCP connectivity

Validate CLI

Validate YAML configs and agent definitions