mirror of
https://gitee.com/ulthon/ulthon_admin.git
synced 2026-07-01 15:32:48 +08:00
docs(AGENTS): 更新调试与验证指南并移除冗余技能文档
- 将调试与验证部分简化为优先使用框架内置命令行工具 - 删除已整合的 CLI 命令参考技能文档,避免信息冗余
This commit is contained in:
@@ -1,78 +0,0 @@
|
||||
---
|
||||
name: "ulthon-cli-reference"
|
||||
description: "Ulthon Admin 框架常用 CLI 命令速查手册,包括菜单管理、Scheme 同步与 CURD 生成等命令说明。"
|
||||
---
|
||||
|
||||
# CLI 命令参考文档
|
||||
|
||||
本文档提供 Ulthon Admin 框架的常用 CLI 命令速查手册。
|
||||
|
||||
## 何时调用
|
||||
|
||||
- 当需要查找 Ulthon Admin 特定的 CLI 命令(如菜单管理、Scheme 同步、CURD 生成)及其参数时。
|
||||
- 当需要验证或调试 CLI 命令功能时。
|
||||
|
||||
## 关键原则
|
||||
|
||||
- 菜单管理命令用于操作后台菜单结构,支持 JSON/Tree 格式输出。
|
||||
- Scheme 与 CURD 命令用于保持数据库与代码的一致性,以及生成基础代码。
|
||||
- CURD 操作建议先使用 `-r` 生成到临时目录进行预览。
|
||||
- Scheme 同步操作涉及数据库变更,需谨慎使用。
|
||||
|
||||
## 菜单管理
|
||||
|
||||
| 命令 | 说明 | 常用参数 |
|
||||
|------|------|----------|
|
||||
| `admin:menu:list` | 列出菜单(树形) | `--format`, `--status`, `--pid` |
|
||||
| `admin:menu:create` | 创建菜单 | - |
|
||||
| `admin:menu:update` | 编辑菜单 | - |
|
||||
| `admin:menu:delete` | 删除菜单 | - |
|
||||
| `admin:menu:export` | 导出菜单数据 | `--format=json` |
|
||||
|
||||
## Scheme & CURD
|
||||
|
||||
| 命令 | 说明 | 常用参数 |
|
||||
|------|------|----------|
|
||||
| `scheme:sync` | 同步 Scheme 到数据库 | `--force` (跳过确认) |
|
||||
| `scheme:make` | 从数据库生成 Scheme | `-t {table}` |
|
||||
| `curd` | 生成 CURD 代码 | `-t {table}` `-r` (临时) `-f` (强制) `-d` (删除) |
|
||||
|
||||
### CURD 参数说明
|
||||
|
||||
| 参数 | 简写 | 说明 |
|
||||
|------|------|------|
|
||||
| `--table` | `-t` | 主表名(支持带前缀或不带前缀) |
|
||||
| `--force` | `-f` | 强制覆盖模式(**谨慎使用**) |
|
||||
| `--delete` | `-d` | 删除模式(**删除生成的文件,不是数据库操作**) |
|
||||
| `--runtime` | `-r` | 临时生成模式(**推荐用于预览**) |
|
||||
| `--examples` | | 显示使用示例 |
|
||||
|
||||
## 快速示例
|
||||
|
||||
### 菜单管理
|
||||
|
||||
```bash
|
||||
php think admin:menu:list # 查看菜单树
|
||||
php think admin:menu:create # 创建菜单
|
||||
php think admin:menu:export --format=json # 导出菜单
|
||||
```
|
||||
|
||||
### CURD 操作
|
||||
|
||||
```bash
|
||||
# 预览生成(推荐)
|
||||
php think curd -t daka_record -r
|
||||
|
||||
# 正式生成
|
||||
php think curd -t daka_record
|
||||
|
||||
# 强制覆盖(小心)
|
||||
php think curd -t daka_record -f
|
||||
```
|
||||
|
||||
## 注意事项
|
||||
|
||||
1. **表名参数**:CURD 和 Scheme 命令的表名支持带前缀或不带前缀(v2.x+ 自动检测)
|
||||
2. **安全确认**:`scheme:sync` 默认需要确认,使用 `-ff` 跳过
|
||||
3. **临时生成**:CURD 使用 `-r` 可生成到临时目录预览
|
||||
4. **删除模式**:CURD 的 `-d` 是删除生成的文件,不是数据库操作
|
||||
Reference in New Issue
Block a user