Skip to content

Commit 865d85a

Browse files
Enhancing the ui (#4)
* 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. --------- Co-authored-by: Mithun Gowda B <[email protected]> Co-authored-by: Prashant R <[email protected]>
1 parent 742569f commit 865d85a

File tree

7 files changed

+774
-196
lines changed

7 files changed

+774
-196
lines changed

.github/workflows/publish-pypi.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
build-and-publish:
2626
name: Build and publish Python package
2727
runs-on: ubuntu-latest
28-
environment:
28+
environment:
2929
name: ${{ github.event_name == 'release' && 'pypi' || 'testpypi' }}
3030
url: ${{ github.event_name == 'release' && 'https://pypi.org/p/SuperQwen' || 'https://test.pypi.org/p/SuperQwen' }}
3131

@@ -62,25 +62,25 @@ jobs:
6262
import toml
6363
import sys
6464
sys.path.insert(0, '.')
65-
65+
6666
# Load pyproject.toml version using dynamic version
6767
with open('pyproject.toml', 'r') as f:
6868
pyproject = toml.load(f)
69-
69+
7070
# Load package version
7171
from SuperQwen import __version__
72-
72+
7373
print(f'Package version: {__version__}')
7474
print(f'Dynamic version configured in pyproject.toml: {pyproject[\"tool\"][\"setuptools\"][\"dynamic\"][\"version\"]}')
75-
75+
7676
# Since version is dynamic, we just verify the package can be imported
7777
print('✅ Version loaded successfully from package')
7878
"
79-
79+
8080
- name: Clean previous builds
8181
run: |
8282
rm -rf dist/ build/ *.egg-info/
83-
83+
8484
- name: Build package
8585
run: |
8686
echo "🔨 Building package..."
@@ -101,15 +101,15 @@ jobs:
101101
repository-url: https://test.pypi.org/legacy/
102102
password: ${{ secrets.TEST_PYPI_API_TOKEN }}
103103
print-hash: true
104-
104+
105105
# Upload to production PyPI (only on releases)
106106
- name: Upload to PyPI
107107
if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.event.inputs.target == 'pypi')
108108
uses: pypa/gh-action-pypi-publish@release/v1
109109
with:
110110
password: ${{ secrets.PYPI_API_TOKEN }}
111111
print-hash: true
112-
112+
113113
- name: Create deployment summary
114114
if: always()
115115
run: |
@@ -121,7 +121,7 @@ jobs:
121121
echo "| Version | $(python -c 'from SuperQwen import __version__; print(__version__)') |" >> $GITHUB_STEP_SUMMARY
122122
echo "| Commit | ${{ github.sha }} |" >> $GITHUB_STEP_SUMMARY
123123
echo "" >> $GITHUB_STEP_SUMMARY
124-
124+
125125
if [ "${{ github.event_name }}" == "release" ]; then
126126
echo "🎉 **Production release published to PyPI!**" >> $GITHUB_STEP_SUMMARY
127127
echo "Install with: \`pip install SuperQwen\`" >> $GITHUB_STEP_SUMMARY

README.md

