创建了一个 Strapi 项目,并看到了终端输出的几个常用命令。下面详细解释每个命令的作用和使用场景 ,更好地理解它们在开发、部署和维护 Strapi 项目中的用途。
1. npm run develop
✅ 含义:
启动 Strapi 的 开发模式(Watch Mode)
🔧 特点:
- 自动监听文件变化(如内容模型、配置文件等)
- 修改代码后会自动重启服务
- 适合本地开发调试阶段使用
💡 示例:
npm run develop
访问后台地址:
http://localhost:1337/admin
2. npm run start
✅ 含义:
启动 Strapi 的 生产模式(非 Watch 模式)
🔧 特点:
- 不监听文件变化,性能更优
- 适用于部署到服务器或生产环境
- 不建议用于开发阶段
💡 示例:
npm run start
3. npm run build
✅ 含义:
构建 Strapi 的 管理后台(Admin Panel)
🔧 特点:
- 编译 Admin UI 静态资源(React 前端)
- 构建完成后的内容会放在 build/ 目录中
- 在部署前通常需要执行这个命令
💡 示例:
npm run build
注意:如果你没有自定义 Admin UI,通常不需要手动运行这个命令。
4. npm run deploy
✅ 含义:
部署你的 Strapi 项目(需自定义脚本)
🔧 特点:
- 默认情况下,该命令是空的,你需要自己在 package.json 中定义部署逻辑
- 可以用于将项目部署到远程服务器、云平台(如 Heroku、Vercel、阿里云等)
💡 示例(你可以自定义):
"scripts": {
"deploy": "git push heroku main"
}
5. npm run seed:example
✅ 含义:
向数据库中导入 示例数据(Sample Data)
🔧 特点:
- 创建一些默认的内容类型和测试数据(如用户、文章、分类等)
- 在项目初始化时可选安装
- 如果你跳过了初始化示例数据,可以随时运行此命令补上
💡 示例:
npm run seed:example
6. npm run strapi
✅ 含义:
显示所有可用的 Strapi CLI 命令
🔧 特点:
- 查看并运行各种内部工具命令
- 如创建内容类型、生成 API、迁移数据库等
💡 示例:
npm run strapi -- generate:api project
这将使用 Strapi CLI 创建一个名为 project 的内容类型。
🧰 常见 CLI 命令补充(通过 npm run strapi 调用)
| |
命令 | 说明 |
npm run strapi – generate:api <name> | 创建一个新的 API(含内容类型) |
npm run strapi – generate:controller <name> | 创建控制器 |
npm run strapi – generate:service <name> | 创建服务 |
npm run strapi – db:migrate:up | 执行数据库迁移 |
npm run strapi – config:get server.host | 获取当前配置项 |
🧪 总结对比表
| | |
命令 | 使用场景 | 是否推荐开发阶段使用 |
npm run develop | 本地开发调试 | ✅ 推荐 |
npm run start | 生产环境启动 | ❌ 不推荐开发使用 |
npm run build | 构建 Admin 界面 | ✅ 需要时使用 |
npm run deploy | 部署到服务器 | ✅ 根据平台定制 |
npm run seed:example | 导入示例数据 | ✅ 可选 |
npm run strapi | 查看 CLI 工具 | ✅ 必备 |