angreal-authoring

Author Angreal task files and decorators under .angreal/ in Python projects.

12|6|Updated Jun 19, 2018
One-click install
npx skills add https://github.com/angreal/angreal --skill angreal-authoring
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: angreal-authoring
Source: https://github.com/angreal/angreal/tree/main/plugin/skills/angreal-authoring
Command: npx skills add https://github.com/angreal/angreal --skill angreal-authoring

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about angreal-authoring

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create Python task automation commands in an angreal project?

To create Python task automation commands, place files under the .angreal/ directory using the task_*.py naming convention, then use the @angreal.command decorator with a name and description to expose them as CLI commands.

What is the @angreal.command decorator and how does it work?

The @angreal.command decorator exposes Python functions as CLI commands by requiring a name and description, allowing users to execute project tasks directly from the command line, such as running angreal build or angreal test.

How do I organize related Python CLI commands into nested groups?

You organize related Python CLI commands into nested group structures by using command_group, enabling hierarchical command execution like docker compose up for better task organization within your project.

What naming conventions should I follow for angreal task files?

Angreal task files must follow the task_*.py naming convention and live under the .angreal/ directory at the project root, with consistent kebab-case command names and one domain per file for clear organization.

Do I need any external dependencies to use angreal for project task automation?

No external dependencies are required beyond the angreal package itself, as the task automation framework relies on standard Python decorators and file structures within your existing project directory.

What are the best practices for structuring Python task utilities in angreal?

Best practices for structuring Python task utilities include maintaining modular utilities in .angreal, emphasizing testability, implementing error handling, and ensuring clear documentation for maintainable task files.