Skip to content

feat: Add CLI and enhance documentation#7

Merged
galuszkm merged 1 commit intomainfrom
feat/mg/cli-docs-update
Mar 24, 2026
Merged

feat: Add CLI and enhance documentation#7
galuszkm merged 1 commit intomainfrom
feat/mg/cli-docs-update

Conversation

@galuszkm
Copy link
Copy Markdown
Member

Description

  • Updated config.yaml in the streaming example to use wire_event_queue() instead of make_event_queue().
  • Simplified installation instructions in the README for the agent factory example.
  • Improved the main README to clarify the purpose of hooks in the hooks example.
  • Added license, authors, and keywords to pyproject.toml for better package metadata.
  • Introduced a command-line interface (CLI) in cli.py for validating and loading YAML configurations.
  • Added type hints and documentation for agent and orchestration resolvers.
  • Enhanced error handling and logging in the ToolNameSanitizer hook.
  • Updated unit tests for the new CLI functionality, ensuring comprehensive coverage for both success and failure paths.
  • Added support for multi-file configuration in the CLI.
  • Included versioning and additional metadata in JSON outputs for CLI commands.

Related Issues

None

Type of Change

  • New feature
  • Documentation update

YAML / API Impact

backwards-compatible

Testing

How have you tested the change?

  • I ran uv run just check (lint + type check)
  • I ran uv run just test for overall testing
  • I added or updated tests that prove my fix is effective or my feature works
  • I verified existing examples in examples/ still work

Checklist

  • I have read the CONTRIBUTING document
  • I have updated the documentation accordingly
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

- Updated `config.yaml` in the streaming example to use `wire_event_queue()` instead of `make_event_queue()`.
- Simplified installation instructions in the README for the agent factory example.
- Improved the main README to clarify the purpose of hooks in the hooks example.
- Added license, authors, and keywords to `pyproject.toml` for better package metadata.
- Introduced a command-line interface (CLI) in `cli.py` for validating and loading YAML configurations.
- Added type hints and documentation for agent and orchestration resolvers.
- Enhanced error handling and logging in the `ToolNameSanitizer` hook.
- Updated unit tests for the new CLI functionality, ensuring comprehensive coverage for both success and failure paths.
- Added support for multi-file configuration in the CLI.
- Included versioning and additional metadata in JSON outputs for CLI commands.
@galuszkm galuszkm merged commit 1c1001f into main Mar 24, 2026
7 checks passed
@galuszkm galuszkm deleted the feat/mg/cli-docs-update branch March 24, 2026 00:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant