index.md

ARIA Documentation

Welcome to the ARIA (AI Responsibility and Integration Assistant) documentation. ARIA helps you manage AI participation in your software projects through flexible policies and templates.

Getting Started

• Quick Start Guide
• Working with Templates
• Understanding Policy Inheritance
• Policy Validation Guide
• Command Line Interface
• Integration Guide

Examples

• Basic Policy
• Inherited Policy
• Template Usage Examples
• Policy Format Examples

API Reference

• Policy API
• Templates API
• Validator API
• CLI API
• Configuration API

Technical Documentation

• Policy Architecture
• Template System
• Validation System

CI/CD Integration

• GitHub Actions
• GitLab CI
• Jenkins Pipeline

Features

• Simple CLI Interface

  • Intuitive command structure
  • Command aliases for common operations
  • Progress indicators for long-running tasks
  • Rich console output with color-coding

• Policy Management

  • Create and validate policies
  • Apply templates
  • Flexible policy models
  • YAML-based configuration
  • Support for capability-based and model-based policies

• Template System

  • Pre-defined templates for common scenarios
  • Custom template support
  • Template versioning
  • Easy template application
  • Support for multiple template formats

• Advanced Validation

  • Dual-purpose validator for testing and production
  • Strict validation mode with detailed warnings
  • Clear error messages and suggestions
  • Support for multiple policy formats
  • Path-specific validation rules
  • ValidationResult class with comprehensive feedback

• Error Handling

  • Comprehensive error messages
  • Proper exit codes
  • Detailed logging
  • Input validation

• Policy Formats

  • Capability-based format for testing and development
  • Model-based format for production environments
  • Automatic format detection
  • Format-specific validation rules
  • Inheritance support for both formats

Installation

# Install ARIA using pip
python -m pip install --user aria-policy

Quick Commands

# Create a new capability-based policy
aria init -f capability -o policy.yml

# Create a new model-based policy
aria init -m assistant -f model -o policy.yml

# List templates
aria ls

# Apply a capability-based template
aria apply basic_capabilities -f capability -o policy.yml

# Apply a model-based template
aria apply basic_model -f model -o policy.yml

# Validate a policy with automatic format detection
aria validate policy.yml

# Validate with strict validation
aria validate policy.yml --strict

Contributing

For more information about contributing to ARIA, please read our Contributing Guide.

License

For license information, see our License.