angreal-authoring

What problem does it solve?

This guide helps developers who need clear instructions for creating and organizing Angreal task files, decorators, and task groups within an existing Angreal project, reducing ambiguity and setup time.

Core Features & Use Cases

• Task File Location: Task files live under .angreal/ at the project root (e.g., .angreal/task_build.py) and follow the naming convention task_*.py to be discovered.
• The @command Decorator: Each task must use the @angreal.command decorator with a name and description to expose CLI commands such as angreal build or angreal test.
• Command Groups: Use command_group to group related commands for better organization, enabling nested group structures like docker compose up.
• Naming & Organization: One domain per file, consistent kebab-case command names, and clear documentation in the code and utilities.
• Best Practices: Emphasize testability, error handling, and modular utilities in .angreal for maintainability.

Quick Start

Create a new task file in an existing Angreal project and annotate it with the @angreal.command decorator.