angreal-arguments

Automate CLI argument definition and validation for Angreal tasks.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Angreal tasks often require consistent, well-documented arguments; this skill centralizes and streamlines the creation of CLI options using the @argument decorator to prevent misconfigurations and ensure a uniform user experience.

Core Features & Use Cases

  • Declarative argument configuration: specify name, long/short flags, type, default values, and requirements in a single place.
  • Comprehensive value handling: supports booleans, integers, multiple values, required flags, and equals syntax for --arg=value.
  • Real-world scenarios: apply to any Angreal task to auto-generate help text, enforce input validation, and simplify task execution across projects.

Quick Start

Install Angreal and apply the @angreal.argument decorator to your tasks to introduce a well-defined CLI interface.

Frequently Asked Questions about angreal-arguments

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

FAQPage Schema
How do I add command-line arguments to Angreal tasks?

Add command-line arguments to Angreal tasks by applying the @angreal.argument decorator. It declaratively configures argument names, flags, types, defaults, and requirements directly within the task definition.

Can I use boolean and integer flags with Python CLI decorators?

Yes, you can use boolean and integer flags with Python CLI decorators. The Angreal argument decorator supports comprehensive value handling including integers, booleans, multiple values, and required flags.

What is the best way to enforce required CLI arguments for Python scripts?

The best way to enforce required CLI arguments for Python scripts is using a declarative decorator that centralizes validation. Angreal arguments enforce input requirements and auto-generate robust help text to prevent misconfigurations.

Does the Angreal argument decorator support equals syntax for passing values?

Yes, the Angreal argument decorator supports equals syntax for passing values. It accepts the --arg=value format alongside standard long and short flags for flexible command-line task execution.

Why are my Python command-line arguments showing misconfigurations?

Python command-line arguments show misconfigurations when definitions are inconsistent. Centralizing argument creation with the @angreal.command compatible decorator ensures uniform validation, robust error handling, and auto-generated help text.

How does command-line argument validation work with task decorators?

Command-line argument validation works with task decorators by enforcing specified types, defaults, and requirements at runtime. The decorator integrates with @angreal.command to validate inputs before task execution begins.