命令

​

快速开始

​

在 TUI 模式下使用命令

1. 启动 Qoder CN CLI 进入 TUI 模式：
   Copy

   qoderclicn
   
2. 在输入框中输入 / 字符，查看可用命令清单。
3. 选择目标命令后按 Enter 键执行，例如 /config 查看或修改 Qoder CN CLI 配置项：
   Copy

   /config
   

​

在无头模式下使用命令

# 执行命令（包含额外指令）
qoderclicn -p '/review 重点检查注释覆盖情况'

# 执行自定义 Prompt 命令
qoderclicn -p '/git-commit'

​

命令类型

​

内置命令

​

创建自定义命令

​

方式一：AI 辅助生成（推荐）

1. 在 TUI 中执行 /commands 进入命令配置面板。
2. 通过 Tab 键切换到目标标签页（User 或 Project）。
3. 使用上下键选择 "Create new command..." 并按 Enter。
   Copy

   ------------------------------------------------------------------------------------------
   Extend Commands:  [User]  Project
   
   → Create new command...
   
   Command list:
   No project commands found.
   
   Press Enter to select · Esc to exit · Tab to cycle tabs · ↑↓ to navigate
   
4. 在输入框中描述期望创建的命令功能，例如：
   Copy

   > View all git changes and make a good commit
   
5. Qoder CN CLI 会自动生成命令配置文件并保存到对应目录：
   Copy

   # 项目级（Project 标签页）
   .qoder/commands/
   
   # 用户级（User 标签页）
   ~/.qoder-cn/commands/
   

​

方式二：手动编写配置（进阶）

​

配置文件格式

---
name: command-name
description: 命令的作用描述，将在 TUI 命令清单中显示
---

这里是命令的系统提示词内容。
当用户执行该命令时，这段提示词会被提交到对话中，指导 CLI 完成特定任务。

可以使用多行文本，支持 Markdown 格式。

• 使用小写字母和连字符（例如 git-commit）
• 避免使用空格或特殊字符
• 建议文件名与 name 字段保持一致
• 子目录中的命令使用 : 作为命名空间分隔符，例如 commands/git/commit.md 注册为 /git:commit
• frontmatter.name 仅作为 TUI 中的展示名，命令调用名始终由文件路径推导
• 同目录下若存在 SKILL.md，该目录会注册为单个命令（如 /git），目录内其它兄弟 .md 文件会被忽略
• 命令名段会原样保留，不做字符替换；建议在文件名中坚持使用易于输入的字符

​

配置示例

---
name: git-commit
description: Use this command when you need to review all git changes in the current repository and generate a well-structured commit message. This is particularly useful before committing code changes, especially after completing a feature or fixing a bug.
---

You are an expert Git commit message generator. Your role is to analyze all git changes in the repository and create clear, concise, and meaningful commit messages that follow conventional commit standards.

When analyzing changes, you will:
1. Examine all staged and unstaged changes using `git diff` and related commands
2. Identify the type of changes (feat, fix, chore, docs, style, refactor, test, etc.)
3. Determine the scope of changes (which component/module was affected)
4. Summarize the primary change in a clear subject line (50 characters or less)
5. Provide a detailed body explanation if the changes are complex
6. Follow conventional commit format: `<type>(<scope>): <subject>`

​

存储位置与优先级

​

查看和使用自定义命令

​

查看命令详情

1. 在 TUI 中执行 /commands 进入命令配置面板。
2. 通过 Tab 键切换到目标标签页（User 或 Project）。
3. 使用上下键选择目标命令并按 Enter，进入命令详情页面。
   Copy

   Extend Commands:  [User]  Project
   
   Name: git-commit
   
   Description
   [project] Use this command when you need to review all git changes in the current
   repository and generate a well-structured commit message. This is particularly useful
   before committing code changes, especially after completing a feature or fixing a bug.
   
   System Prompt
   You are an expert Git commit message generator. Your role is to analyze all git
   changes in the repository and create clear, concise, and meaningful commit messages
   that follow conventional commit standards.
   
   When analyzing changes, you will:
   ...
   
4. 使用 Esc 键退出详情页面。

​

执行命令

╭───────────────────────────────────────────────────────╮
│ > /git-commit                                                                         │
╰───────────────────────────────────────────────────────╯
  /git-commit        [user] Use this command when you need to review all git changes ...

> /git-commit

● I'll help you create a commit message by analyzing the git changes in your repository.
  Let me first check the current status.

● Bash (git status)
...

​

常见问题

​

自定义命令无法识别

1. 检查配置文件路径是否正确（~/.qoder-cn/commands/ 或 .qoder/commands/）。
2. 检查 frontmatter 格式是否正确（以 --- 开头和结尾）。
3. 运行 /commands 重新加载命令列表。如果仍未识别，再重启 CLI（使用 /quit 退出后重新运行 qoderclicn）。

​

Frontmatter 解析失败

• 确保 frontmatter 以 --- 开头和结尾。
• 使用 | 语法定义多行 description 字段。
• 检查缩进是否正确（YAML 对缩进敏感）。

---
name: my-command
description: |
  这是第一行描述
  这是第二行描述
---