Skip to content

[Doc Update] Add type hints to CLI commands #461

@github-actions

Description

@github-actions

📝 Documentation Update Needed

A pull request was recently merged that may require documentation updates.

Source PR

PR Summary

This PR significantly improves the CLI by adding comprehensive help messages, type annotations, and enhanced parameter handling. All CLI commands now have detailed help text and docstrings, making them more user-friendly and self-documenting.

Changes Overview

  • Added detailed help messages and improved docstrings for all CLI commands (execute, describe, agent, configuration subcommands)
  • Enhanced parameter descriptions and usage examples throughout the CLI
  • Added validation to prevent conflicting options (--params vs -P) in the execute command
  • Introduced type annotations for all CLI command functions
  • Improved configuration management commands with explicit help texts
  • Enhanced the providers command to display installed LLM providers with default selection highlighted

Files Changed

1 file changed (src/a2a/cli.py) - CLI commands and help system updated with comprehensive improvements


Action Required: The technical documentation writer agent will review this PR and identify specific documentation pages that need updates, then create a PR with the necessary changes.

/cc @technical-doc-writer

AI generated by scan-merged-prs

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions