ara-cli 0.1.9.96__py3-none-any.whl → 0.1.10.1__py3-none-any.whl

ara_cli/__init__.py

@@ -14,7 +14,7 @@ RESET = '\033[0m'
 
 
 def format_warning(message, category, *args, **kwargs):
-    return f'{YELLOW}{category.__name__}: {message}{RESET}\n'
+    return f'{YELLOW}[WARNING] {category.__name__}: {message}{RESET}\n'
 
 
 warnings.formatwarning = format_warning

ara_cli/__main__.py

@@ -1,60 +1,36 @@
-# PYTHON_ARGCOMPLETE_OK
-from ara_cli.ara_command_parser import action_parser
-from ara_cli.error_handler import AraError
-from ara_cli.version import __version__
-from ara_cli.ara_command_action import (
-    create_action,
-    delete_action,
-    rename_action,
-    list_action,
-    list_tags_action,
-    prompt_action,
-    chat_action,
-    template_action,
-    fetch_templates_action,
-    read_action,
-    reconnect_action,
-    read_status_action,
-    read_user_action,
-    set_status_action,
-    set_user_action,
-    classifier_directory_action,
-    scan_action,
-    autofix_action,
-    extract_action
-)
-from . import error_handler
-import argcomplete
+import typer
 import sys
+from typing import Optional
 from os import getenv
-
-
-def define_action_mapping():
-    return {
-        "create": create_action,
-        "delete": delete_action,
-        "rename": rename_action,
-        "list": list_action,
-        "list-tags": list_tags_action,
-        "prompt": prompt_action,
-        "chat": chat_action,
-        "template": template_action,
-        "fetch-templates": fetch_templates_action,
-        "read": read_action,
-        "reconnect": reconnect_action,
-        "read-status": read_status_action,
-        "read-user": read_user_action,
-        "set-status": set_status_action,
-        "set-user": set_user_action,
-        "classifier-directory": classifier_directory_action,
-        "scan": scan_action,
-        "autofix": autofix_action,
-        "extract": extract_action
-    }
-
-
-def handle_invalid_action(args):
-    raise AraError("Invalid action provided. Type ara -h for help", error_code=1)
+from ara_cli.error_handler import AraError
+from ara_cli.version import __version__
+from ara_cli import error_handler
+from ara_cli.ara_subcommands.create import register as register_create_cli
+from ara_cli.ara_subcommands.delete import register as register_delete_cli
+from ara_cli.ara_subcommands.rename import register as register_rename_cli
+from ara_cli.ara_subcommands.list import register as register_list_cli
+from ara_cli.ara_subcommands.list_tags import register as register_list_tags_cli
+from ara_cli.ara_subcommands.prompt import register as register_prompt_cli
+from ara_cli.ara_subcommands.chat import register as register_chat_cli
+from ara_cli.ara_subcommands.template import register as register_template_cli
+from ara_cli.ara_subcommands.fetch_templates import register as register_fetch_templates_cli
+from ara_cli.ara_subcommands.read import register as register_read_cli
+from ara_cli.ara_subcommands.reconnect import register as register_reconnect_cli
+from ara_cli.ara_subcommands.read_status import register as register_read_status_cli
+from ara_cli.ara_subcommands.read_user import register as register_read_user_cli
+from ara_cli.ara_subcommands.set_status import register as register_set_status_cli
+from ara_cli.ara_subcommands.set_user import register as register_set_user_cli
+from ara_cli.ara_subcommands.classifier_directory import register as register_classifier_directory_cli
+from ara_cli.ara_subcommands.scan import register as register_scan_cli
+from ara_cli.ara_subcommands.autofix import register as register_autofix_cli
+from ara_cli.ara_subcommands.extract import register as register_extract_cli
+from ara_cli.ara_subcommands.load import register as register_load_cli
+
+
+def version_callback(value: bool):
+    if value:
+        typer.echo(f"ara {__version__}")
+        raise typer.Exit()
 
 
 def is_debug_mode_enabled():
@@ -62,66 +38,128 @@ def is_debug_mode_enabled():
     return getenv('ARA_DEBUG', '').lower() in ('1', 'true', 'yes')
 
 
-def setup_parser():
-    """Create and configure the argument parser."""
-    parser = action_parser()
-    
-    # Show examples when help is called
-    if any(arg in sys.argv for arg in ["-h", "--help"]):
-        parser.add_examples = True
-    
-    parser.add_argument(
-        "-v", "--version", action="version", version=f"%(prog)s {__version__}"
-    )
-    
-    parser.add_argument(
-        "--debug", action="store_true", help="Enable debug mode for detailed error output"
-    )
-    
-    return parser
-
-
-def configure_debug_mode(args, env_debug_mode):
+def configure_debug_mode(debug: bool, env_debug_mode: bool):
     """Configure debug mode based on arguments and environment."""
-    if (hasattr(args, 'debug') and args.debug) or env_debug_mode:
+    if debug or env_debug_mode:
         error_handler.debug_mode = True
 
 
-def should_show_help(args):
-    """Check if help should be displayed."""
-    return not hasattr(args, "action") or not args.action
-
+def create_app():
+    app = typer.Typer(
+        help="""The ara cli terminal tool is a management tool for classified ara artefacts.
+
+Valid classified artefacts are: businessgoal, vision, capability, keyfeature, feature, epic, userstory, example, feature, task.
+
+The default ara directory structure of classified artefact of the ara cli tool is:
+.
+└── ara
+   ├── businessgoals
+   ├── capabilities
+   ├── epics
+   ├── examples
+   ├── features
+   ├── keyfeatures
+   ├── tasks
+   ├── userstories
+   └── vision
+
+ara artefact handling examples:
+  > create a new artefact for e.g. a feature:                                        ara create feature {feature_name}
+  > create a new artefact for e.g. a feature that contributes to an userstory:       ara create feature {feature_name} contributes-to userstory {story_name}
+  > read an artefact and return the content as terminal output, for eg. of a task:   ara read task {task_name}
+  > read an artefact and its full chain of contributions to its parents and return
+    the content as terminal output, for eg. of a task:                               ara read task {task_name} --branch
+  > delete an artefact for e.g. feature:                                             ara delete feature {feature_name}
+  > rename artefact and artefact data directory for e.g. a feature:                  ara rename feature {initial_feature_name} {new_feature_name}
+  > create additional templates for a specific aspect (valid aspects are: customer,
+    persona, concept, technology) related to an existing artefact like a feature:    ara create feature {feature_name} aspect {aspect_name}
+  > list artefact data with .md file extension                                       ara list --data {classifier} {artefact_name} --include-extension .md
+  > list artefact data with .md and .json file extensions                            ara list --data {classifier} {artefact_name} --include-extension .md .json
+  > list everything but userstories                                                  ara list --exclude-extension .userstory
+  > list all existing features:                                                      ara list --include-extension .feature
+  > list all child artefacts contributing value to a parent artefact:                ara list --include-content "Contributes to {name_of_parent_artefact} {ara classifier_of_parent_artefact}"
+  > list tasks which contain 'example content'                                       ara list --include-extension .task --include-content "example content"
+  > list children artefacts of a userstory                                           ara list --children userstory {name_of_userstory}
+  > list parent artefacts of a userstory                                             ara list --branch userstory {name_of_userstory}
+  > list parent businessgoal artefact of a userstory                                 ara list --branch userstory {name_of_userstory} --include-extension .businessgoal
+  > print any artefact template for e.g. a feature file template in the terminal:    ara template feature
+
+ara prompt templates examples:
+ > get and copy all prompt templates (blueprints, rules, intentions, commands
+   in the ara/.araconfig/global-prompt-modules directory:                            ara fetch-templates
+
+ara chat examples:
+  > chat with ara and save the default chat.md file in the working directory:        ara chat
+  > chat with ara and save the default task_chat.md file in the task.data directory: ara prompt chat task {task_name}
+
+  > initialize a macro prompt for a task:                                            ara prompt init task {task_name}
+  > load selected templates in config_prompt_templates.md for the task {task_name}:  ara prompt load task {task_name}
+  > create and send configured prompt of the task {task_name} to the configured LLM: ara prompt send task {task_name}
+  > extract the selected LLM response in task.exploration.md and save to disk:       ara prompt extract task {task_name}
+        """,
+        no_args_is_help=True,
+        add_completion=True,
+        rich_markup_mode="rich"
+    )
 
-def execute_action(args, action_mapping):
-    """Execute the specified action."""
-    action = action_mapping.get(args.action, handle_invalid_action)
-    action(args)
+    @app.callback(invoke_without_command=True)
+    def main(
+        ctx: typer.Context,
+        version: Optional[bool] = typer.Option(
+            None, "--version", "-v",
+            callback=version_callback,
+            is_eager=True,
+            help="Show version and exit"
+        ),
+        debug: bool = typer.Option(
+            False, "--debug",
+            help="Enable debug mode for detailed error output"
+        )
+    ):
+        """The ara cli terminal tool is a management tool for classified ara artefacts."""
+        debug_mode = is_debug_mode_enabled()
+        configure_debug_mode(debug, debug_mode)
+
+        # Only show help if no subcommand is invoked
+        if ctx.invoked_subcommand is None:
+            ctx.get_help()
+            ctx.exit()
+
+    # Register all commands
+    register_create_cli(app)
+    register_delete_cli(app)
+    register_rename_cli(app)
+    register_list_cli(app)
+    register_list_tags_cli(app)
+    register_prompt_cli(app)
+    register_chat_cli(app)
+    register_template_cli(app)
+    register_fetch_templates_cli(app)
+    register_read_cli(app)
+    register_reconnect_cli(app)
+    register_read_status_cli(app)
+    register_read_user_cli(app)
+    register_set_status_cli(app)
+    register_set_user_cli(app)
+    register_classifier_directory_cli(app)
+    register_scan_cli(app)
+    register_autofix_cli(app)
+    register_extract_cli(app)
+    register_load_cli(app)
+
+    return app
 
 
 def cli():
