capiscio-cli Documentation

Validate A2A agent cards with confidence - Catch issues before they reach production

Why capiscio-cli?

The Problem: You're building an A2A agent and need to ensure your agent card is valid, trustworthy, and production-ready. Manual validation is error-prone and doesn't catch subtle issues.

The Solution: capiscio-cli provides comprehensive three-dimensional validation:

• ✅ Spec Compliance (0-100): Is your agent card properly formatted?
• ✅ Trust (0-100): Can users verify your agent's authenticity?
• ✅ Availability (0-100): Are your endpoints operational?

� Documentation Structure

User Documentation

• Installation & Usage - Installation guide and getting started
• Validation Process - Exhaustive guide to the validation system
• Scoring System - Three-dimensional scoring breakdown and best practices
• API Reference - Programmatic usage and TypeScript API documentation

Developer Documentation

• Architecture - Internal design, patterns, and extensibility

🚀 Quick Navigation

New Users

1. Start with Installation & Usage for installation and basic usage
2. Review Validation Process to understand what's validated
3. Learn about Scoring System to interpret your results

Developers

1. Read the API Reference for programmatic usage
2. Study the Architecture for internal design

CI/CD Integration

1. See JSON output examples in the API Reference
2. Review error codes in Validation Process
3. Check API Reference for automation examples

🔍 Find What You Need

I want to...

• Validate an agent card → Installation & Usage
• Understand what gets validated → Validation Process
• Understand scoring results → Scoring System
• Use the CLI programmatically → API Reference
• Extend or modify the validator → Architecture

Building an A2A Agent?

If you're building an agent (not just validating cards), check out CapiscIO A2A Security for runtime protection.

Validation Specifics

• Error codes and meanings → Validation Process - Error Codes
• Validation modes explained → Validation Process - Validation Modes
• Network and HTTP handling → Validation Process - HTTP Client
• Schema validation details → Validation Process - Schema Validation

Integration Examples

• CLI usage examples → Installation & Usage
• Programmatic examples → API Reference - Examples
• CI/CD integration → API Reference - CI/CD Integration
• Custom HTTP clients → API Reference - Custom HTTP Client

📝 Documentation Standards

Our documentation follows these principles:

• Comprehensive: Covers all features and use cases
• Example-Driven: Includes practical examples for every concept
• Up-to-Date: Synchronized with code changes
• Accessible: Clear language suitable for all skill levels
• Searchable: Well-structured with good navigation

🤝 Contributing to Documentation

We welcome improvements to documentation! For:

• How to submit documentation changes
• Writing style guidelines
• Documentation review process
• Setting up the development environment

See the repository on GitHub for more details.

---

Need help? Open an issue or start a discussion.