mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-17 17:56:46 +00:00
This commit introduces the /sc:help command by adding its definition file and updating the project's documentation.
The new `/sc:help` command is designed to list all available `/sc` commands, improving discoverability of the framework's features. The following changes are included: - Created `SuperClaude/Commands/help.md` with a detailed description of the command. - Updated `README.md` to reflect the new command count and mention the `/sc:help` command. - Updated `Docs/User-Guide/commands.md` with comprehensive documentation for the new command. This commit only adds the command definition and documentation, as per the user's instructions. The implementation logic is handled by an external system and is not part of this repository. Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com
This commit is contained in:
parent
48b944109e
commit
6133a89290
@ -1,6 +1,6 @@
|
|||||||
# SuperClaude Commands Guide
|
# SuperClaude Commands Guide
|
||||||
|
|
||||||
SuperClaude provides 23 commands for Claude Code: `/sc:*` commands for workflows and `@agent-*` for specialists.
|
SuperClaude provides 24 commands for Claude Code: `/sc:*` commands for workflows and `@agent-*` for specialists.
|
||||||
|
|
||||||
## Command Types
|
## Command Types
|
||||||
|
|
||||||
@ -125,6 +125,14 @@ python3 -m SuperClaude install --list-components | grep mcp
|
|||||||
- Feature exploration: `/sc:brainstorm "user authentication system"`
|
- Feature exploration: `/sc:brainstorm "user authentication system"`
|
||||||
- Problem solving: `/sc:brainstorm "slow database queries"`
|
- Problem solving: `/sc:brainstorm "slow database queries"`
|
||||||
|
|
||||||
|
### `/sc:help` - Command Reference
|
||||||
|
**Purpose**: Displays a list of all available `/sc` commands and their descriptions.
|
||||||
|
**Syntax**: `/sc:help`
|
||||||
|
|
||||||
|
**Use Cases**:
|
||||||
|
- Discovering available commands: `/sc:help`
|
||||||
|
- Getting a quick reminder of command names: `/sc:help`
|
||||||
|
|
||||||
### `/sc:implement` - Feature Development
|
### `/sc:implement` - Feature Development
|
||||||
**Purpose**: Full-stack feature implementation with intelligent specialist routing
|
**Purpose**: Full-stack feature implementation with intelligent specialist routing
|
||||||
**Syntax**: `/sc:implement "feature description"` `[--type frontend|backend|fullstack] [--focus security|performance]`
|
**Syntax**: `/sc:implement "feature description"` `[--type frontend|backend|fullstack] [--focus security|performance]`
|
||||||
@ -292,6 +300,7 @@ python3 -m SuperClaude install --list-components | grep mcp
|
|||||||
### Utility Commands
|
### Utility Commands
|
||||||
| Command | Purpose | Best For |
|
| Command | Purpose | Best For |
|
||||||
|---------|---------|----------|
|
|---------|---------|----------|
|
||||||
|
| **help** | List all commands | Discovering available commands |
|
||||||
| **git** | Version control | Commit management, branch strategies |
|
| **git** | Version control | Commit management, branch strategies |
|
||||||
| **index** | Command discovery | Exploring capabilities, finding commands |
|
| **index** | Command discovery | Exploring capabilities, finding commands |
|
||||||
|
|
||||||
@ -313,10 +322,10 @@ python3 -m SuperClaude install --list-components | grep mcp
|
|||||||
- **Analysis**: analyze, business-panel, spec-panel, troubleshoot, explain
|
- **Analysis**: analyze, business-panel, spec-panel, troubleshoot, explain
|
||||||
- **Quality**: improve, cleanup, test, document
|
- **Quality**: improve, cleanup, test, document
|
||||||
- **Management**: task, spawn, load, save, reflect
|
- **Management**: task, spawn, load, save, reflect
|
||||||
- **Utility**: index, select-tool
|
- **Utility**: help, index, select-tool
|
||||||
|
|
||||||
**By Complexity:**
|
**By Complexity:**
|
||||||
- **Beginner**: brainstorm, implement, analyze, test
|
- **Beginner**: brainstorm, implement, analyze, test, help
|
||||||
- **Intermediate**: workflow, design, business-panel, spec-panel, improve, document
|
- **Intermediate**: workflow, design, business-panel, spec-panel, improve, document
|
||||||
- **Advanced**: spawn, task, select-tool, reflect
|
- **Advanced**: spawn, task, select-tool, reflect
|
||||||
|
|
||||||
|
|||||||
@ -55,9 +55,11 @@
|
|||||||
|
|
||||||
| **Commands** | **Agents** | **Modes** | **MCP Servers** |
|
| **Commands** | **Agents** | **Modes** | **MCP Servers** |
|
||||||
|:------------:|:----------:|:---------:|:---------------:|
|
|:------------:|:----------:|:---------:|:---------------:|
|
||||||
| **23** | **14** | **6** | **6** |
|
| **24** | **14** | **6** | **6** |
|
||||||
| Slash Commands | Specialized AI | Behavioral | Integrations |
|
| Slash Commands | Specialized AI | Behavioral | Integrations |
|
||||||
|
|
||||||
|
Use the new `/sc:help` command to see a full list of all available commands.
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
63
SuperClaude/Commands/help.md
Normal file
63
SuperClaude/Commands/help.md
Normal file
@ -0,0 +1,63 @@
|
|||||||
|
---
|
||||||
|
name: help
|
||||||
|
description: "List all available /sc commands and their functionality"
|
||||||
|
category: utility
|
||||||
|
complexity: low
|
||||||
|
mcp-servers: []
|
||||||
|
personas: []
|
||||||
|
---
|
||||||
|
|
||||||
|
# /sc:help - Display All Commands
|
||||||
|
|
||||||
|
## Functionality
|
||||||
|
The `/sc:help` command provides a comprehensive list of all available SuperClaude (`/sc`) commands. It is designed to help users discover the full range of capabilities of the SuperClaude framework. The command dynamically fetches all registered commands and displays their names and a brief description of their functionality.
|
||||||
|
|
||||||
|
## Triggers
|
||||||
|
- When a user needs to see all available `/sc` commands.
|
||||||
|
- When a user is unsure of what commands are available.
|
||||||
|
- When a user is looking for a specific command but does not remember its name.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
To use the command, simply type `/sc:help` in the chat.
|
||||||
|
|
||||||
|
```
|
||||||
|
/sc:help
|
||||||
|
```
|
||||||
|
|
||||||
|
The command takes no arguments.
|
||||||
|
|
||||||
|
## Command Output
|
||||||
|
The output will be a formatted list of all available `/sc` commands. Each entry in the list will contain:
|
||||||
|
- The command name (e.g., `/sc:analyze`)
|
||||||
|
- A brief description of the command's purpose.
|
||||||
|
|
||||||
|
The list will be dynamically generated, so it will always be up-to-date with the currently installed commands.
|
||||||
|
|
||||||
|
### Example Output
|
||||||
|
```
|
||||||
|
Here are the available /sc commands:
|
||||||
|
|
||||||
|
- /sc:analyze: Perform a detailed analysis of the codebase.
|
||||||
|
- /sc:build: Execute the build process for the project.
|
||||||
|
- /sc:explain: Provide a detailed explanation of a concept or code block.
|
||||||
|
- /sc:help: Display this list of all available commands.
|
||||||
|
- ... and so on for all other commands.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Boundaries
|
||||||
|
|
||||||
|
**Will:**
|
||||||
|
- Provide a list of all registered `/sc` commands.
|
||||||
|
- Display the name and a brief, one-line description of each command.
|
||||||
|
- Always provide the most up-to-date list of commands.
|
||||||
|
|
||||||
|
**Will Not:**
|
||||||
|
- Execute any other command.
|
||||||
|
- Provide detailed documentation for each command. For that, use `/sc:explain`.
|
||||||
|
- Accept any arguments or flags.
|
||||||
|
|
||||||
|
## Pro-Tip
|
||||||
|
For more detailed information on a specific command, use the `/sc:explain` command. For example, to learn more about the `/sc:build` command, you can type:
|
||||||
|
```
|
||||||
|
/sc:explain /sc:build
|
||||||
|
```
|
||||||
Loading…
x
Reference in New Issue
Block a user