-    debug_mode = is_debug_mode_enabled()
-    
+    app = create_app()
     try:
-        parser = setup_parser()
-        action_mapping = define_action_mapping()
-        
-        argcomplete.autocomplete(parser)
-        args = parser.parse_args()
-        
-        configure_debug_mode(args, debug_mode)
-        
-        if should_show_help(args):
-            parser.print_help()
-            return
-            
-        execute_action(args, action_mapping)
-        
+        app()
     except KeyboardInterrupt:
-        print("\n[INFO] Operation cancelled by user", file=sys.stderr)
-        sys.exit(130)  # Standard exit code for Ctrl+C
+        typer.echo("\n[INFO] Operation cancelled by user", err=True)
+        raise typer.Exit(130)  # Standard exit code for Ctrl+C
     except Exception as e:
         error_handler.handle_error(e, context="cli")
 
 
 if __name__ == "__main__":
-    cli()
+    cli()

ara_cli/ara_command_action.py

@@ -130,9 +130,6 @@ def list_action(args):
         )
         return
 
-    if (args.tags):
-        artefact_lister.list_files(tags=args.tags, list_filter=list_filter)
-        return
     artefact_lister.list_files(list_filter=list_filter)
 
 
@@ -147,17 +144,25 @@ def list_tags_action(args):
     )
 
     tag_extractor = TagExtractor()
-    tags = tag_extractor.extract_tags(
+    tag_groups = tag_extractor.extract_tags(
         filtered_extra_column=getattr(args, "filtered_extra_column", False),
         list_filter=list_filter
     )
 
     if args.json:
-        output = json.dumps({"tags": tags})
+        all_tags = []
+        for group in tag_groups.values():
+            all_tags.extend(group)
+        output = json.dumps({"tags": sorted(all_tags)})
         print(output)
         return
 
-    output = "\n".join(f"- {tag}" for tag in tags)
+    output_lines = []
+    for key in sorted(tag_groups.keys()):
+        line = " ".join(sorted(list(tag_groups[key])))
+        output_lines.append(line)
+
+    output = "\n".join(f"- {tag}" for tag in output_lines)
     print(output)
 
 
@@ -261,6 +266,59 @@ def chat_action(args):
     chat.start()
 
 
+def _find_chat_file(chat_name: str) -> str | None:
+    """Resolves the chat file path based on common naming conventions."""
+    # Logic from setup_chat for finding existing files.
+    if os.path.exists(chat_name) and os.path.isfile(chat_name):
+        return chat_name
+
+    chat_name_md = f"{chat_name}.md"
+    if os.path.exists(chat_name_md) and os.path.isfile(chat_name_md):
+        return chat_name_md
+
+    chat_name_chat_md = f"{chat_name}_chat.md"
+    if os.path.exists(chat_name_chat_md) and os.path.isfile(chat_name_chat_md):
+        return chat_name_chat_md
+
+    return None
+
+
+@handle_errors(context="load action", error_handler=error_handler)
+def load_action(args):
+    from ara_cli.template_loader import TemplateLoader
+
+    chat_name = args.chat_name
+    template_type = args.template_type
+    template_name = args.template_name
+
+    chat_file_path = _find_chat_file(chat_name)
+
+    if not chat_file_path:
+        raise AraError(f"Chat file for '{chat_name}' not found.")
+
+    default_patterns = {
+        "rules": "*.rules.md",
+        "intention": "*.intention.md",
+        "commands": "*.commands.md"
+    }
+
+    default_pattern = default_patterns.get(template_type)
+
+    if not template_name and not default_pattern:
+        raise AraError(f"A template name is required for template type '{template_type}'.")
+
+    loader = TemplateLoader()  # No chat instance for CLI context
+    success = loader.load_template(
+        template_name=template_name,
+        template_type=template_type,
+        chat_file_path=chat_file_path,
+        default_pattern=default_pattern
+    )
+
+    if not success:
+        sys.exit(1)
+
+
 @handle_errors(context="template action", error_handler=error_handler)
 def template_action(args):
     from ara_cli.classifier import Classifier
@@ -615,4 +673,4 @@ def extract_action(args):
         write=write,
         output=lambda msg: print(msg, file=sys.stdout)
     )
-    command.execute()
+    command.execute()