ara-cli 0.1.10.0__py3-none-any.whl → 0.1.10.4__py3-none-any.whl

ara_cli/__main__.py

@@ -1,62 +1,37 @@
-# 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,
-    load_action
-)
-from . import error_handler
-import argcomplete
+import typer
 import sys
+import os
+from typing import Optional
 from os import getenv
+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 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,
-        "load": load_action
-    }
-
-
-def handle_invalid_action(args):
-    raise AraError("Invalid action provided. Type ara -h for help", error_code=1)
+def version_callback(value: bool):
+    if value:
+        typer.echo(f"ara {__version__}")
+        raise typer.Exit()
 
 
 def is_debug_mode_enabled():
@@ -64,63 +39,243 @@ 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 find_ara_directory_root():
+    """Find the root ara directory by traversing up the directory tree."""
+    current_dir = os.getcwd()
+    
+    # Check if we're already inside an ara directory structure
+    path_parts = current_dir.split(os.sep)
+    
+    # Look for 'ara' in the path parts
+    if 'ara' in path_parts:
+        ara_index = path_parts.index('ara')
+        # Reconstruct path up to and including 'ara'
+        ara_root_parts = path_parts[:ara_index + 1]
+        potential_ara_root = os.sep.join(ara_root_parts)
+        if os.path.exists(potential_ara_root) and os.path.isdir(potential_ara_root):
+            return potential_ara_root
+    
+    # If not inside ara directory, check current directory and parents
+    check_dir = current_dir
+    while check_dir != os.path.dirname(check_dir):  # Stop at filesystem root
+        ara_path = os.path.join(check_dir, 'ara')
+        if os.path.exists(ara_path) and os.path.isdir(ara_path):
+            return ara_path
+        check_dir = os.path.dirname(check_dir)
+    
+    return None
 
 
-def execute_action(args, action_mapping):
-    """Execute the specified action."""
-    action = action_mapping.get(args.action, handle_invalid_action)
-    action(args)
+def check_ara_directory_exists():
+    """Check if ara directory exists or if we're inside ara directory tree."""
+    return find_ara_directory_root() is not None
 
 
-def cli():
-    debug_mode = is_debug_mode_enabled()
+def prompt_create_ara_directory():
+    """Prompt user to create ara directory and create it if confirmed."""
+    # Print the prompt message
+    print("No 'ara' directory found. Create one in the current directory? (Y/n)", end=" ", flush=True)
     
+    # Read user input
     try:
-        parser = setup_parser()
-        action_mapping = define_action_mapping()
-        
-        argcomplete.autocomplete(parser)
-        args = parser.parse_args()
+        response = input().strip()
+    except (EOFError, KeyboardInterrupt):
+        typer.echo("\nOperation cancelled.")
+        raise typer.Exit(1)
+    
+    if response.lower() in ('y', 'yes', ''):
+        current_dir = os.getcwd()
+        ara_path = os.path.join(current_dir, 'ara')
         
-        configure_debug_mode(args, debug_mode)
+        # Create ara directory structure
+        subdirectories = [
+            'businessgoals',
+            'capabilities', 
+            'epics',
+            'examples',
+            'features',
+            'keyfeatures',
+            'tasks',
+            'userstories',
+            'vision'
+        ]
         
-        if should_show_help(args):
-            parser.print_help()
-            return
+        try:
+            # Create main ara directory
+            os.makedirs(ara_path, exist_ok=True)
+            
+            # Create subdirectories for artefact types
+            for subdir in subdirectories:
+                os.makedirs(os.path.join(ara_path, subdir), exist_ok=True)
+            
+            # Create .araconfig directory
+            araconfig_path = os.path.join(ara_path, '.araconfig')
+            os.makedirs(araconfig_path, exist_ok=True)
+            
+            # Create default ara_config.json using ConfigManager
+            from ara_cli.ara_config import ConfigManager, ARAconfig
+            config_file_path = os.path.join(araconfig_path, 'ara_config.json')
+            
+            # Reset ConfigManager to ensure clean state
+            ConfigManager.reset()
             
-        execute_action(args, action_mapping)
+            # Create default config and save it
+            default_config = ARAconfig()
+            from ara_cli.ara_config import save_data
+            save_data(config_file_path, default_config)
+            
+            typer.echo(f"Created ara directory structure at {ara_path}")
+            typer.echo(f"Created default configuration at {config_file_path}")
+            return True
+            
+        except OSError as e:
+            typer.echo(f"Error creating ara directory: {e}", err=True)
+            raise typer.Exit(1)
+        except Exception as e:
+            typer.echo(f"Error creating configuration file: {e}", err=True)
+            raise typer.Exit(1)
+    else:
+        typer.echo("Ara directory creation cancelled.")
+        raise typer.Exit(0)
+
+
+def requires_ara_directory():
+    """Check if ara directory exists and prompt to create if not."""
+    if not check_ara_directory_exists():
+        return prompt_create_ara_directory()
+    return True
+
+
+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"
+    )
+
+    @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()
+        
+        # Check for ara directory before executing any command
+        # Skip check for commands that don't require ara directory
+        commands_requiring_ara = {
+            'create', 'delete', 'rename', 'list', 'list-tags', 'prompt', 
+            'read', 'reconnect', 'read-status', 'read-user', 'set-status', 
+            'set-user', 'classifier-directory', 'scan', 'autofix'
+        }
         
