Fixed (#5)

* feat: Unify CLI with custom UI and update authors

This commit completes the transition to a new, custom user interface across the entire SuperQwen CLI, ensuring a consistent look and feel for all commands. It also updates the project's author information as requested.

- Created a new UI module at `SuperQwen/setup/ui.py` with components for menus, progress bars, and styled console output.
- Refactored `SuperQwen/setup/cli.py` and `SuperQwen/setup/interactive.py` to replace all `rich` and `questionary` calls with the new `ui.py` module.
- Updated `SuperQwen/__init__.py` with the correct author and email information for NomenAK and Mithun Gowda B.
- Removed the now-unused `rich` and `questionary` dependencies from `pyproject.toml`, streamlining the project's dependencies.
- All interactive and non-interactive commands now share the same custom UI for a cohesive user experience.

* docs: Overhaul README with advanced structure and content

This commit completely revamps the `README.md` file to provide a more professional, comprehensive, and user-friendly overview of the SuperQwen Framework.

- Restructured the README for better logical flow and readability.
- Added a "Key Features" section with highlights of the project's capabilities.
- Updated the "Installation" and "Usage" sections with clearer instructions and more detailed examples.
- Included a preview of the new, custom installer UI to give users a glimpse of the experience.
- Added a table of all available `/sq` commands for quick reference.
- Added a "Configuration" section to explain how MCP servers are handled.
- Improved markdown formatting for better visual presentation.

* docs: Clarify command usage in README

This commit updates the `README.md` to clarify how `/sq` commands are used, based on an investigation of the command structure.

- Investigated the `.toml` files in `SuperQwen/Commands/` and determined that the `/sq` commands do not accept any flags or arguments.
- Added a note to the "Available `/sq` Commands" section in `README.md` to explain that all text following a command is treated as a single, continuous prompt for the AI.
- This change helps manage user expectations and provides clearer documentation for the command-line interface.

* feat: Implement custom help screen and version flag

This commit enhances the CLI by adding a custom help command and a `--version` flag, ensuring a fully consistent UI experience and improving usability.

- Added a new `help` command to `SuperQwen/setup/cli.py` that uses the custom `ui.display_table` function to show all available commands, replacing the default `typer` help screen.
- The `--help` and `-h` flags now trigger this custom help command for a unified look and feel.
- Running `superqwen` with no command now also displays the custom help screen.
- Added a `--version` flag (with a `-v` short alias) that prints the application's version and exits.
- These changes address user feedback to make the CLI more professional and to unify the UI across all parts of the application.

* Update __init__.py


---------

Co-authored-by: Mithun Gowda B <[email protected]>
Co-authored-by: Prashant R <[email protected]>

Author: mithun50

SuperQwen/setup/installer.py

@@ -2,48 +2,68 @@
 import shutil
 import subprocess
 import importlib.resources
+from typing import Optional
 
 from .logging import logger
 from .file_utils import QWEN_DIR, get_package_files
+from .ui import ProgressBar
 
-def install_commands():
+def install_commands(progress_bar: Optional[ProgressBar] = None):
     logger.info("Installing Commands...")
     commands_dst = QWEN_DIR / "commands" / "sq"
     commands_dst.mkdir(parents=True, exist_ok=True)
+
     files = get_package_files("commands")
-    count = 0
-    for file in files:
-        if file.name.endswith('.toml'):
-            with importlib.resources.as_file(file) as src_path:
-                shutil.copy2(src_path, commands_dst)
-                count += 1
-    logger.info(f"Copied {count} command files.")
-
-def install_modes():
+    files_to_copy = [f for f in files if f.name.endswith('.toml')]
+
+    if progress_bar:
+        progress_bar.total = len(files_to_copy)
+
+    for i, file in enumerate(files_to_copy):
+        with importlib.resources.as_file(file) as src_path:
+            shutil.copy2(src_path, commands_dst)
+        if progress_bar:
+            progress_bar.update(i + 1)
+
+    logger.info(f"Copied {len(files_to_copy)} command files.")
+
+def install_modes(progress_bar: Optional[ProgressBar] = None):
     logger.info("Installing Modes...")
     modes_dst = QWEN_DIR / "modes"
     modes_dst.mkdir(exist_ok=True)
+
     files = get_package_files("modes")
-    count = 0
-    for file in files:
-        if file.name.endswith('.md'):
-            with importlib.resources.as_file(file) as src_path:
-                shutil.copy2(src_path, modes_dst)
-                count += 1
-    logger.info(f"Copied {count} mode files.")
-
-def install_agents():
+    files_to_copy = [f for f in files if f.name.endswith('.md')]
+
+    if progress_bar:
+        progress_bar.total = len(files_to_copy)
+
+    for i, file in enumerate(files_to_copy):
+        with importlib.resources.as_file(file) as src_path:
+            shutil.copy2(src_path, modes_dst)
+        if progress_bar:
+            progress_bar.update(i + 1)
+
+    logger.info(f"Copied {len(files_to_copy)} mode files.")
+
+def install_agents(progress_bar: Optional[ProgressBar] = None):
     logger.info("Installing Agents...")
     agents_dst = QWEN_DIR / "agents"
     agents_dst.mkdir(exist_ok=True)
+
     files = get_package_files("agents")
-    count = 0
-    for file in files:
-        if file.name.endswith('.md'):
-            with importlib.resources.as_file(file) as src_path:
-                shutil.copy2(src_path, agents_dst)
-                count += 1
-    logger.info(f"Copied {count} agent files.")
+    files_to_copy = [f for f in files if f.name.endswith('.md')]
+
+    if progress_bar:
+        progress_bar.total = len(files_to_copy)
+
+    for i, file in enumerate(files_to_copy):
+        with importlib.resources.as_file(file) as src_path:
+            shutil.copy2(src_path, agents_dst)
+        if progress_bar:
+            progress_bar.update(i + 1)
+
+    logger.info(f"Copied {len(files_to_copy)} agent files.")
 
 def _verify_npx_package(package_arg: str) -> bool:
     """Verifies if an npx package is available in the npm registry."""
@@ -63,7 +83,7 @@ def _verify_npx_package(package_arg: str) -> bool:
         logger.warning(f"    - npm package '{package_name}' not found in registry.")
         return False
 
-def install_mcp():
+def install_mcp(progress_bar: Optional[ProgressBar] = None):
     logger.info("Installing MCP Config...")
     settings_file = QWEN_DIR / "settings.json"
 
@@ -73,13 +93,16 @@ def install_mcp():
         "sequential": {"command": "npx", "args": ["-y", "@modelcontextprotocol/server-sequential-thinking"]}
     }
 
+    if progress_bar:
+        progress_bar.total = len(default_mcp_servers)
+
     verified_mcp_servers = {}
+    progress_step = 0
 
     for name, config in default_mcp_servers.items():
         command_to_check = config["command"]
         if shutil.which(command_to_check):
             is_verified = True
-            # Deeper verification for npx packages
             if command_to_check == "npx":
                 npx_package_arg = next((arg for arg in config["args"] if arg.startswith('@')), None)
                 if npx_package_arg:
@@ -93,6 +116,10 @@ def install_mcp():
         else:
             logger.warning(f"  - Command '{command_to_check}' not found, skipping '{name}'.")
 
+        progress_step += 1
+        if progress_bar:
+            progress_bar.update(progress_step)
+
     if not verified_mcp_servers:
         logger.warning("No MCP servers could be verified. Skipping settings.json creation.")
         return