You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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]>
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.**
8
8
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.
10
10
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.
16
19
17
20
---
18
21
19
22
## Installation
20
23
21
-
Install the framework directly from PyPI:
24
+
Install the framework directly from PyPI using pip:
22
25
23
26
```bash
24
27
pip install SuperQwen
25
28
```
26
29
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:
28
31
29
32
```bash
30
33
superqwen install
31
34
```
32
-
This will present you with a checklist of components to install.
33
-
34
-
---
35
-
36
-
## Usage
37
35
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.
39
37
40
-
### CLI Screenshot
38
+
### Installer Preview
41
39
42
40
Here's a glimpse of the installer in action:
41
+
43
42
```
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
|`/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.
101
129
102
130
---
103
131
@@ -109,9 +137,9 @@ Contributions are welcome! Whether it's reporting a bug, suggesting a feature, o
109
137
110
138
This project is licensed under the MIT License - see the `LICENSE` file for details.
111
139
112
-
## Acknowledgment
140
+
## Acknowledgments
113
141
114
142
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.
0 commit comments