指令
Documentation Index
Fetch the complete documentation index at: https://docs.qoder.com/llms.txt
Use this file to discover all available pages before exploring further.
指令
自定义指令(Custom Commands)
自定义指令功能允许您将常用的提示词(Prompts)和工作流封装为可复用的命令。只需在 Agent 对话框中输入 /,即可快速调用这些指令,显著提升日常开发效率。
无论您是频繁执行代码审查、生成测试用例,还是需要快速查询项目规范,自定义指令都能将重复性操作简化为”一键式”任务。
指令类型与作用范围
| 特性 | 用户级指令(User Commands) | 项目级指令(Project Commands) |
|---|---|---|
| 作用范围 | 对当前用户的所有项目生效 | 仅在当前项目根目录及其子目录中生效 |
| 存储路径 | – macOS / Linux: /home/<username>/.qoder/commands/ 或 /Users/<username>/.qoder/commands/– Windows: C:\Users\<username>\.qoder\commands\ |
<项目根目录>/.qoder/commands/ |
| 适用场景 | 通用开发任务,例如: • 审查代码 • 生成单元测试 |
项目专属任务,例如: • 检查本项目 API 规范 • 校验配置文件格式 |
| 共享方式 | 仅限当前用户使用 | 可通过 Git 等版本控制系统与团队成员共享 |
注意:用户级指令不支持跨设备同步,您可以手动迁移配置文件。
创建自定义指令
- 打开指令管理界面
- 方法一:进入 Qoder 设置中的指令页面,点击 “添加” 按钮
-
方法二:在对话框中输入
/,点击底部的 “添加指令” 快捷入口 -
在顶部搜索栏中输入一个唯一指令名称(如
gen-test),然后按 回车。 -
选择指令类型:
- 用户级:适用于所有项目的通用命令
-
项目级:仅在当前项目中可用
-
在引导文案区域填写完整的提示词内容,保存文件后将自动保存您的指令。
-
返回会话,在对话框内输入
/即可看到新创建的指令。
示例指令
“`
## 概述
用于评估源代码的系统化框架,以验证技术卓越性、稳健性和安全合规性。
## 评估领域
### 技术实现
– [ ] 需求准确实现
– [ ] 算法效率验证
– [ ] 资源管理优化
– [ ] 性能考虑已解决
– [ ] 系统集成验证
### 开发标准
– [ ] 设计模式正确应用
– [ ] 代码模块化维护
– [ ] 文档完整性
– [ ] 测试覆盖充分
– [ ] 日志实现
– [ ] 错误处理策略
### 风险管理
– [ ] 遵循安全最佳实践
– [ ] 数据验证全面
– [ ] 身份验证方法安全
– [ ] 授权规则定义
– [ ] API 安全验证
### 维护方面
– [ ] 代码可维护性
– [ ] 依赖管理
– [ ] 版本兼容性
– [ ] 技术债务评估
“`
→ 立即体验
“`
## 概述
系统安全态势的系统化检查,专注于漏洞检测、威胁防御和合规验证。
## 评估领域
1. **应用安全**
– 源代码漏洞扫描
– 安全补丁状态
– 框架安全审计
– 库版本控制
2. **认证系统**
– 身份管理审查
– 密码策略合规
– 多因素认证
– 会话管理审计
3. **数据保护**
– 加密实现
– 数据访问模式
– 隐私合规
– 备份安全
4. **系统架构**
– 网络分段
– 防火墙配置
– 负载均衡器安全
– API 网关保护
## 验证要点
### 核心要求
– [ ] 应用安全补丁
– [ ] 符合加密标准
– [ ] 访问控制验证
– [ ] 审计日志启用
– [ ] 入侵检测激活
### 高级措施
– [ ] 渗透测试完成
– [ ] 安全监控配置
– [ ] 灾难恢复测试
– [ ] 事件响应计划更新
“`
→ 立即体验
“`
## 概述
用于提交代码更改的标准化流程,包含全面的文档和验证要求。
## 准备步骤
1. **代码质量保证**
– 静态代码分析完成
– 代码格式验证
– 移除未使用代码
– 更新注释
– 测试覆盖确认
2. **变更文档**
– 实现细节
– 技术决策
– 性能影响
– 迁移步骤
– 回滚程序
3. **测试验证**
– 单元测试执行
– 集成测试通过
– 性能测试运行
– UI/UX 验证完成
– 跨浏览器测试
## 提交要求
### 文档
– [ ] 架构变更记录
– [ ] API 修改文档
– [ ] 配置更新列表
– [ ] 依赖文档
### 质量门禁
– [ ] 代码审查通过
– [ ] 安全审查通过
– [ ] 性能标准符合
– [ ] CI/CD 管道绿色
### 合并后计划
– [ ] 部署策略
– [ ] 监控设置
– [ ] 功能开关配置
– [ ] 备份程序
“`
→ 立即体验
“`
## 概述
执行项目测试套件并通过系统化故障排除和验证解决检测到的问题。
## 测试阶段
1. **环境设置**
– 验证开发环境
– 检查依赖状态
– 确认测试数据可用性
– 验证配置设置
2. **测试执行**
– 运行单元测试套件
– 执行集成测试
– 执行冒烟测试
– 检查代码覆盖率
3. **问题解决**
– 记录测试失败
– 分析错误模式
– 调试失败用例
– 实施修复
## 验证矩阵
### 核心测试
– [ ] 单元测试完成
– [ ] API 测试验证
– [ ] 数据库测试结果
– [ ] 缓存行为检查
### 系统健康
– [ ] 内存使用正常
– [ ] 响应时间可接受
– [ ] 错误率在限制内
– [ ] 资源利用稳定
## 解决流程
1. **修复实施**
– 首先解决关键问题
– 应用必要补丁
– 更新测试用例
– 记录变更
“`
→ 立即体验
“`
## 概述
创建并保存结构化的 markdown 文件 (agents.md),定义 AI 代理规范以供模型理解。
## 生成工作流
1. **文件创建**
– 设置文件路径: ./docs/agents.md
– 如目录不存在则创建
– 初始化 markdown 文件
– 设置文件权限
2. **内容生成**
– 写入文件头
– 生成元数据部分
– 创建主要内容块
– 添加版本控制信息
3. **文档结构**
– 定义代理身份
– 列出能力和限制
– 指定交互规则
– 记录依赖关系
## 文件组成
### 必需部分
– [ ] 文件元数据
– [ ] 代理定义
– [ ] 能力矩阵
– [ ] 交互协议
– [ ] 版本信息
### 文件操作
– [ ] 目录检查
– [ ] 文件创建
– [ ] 内容写入
– [ ] 权限设置
## 验证步骤
1. **文件验证**
– 检查文件存在性
– 验证 markdown 语法
– 验证内容结构
– 确认文件可访问性
“`
→ 立即体验