+        if ctx.invoked_subcommand in commands_requiring_ara:
+            requires_ara_directory()
+
+    # 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():
+    app = create_app()
+    try:
+        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")
 

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)
 
 

ara_cli/ara_subcommands/autofix.py

@@ -0,0 +1,26 @@
+import typer
+from .common import MockArgs
+from ara_cli.ara_command_action import autofix_action
+
+
+def autofix_main(
+    single_pass: bool = typer.Option(False, "--single-pass", help="Run the autofix once for every scanned file"),
+    deterministic: bool = typer.Option(False, "-d", "--deterministic", help="Run only deterministic fixes e.g Title-FileName Mismatch fix"),
+    non_deterministic: bool = typer.Option(False, "-nd", "--non-deterministic", help="Run only non-deterministic fixes")
+):
+    """Fix ARA tree with llm models for scanned artefacts with ara scan command."""
+    if deterministic and non_deterministic:
+        typer.echo("Error: --deterministic and --non-deterministic are mutually exclusive", err=True)
+        raise typer.Exit(1)
+    
+    args = MockArgs(
+        single_pass=single_pass,
+        deterministic=deterministic,
+        non_deterministic=non_deterministic
+    )
+    autofix_action(args)
+
+
+def register(parent: typer.Typer):
+    help_text = "Fix ARA tree with llm models for scanned artefacts"
+    parent.command(name="autofix", help=help_text)(autofix_main)

ara_cli/ara_subcommands/chat.py

@@ -0,0 +1,27 @@
+import typer
+from typing import Optional, List
+from .common import MockArgs, ChatNameArgument
+from ara_cli.ara_command_action import chat_action
+
+
+def chat_main(
+    chat_name: Optional[str] = ChatNameArgument("Optional name for a specific chat. Pass the .md file to continue an existing chat", None),
+    reset: Optional[bool] = typer.Option(None, "-r", "--reset/--no-reset", help="Reset the chat file if it exists"),
+    output_mode: bool = typer.Option(False, "--out", help="Output the contents of the chat file instead of entering interactive chat mode"),
+    append: Optional[List[str]] = typer.Option(None, "--append", help="Append strings to the chat file"),
+    restricted: Optional[bool] = typer.Option(None, "--restricted/--no-restricted", help="Start with a limited set of commands")
+):
+    """Command line chatbot. Chat control with SEND/s | RERUN/r | QUIT/q"""
+    args = MockArgs(
+        chat_name=chat_name,
+        reset=reset,
+        output_mode=output_mode,
+        append=append,
+        restricted=restricted
+    )
+    chat_action(args)
+
+
+def register(parent: typer.Typer):
+    help_text = "Command line chatbot. Chat control with SEND/s | RERUN/r | QUIT/q"
+    parent.command(name="chat", help=help_text)(chat_main)

ara_cli/ara_subcommands/classifier_directory.py

@@ -0,0 +1,16 @@
+import typer
+from .common import ClassifierEnum, MockArgs, ClassifierArgument
+from ara_cli.ara_command_action import classifier_directory_action
+
+
+def classifier_directory_main(
+    classifier: ClassifierEnum = ClassifierArgument("Classifier of the artefact type")
+):
+    """Print the ara subdirectory for an artefact classifier."""
+    args = MockArgs(classifier=classifier.value)
+    classifier_directory_action(args)
+
+
+def register(parent: typer.Typer):
+    help_text = "Print the ara subdirectory for an artefact classifier"
+    parent.command(name="classifier-directory", help=help_text)(classifier_directory_main)

ara_cli/ara_subcommands/common.py

