README

Owl Admin

快速且灵活的后台框架

官网 | Demo | Github | Gitee | 文档 (备用文档) | 加群

项目介绍

基于 Laravel 、 amis 开发的后台框架, 快速且灵活~

当前版本支持 Laravel 11.x - 13.x。

• 基于 amis 以 json 的方式在后端构建页面，减少前端开发工作量，提升开发效率。
• 在 amis 150多个组件都不满足的情况下, 可自行开发前端。
• 框架为前后端分离 (不用再因为框架而束手束脚~)。

内置功能

• 基础后台功能
  • 后台用户管理
  • 角色管理
  • 权限管理
  • 菜单管理
• 代码生成器
  • 保存生成记录
  • 导入/导出生成记录
  • 可使用命令清除生成的内容
  • 无需更改代码即可生成完整功能
• amis 全组件封装 150+ , 无需前端开发即可完成复杂页面
• 多模块支持
• 图形化扩展管理
• 动态 API 模板管理（CRUD / 选项 / 设置 / 状态切换 / 聚合统计）

截图

安装

👉 注意: OwlAdmin 是 laravel 的扩展包, 安装前请确保你会使用 laravel

1. 创建 laravel 项目

composer create-project laravel/laravel example-app

2. 配置数据库信息并安装 API 模块

# .env
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=owl_admin
DB_USERNAME=root
DB_PASSWORD=

安装 API 模块 (Laravel 11+)

php artisan install:api

3. 获取 Owl Admin

composer require slowlyo/owl-admin

4. 安装

# 先发布框架资源
php artisan admin:publish
# 执行安装 (可以在执行安装命令前在 config/admin.php 中修改部分配置)
php artisan admin:install

5. 安装 AI 编辑器开发资料（可选）

如果你希望在 Codex、Cursor、Claude Code、Trae 等 AI 编辑器中开发 Owl Admin 项目，可以执行：

php artisan admin:ai-install

该命令会在项目根目录生成 .agents 目录：

• .agents/skills：Codex、Cursor 等支持 Agent Skills 的工具可直接读取
• .agents/adapters：提供 Claude Code、Cursor、Trae 等编辑器的规则适配文件
• .agents/README.md：说明不同编辑器如何使用这些文件

内置 skills 覆盖后台业务开发、amis 页面、扩展多模块、代码生成器、动态 API、安装升级命令、前端资源、框架原理、助手函数、组件管道、系统设置、动态页面、开发示例和常见问题等场景，并按主题合并为少量入口，减少 AI 选择噪音。

常用编辑器复制方式：

# Cursor 项目规则
mkdir -p .cursor/rules
cp .agents/adapters/cursor/owl-admin.mdc .cursor/rules/owl-admin.mdc

# Claude Code 项目规则
cp .agents/adapters/CLAUDE.md CLAUDE.md

# Claude Code Agent Skills
mkdir -p .claude/skills
cp -R .agents/skills/* .claude/skills/

# Trae 项目规则
mkdir -p .trae/rules
cp .agents/adapters/trae/owl-admin.md .trae/rules/owl-admin.md

如果本地已调整过 .agents 文件，可使用 --force 覆盖：

php artisan admin:ai-install --force

6. 运行项目

启动服务, 访问 /admin 路由即可
初始账号密码都是 admin

支持项目

你可以通过以下方式支持项目:

• 报告 Bug
• 提交 PR
  • 参见 贡献文档
• 点点 Star
  • 如果觉得项目不错，或者已经在使用了，希望你可以去 Github 或者 Gitee 帮我们点个 ⭐ Star，这将是对我们极大的鼓励与支持。