Lines changed: 100 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -4,100 +4,128 @@
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
55
[![Python versions](https://img.shields.io/pypi/pyversions/SuperQwen.svg)](https://pypi.org/project/SuperQwen/)
66

7-
SuperQwen is an AI-enhanced development framework designed to supercharge your command-line workflow, forked from the original SuperClaude/SuperGemini projects. It provides structured development capabilities with a powerful command-line interface, specialized AI agents, and behavioral modes.
7+
**SuperQwen is an AI-enhanced development framework designed to supercharge your command-line workflow.**
88

9-
## Why SuperQwen?
9+
Forked from the original SuperClaude/SuperGemini projects, SuperQwen provides structured development capabilities with a powerful command-line interface, specialized AI agents, and behavioral modes to streamline your development process.
1010

11-
- **Modern & User-Friendly**: A polished and intuitive command-line interface built with Typer and Rich.
12-
- **Granular Control**: Install and uninstall exactly the components you need (`commands`, `modes`, `agents`, etc.).
13-
- **Interactive Experience**: Run `superqwen install` for a guided, interactive setup.
14-
- **Self-Updating**: Keep your framework up-to-date with a simple `superqwen update` command.
15-
- **Extensible**: Easily add your own commands, agents, and modes to customize your workflow.
11+
## Key Features
12+
13+
* **✨ Modern & User-Friendly UI**: A polished and intuitive command-line interface with a custom UI for a consistent experience.
14+
* **🧩 Modular Components**: Install and uninstall exactly the components you need (`commands`, `modes`, `agents`, etc.).
15+
* **🤖 Interactive Experience**: Run `superqwen install` for a guided, interactive setup to get you started in seconds.
16+
* **🚀 Self-Updating**: Keep your framework up-to-date with a simple `superqwen update` command.
17+
* **🔧 Extensible by Design**: Easily add your own commands, agents, and modes to customize your workflow.
18+
* **🧠 Intelligent MCP Integration**: Leverages the Model Context Protocol (MCP) for advanced, context-aware AI interactions.
1619

1720
---
1821

1922
## Installation
2023

21-
Install the framework directly from PyPI:
24+
Install the framework directly from PyPI using pip:
2225

2326
```bash
2427
pip install SuperQwen
2528
```
2629

27-
After installation, set up the framework components using the interactive installer:
30+
After installation, it is highly recommended to run the interactive setup to install the core components:
2831

2932
```bash
3033
superqwen install
3134
```
32-
This will present you with a checklist of components to install.
33-
34-
---
35-
36-
## Usage
3735

38-
The SuperQwen CLI (`superqwen`) is the main entry point for managing your framework.
36+
This will launch the interactive installer, allowing you to choose which components to set up.
3937

40-
### CLI Screenshot
38+
### Installer Preview
4139

4240
Here's a glimpse of the installer in action:
41+
4342
```
44-
$ superqwen install all
45-
46-
=======================
47-
SuperQwen_Framework
48-
version 4.1.0-b2
49-
=======================
50-
[13:52:01] INFO Installing Commands...
51-
INFO Copied 18 command files.
52-
INFO Installing Modes...
53-
INFO Copied 5 mode files.
54-
INFO Installing Agents...
55-
INFO Copied 13 agent files.
56-
INFO Installing MCP Config...
57-
INFO Configured verified MCP servers.
58-
Installing all components... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
59-
60-
✅ All components installed successfully!
43+
$ superqwen install
44+
45+
============================================================
46+
SuperQwen Installer
47+
Interactive Setup
48+
NomenAK <[email protected]> | Mithun Gowda B <[email protected]>
49+
============================================================
50+
51+
52+
Installation Options
53+
====================
54+
1. Core Components (Commands, Modes, Agents)
55+
2. MCP Config (for advanced users)
56+
3. All of the above
57+
58+
Enter your choice (1-3):
59+
> 3
60+
Ready to install the selected components? [Y/n]
61+
> y
62+
[INFO] Starting installation...
63+
[1/4] Installing commands...
64+
Commands: [██████████████████████████████████████████████████] 100.0% Complete
65+
[2/4] Installing modes...
66+
Modes: [██████████████████████████████████████████████████] 100.0% Complete
67+
[3/4] Installing agents...
68+
Agents: [██████████████████████████████████████████████████] 100.0% Complete
69+
[4/4] Installing mcp...
70+
Mcp: [██████████████████████████████████████████████████] 100.0% Complete
71+
72+
✅ Interactive installation complete!
6173
```
6274

75+
---
76+
77+
## Usage
78+
79+
The `superqwen` CLI is the main entry point for managing your framework.
80+
6381
### Core Commands
6482

65-
- **`superqwen install [component]`**: Install components.
66-
- `superqwen install all`: Install everything non-interactively.
67-
- `superqwen install commands`: Install just the commands.
68-
- `superqwen install`: Launch the interactive installer (recommended).
69-
- **`superqwen uninstall [component]`**: Uninstall components.
70-
- `superqwen uninstall all`: Uninstall everything non-interactively.
71-
- `superqwen uninstall`: Launch the interactive uninstaller.
72-
- **`superqwen update`**: Update the framework to the latest version from PyPI.
73-
- **`superqwen --help`**: Get help on any command or subcommand.
74-
75-
Once installed, you can use the slash commands and modes within your Qwen CLI session.
76-
77-
### Available Commands
78-
79-
Here is a complete list of all available SuperQwen (`/sq`) commands.
80-
81-
| Command | Description |
82-
|---|---|
83-
| `/sq:analyze` | Comprehensive code analysis across quality, security, performance, and architecture domains |
84-
| `/sq:build` | Build, compile, and package projects with intelligent error handling and optimization |
85-
| `/sq:cleanup` | Systematically clean up code, remove dead code, and optimize project structure |
86-
| `/sq:design` | Design system architecture, APIs, and component interfaces with comprehensive specifications |
87-
| `/sq:document` | Generate focused documentation for components, functions, APIs, and features |
88-
| `/sq:estimate` | Provide development estimates for tasks, features, or projects with intelligent analysis |
89-
| `/sq:explain` | Provide clear explanations of code, concepts, and system behavior with educational clarity |
90-
| `/sq:git` | Git operations with intelligent commit messages and workflow optimization |
91-
| `/sq:help` | List all available /sq commands and their functionality |
92-
| `/sq:implement` | Feature and code implementation with intelligent persona activation and MCP integration |
93-
| `/sq:improve` | Apply systematic improvements to code quality, performance, and maintainability |
94-
| `/sq:index` | Generate comprehensive project documentation and knowledge base with intelligent organization |
95-
| `/sq:load` | Session lifecycle management with Serena MCP integration for project context loading |
96-
| `/sq:reflect` | Task reflection and validation using Serena MCP analysis capabilities |
97-
| `/sq:save` | Session lifecycle management with Serena MCP integration for session context persistence |
98-
| `/sq:select-tool` | Intelligent MCP tool selection based on complexity scoring and operation analysis |
99-
| `/sq:test` | Execute tests with coverage analysis and automated quality reporting |
100-
| `/sq:troubleshoot` | Diagnose and resolve issues in code, builds, deployments, and system behavior |
83+
| Command | Description |
84+
| ----------------------------------- | ----------------------------------------------------- |
85+
| `superqwen install` | Launch the interactive installer. |
86+
| `superqwen install all` | Install all components non-interactively. |
87+
| `superqwen install [component]` | Install a specific component (e.g., `commands`). |
88+
| `superqwen uninstall` | Launch the interactive uninstaller. |
89+
| `superqwen uninstall all` | Uninstall all components non-interactively. |
90+
| `superqwen uninstall [component]` | Uninstall a specific component. |
91+
| `superqwen update` | Update the framework to the latest version from PyPI. |
92+
| `superqwen --help` | Get help on any command or subcommand. |
93+
94+
95+
### Available `/sq` Commands
96+
97+
Once installed, you can use the following slash commands (`/sq:*`) within your Qwen CLI session to leverage the power of SuperQwen's AI agents.
98+
99+
| Command | Description |
100+
| --------------- | ------------------------------------------------------------------------------------ |
101+
| `/sq:analyze` | Comprehensive code analysis (quality, security, performance, architecture). |
102+
| `/sq:build` | Build, compile, and package projects with intelligent error handling. |
103+
| `/sq:cleanup` | Systematically clean up code, remove dead code, and optimize project structure. |
104+
| `/sq:design` | Design system architecture, APIs, and component interfaces. |
105+
| `/sq:document` | Generate focused documentation for components, functions, APIs, and features. |
106+
| `/sq:estimate` | Provide development estimates for tasks, features, or projects. |
107+
| `/sq:explain` | Provide clear explanations of code, concepts, and system behavior. |
108+
| `/sq:git` | Git operations with intelligent commit messages and workflow optimization. |
109+
| `/sq:help` | List all available `/sq` commands and their functionality. |
110+
| `/sq:implement` | Feature and code implementation with intelligent persona activation. |
111+
| `/sq:improve` | Apply systematic improvements to code quality, performance, and maintainability. |
112+
| `/sq:index` | Generate comprehensive project documentation and a knowledge base. |
113+
| `/sq:load` | Session lifecycle management for loading project context via MCP. |
114+
| `/sq:reflect` | Task reflection and validation using MCP analysis capabilities. |
115+
| `/sq:save` | Session lifecycle management for persisting session context via MCP. |
116+
| `/sq:select-tool` | Intelligent MCP tool selection based on complexity scoring and operation analysis. |
117+
| `/sq:test` | Execute tests with coverage analysis and automated quality reporting. |
118+
| `/sq:troubleshoot`| Diagnose and resolve issues in code, builds, deployments, and system behavior. |
119+
120+
---
121+
122+
## Configuration
123+
124+
### MCP Servers
125+
126+
SuperQwen can integrate with Model Context Protocol (MCP) servers for advanced AI capabilities. During installation (`superqwen install mcp`), the installer will attempt to detect and configure any available MCP servers on your system.
127+
128+
The configuration is saved in `~/.qwen/settings.json`. You can manually edit this file to add or modify MCP server configurations.
101129

102130
---
103131

@@ -109,9 +137,9 @@ Contributions are welcome! Whether it's reporting a bug, suggesting a feature, o
109137

110138
This project is licensed under the MIT License - see the `LICENSE` file for details.
111139

112-
## Acknowledgment
140+
## Acknowledgments
113141

114142
This framework was originally forked from the **SuperGemini Framework**. We sincerely thank the **SuperClaude Team** for their outstanding work, which served as the foundation and inspiration for this project.
115143

116-
- https://github.com/SuperClaude-Org/SuperClaude_Framework
117-
- https://github.com/SuperClaude-Org/SuperGemini_Framework
144+
- [SuperClaude Framework](https://github.com/SuperClaude-Org/SuperClaude_Framework)
145+
- [SuperGemini Framework](https://github.com/SuperClaude-Org/SuperGemini_Framework)

SuperQwen/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
11
__version__ = "1.0.0"
2+
__author__ = "NomenAK, Mithun Gowda B"
3+
4+
__github__ = "NomenAK, MithunGowdaB"

0 commit comments

Comments
 (0)