@@ -0,0 +1,100 @@
+from typing import Optional
+from enum import Enum
+import typer
+from ara_cli.classifier import Classifier
+from ara_cli.template_manager import SpecificationBreakdownAspects
+from ara_cli.completers import DynamicCompleters
+
+
+# Get classifiers and aspects
+classifiers = Classifier.ordered_classifiers()
+aspects = SpecificationBreakdownAspects.VALID_ASPECTS
+
+
+# Create enums for better type safety
+ClassifierEnum = Enum('ClassifierEnum', {c: c for c in classifiers})
+AspectEnum = Enum('AspectEnum', {a: a for a in aspects})
+TemplateTypeEnum = Enum('TemplateTypeEnum', {
+    'rules': 'rules',
+    'intention': 'intention',
+    'commands': 'commands',
+    'blueprint': 'blueprint'
+})
+
+
+# Create typed arguments and options with autocompletion
+def ClassifierArgument(help_text: str, default=...):
+    """Create a classifier argument with autocompletion."""
+    return typer.Argument(
+        default,
+        help=help_text,
+        autocompletion=DynamicCompleters.create_classifier_completer()
+    )
+
+
+def ClassifierOption(help_text: str, *names):
+    """Create a classifier option with autocompletion."""
+    return typer.Option(
+        None,
+        *names,
+        help=help_text,
+        autocompletion=DynamicCompleters.create_classifier_completer()
+    )
+
+
+def ArtefactNameArgument(help_text: str, default=...):
+    """Create an artefact name argument with autocompletion."""
+    return typer.Argument(
+        default,
+        help=help_text,
+        autocompletion=DynamicCompleters.create_artefact_name_completer()
+    )
+
+
+
+def ParentNameArgument(help_text: str):
+    """Create a parent name argument with autocompletion."""
+    return typer.Argument(
+        help=help_text,
+        autocompletion=DynamicCompleters.create_parent_name_completer()
+    )
+
+
+def AspectArgument(help_text: str):
+    """Create an aspect argument with autocompletion."""
+    return typer.Argument(
+        help=help_text,
+        autocompletion=DynamicCompleters.create_aspect_completer()
+    )
+
+
+def StatusArgument(help_text: str):
+    """Create a status argument with autocompletion."""
+    return typer.Argument(
+        help=help_text,
+        autocompletion=DynamicCompleters.create_status_completer()
+    )
+
+
+def TemplateTypeArgument(help_text: str):
+    """Create a template type argument with autocompletion."""
+    return typer.Argument(
+        help=help_text,
+        autocompletion=DynamicCompleters.create_template_type_completer()
+    )
+
+
+def ChatNameArgument(help_text: str, default=None):
+    """Create a chat name argument with autocompletion."""
+    return typer.Argument(
+        default,
+        help=help_text,
+        autocompletion=DynamicCompleters.create_chat_file_completer()
+    )
+
+
+# Mock args class to maintain compatibility with existing action functions
+class MockArgs:
+    def __init__(self, **kwargs):
+        for key, value in kwargs.items():
+            setattr(self, key, value)

ara_cli/ara_subcommands/create.py

@@ -0,0 +1,75 @@
+import typer
+from typing import Optional
+from .common import (
+    ClassifierEnum, AspectEnum, MockArgs,
+    ClassifierArgument, ArtefactNameArgument, ParentNameArgument, AspectArgument
+)
+from ara_cli.ara_command_action import create_action
+
+
+def create_contributes_to(
+    ctx: typer.Context,
+    parent_classifier: ClassifierEnum = ClassifierArgument("Classifier of the parent"),
+    parent_name: str = ParentNameArgument("Name of a parent artefact"),
+    rule: Optional[str] = typer.Option(None, "-r", "--rule", help="Rule for contribution")
+):
+    """Create an artefact that contributes to a parent artefact."""
+    # Get classifier and parameter from parent context
+    parent_params = ctx.parent.params
+    classifier = parent_params['classifier']
+    parameter = parent_params['parameter']
+
+    args = MockArgs(
+        classifier=classifier,
+        parameter=parameter,
+        option="contributes-to",
+        parent_classifier=parent_classifier.value,
+        parent_name=parent_name,
+        rule=rule
+    )
+    create_action(args)
+
+
+def create_aspect(
+    ctx: typer.Context,
+    aspect: AspectEnum = AspectArgument("Adds additional specification breakdown aspects")
+):
+    """Create an artefact with additional specification breakdown aspects."""
+    # Get classifier and parameter from parent context
+    parent_params = ctx.parent.params
+    classifier = parent_params['classifier']
+    parameter = parent_params['parameter']
+
+    args = MockArgs(
+        classifier=classifier,
+        parameter=parameter,
+        option="aspect",
+        aspect=aspect.value
+    )
+    create_action(args)
+
+
+def create_main(
+    ctx: typer.Context,
+    classifier: ClassifierEnum = ClassifierArgument("Classifier that also serves as file extension"),
+    parameter: str = ArtefactNameArgument("Artefact name that serves as filename")
+):
+    """Create a classified artefact with data directory."""
+    if ctx.invoked_subcommand is None:
+        args = MockArgs(
+            classifier=classifier.value,
+            parameter=parameter,
+            option=None
+        )
+        create_action(args)
+
+
+def register(parent: typer.Typer):
+    create_app = typer.Typer(
+        help="Create a classified artefact with data directory",
+        add_completion=False  # Disable completion on subcommand
+    )
+    create_app.command("contributes-to")(create_contributes_to)
+    create_app.command("aspect")(create_aspect)
+    create_app.callback(invoke_without_command=True)(create_main)
+    parent.add_typer(create_app, name="create")