跳到主要内容

Makefile 命令参考

本页汇总仓库根目录 Makefile 中最常用的命令,方便你按安装、开发、测试、文档和版本发布场景快速查找入口。

下方命令按使用场景而不是按定义位置组织,方便你在日常开发中直接按任务找到入口。

安装与初始化

命令作用
make init安装后后端、前端依赖并启用 pre-commit
make init_db在需要时自动创建目标数据库,然后初始化 schema 与基础数据
make export_db_init_data导出 PostgreSQL 初始化数据

应用运行

命令作用
make backend以开发模式运行后端
make backend_start跳过依赖同步快速启动后端
make frontend安装依赖后以开发模式运行前端
make frontendc清理安装前端依赖后再启动前端开发服务器
make run_frontend直接启动前端开发服务器
make run_cli使用已构建的静态前端快速启动 SkillFlaw
make run_clic清理并重建前端后启动 SkillFlaw
make run_cli_debug以更偏调试的方式启动 CLI
make setup_env准备环境变量

当你需要 Vite 前端开发服务器时,使用 make frontend;当你需要更接近正式发布形态的本地运行方式时,使用 make run_climake run_clic

前端开发与静态构建

命令作用
make install_frontend使用 npm install 安装前端依赖
make install_frontendci使用 npm ci 安装前端依赖
make install_frontendc清理 node_modules 与锁文件相关产物后重新安装前端依赖
make build_frontend构建前端静态资源并复制到后端前端目录
make storybook启动 Storybook 开发服务器
make storybook_build构建静态 Storybook 产物
make storybook_network以局域网可访问方式启动 Storybook

代码质量与检查

命令作用
make format运行前后端格式化
make format_backend使用 Ruff 格式化后端代码
make format_frontend_check使用 Biome 检查前端格式
make lint执行后端类型与 lint 检查
make codespell检查拼写
make fix_codespell尝试自动修复拼写问题

测试与验证

命令作用
make tests执行组合测试流程
make unit_tests运行后端单元测试
make integration_tests运行后端集成测试
make integration_tests_no_api_keys运行不依赖 API Key 的集成测试
make integration_tests_api_keys运行依赖 API Key 的集成测试
make tests_frontend运行前端 e2e 测试
make test_frontend运行前端 Jest 单元测试
make template_tests运行 starter project 模板测试

文档工作流

命令作用
make docs_install安装 docs 依赖并使用仓库本地 Yarn cache
make docs3030 端口启动 docs 开发服务器
make docs_build构建生产版 docs
make docs_serve本地构建并启动 docs 预览

构建、版本与发布

命令作用
make build构建项目产物
make patch v=1.0.0b1更新根 VERSION 并同步版本消费者
make sync_version从根 VERSION 同步版本文件
make check_version_sync校验版本文件是否与根 VERSION 一致
make publish在发布流程就绪后执行发布

Help 入口

当你不确定该用哪个命令时,优先查看这些帮助入口:


_10
make help
_10
make help_backend
_10
make help_frontend
_10
make help_test
_10
make help_advanced

推荐工作流

全新本地初始化


_10
make init
_10
make init_db
_10
make backend
_10
make frontend

该工作流使用的是前端开发服务器。若你需要验证更接近正式发布形态的本地运行方式,请使用 make run_climake run_clic

接近正式发布形态的本地验证


_10
make init
_10
make init_db
_10
make run_cli

文档贡献循环


_10
make docs
_10
make docs_build

提交前验证


_10
make format
_10
make lint
_10
make unit_tests

相关文档