cosmtrek/air

Air

概述

Air是一款Go应用开发专用的热重载命令行工具，旨在解决开发过程中需要频繁手动构建和重启应用的问题。当代码发生变更时，Air会自动检测并重新构建、运行应用，让开发者可专注于代码编写。注意：此工具仅用于开发环境，与生产环境的热部署无关。

核心功能

• 彩色日志输出：直观展示构建和运行状态，便于快速识别流程
• 自定义命令：支持自定义构建命令或二进制文件运行命令，满足个性化需求
• 目录排除：可配置排除不需要监控的子目录，减少不必要的重建
• 动态监控：允许在Air启动后监控新增目录，无需重启工具
• 优化构建流程：提供更高效的代码构建过程，提升开发体验

使用场景

适用于所有Go应用程序的开发过程，尤其适合：

• 使用Gin等缺乏内置热重载功能的框架开发Web应用
• 需要频繁修改代码并快速验证运行效果的场景
• 希望自动化构建和重启流程，减少手动操作的开发环境

Docker使用方法

拉取镜像

bash
docker pull cosmtrek/air

基本运行命令

bash
docker run -it --rm \
    -w "<PROJECT>" \          # 容器内工作目录，需与项目路径一致
    -e "air_wd=<PROJECT>" \   # Air工作目录环境变量，必须与-w参数一致
    -v $(pwd):<PROJECT> \     # 挂载本地项目目录到容器内<PROJECT>路径
    -p <PORT>:<APP_PORT> \    # 端口映射，将容器内应用端口映射到本地
    cosmtrek/air \            # 镜像名称
    -c <CONF>                 # 可选，指定配置文件路径（如.air.conf）

参数说明

示例：运行Go项目

假设本地项目路径为/path/to/your-go-project，应用监听端口9090，执行以下命令启动热重载：

bash
docker run -it --rm \
    -w "/go/src/your-go-project" \
    -v $(pwd):/go/src/your-go-project \
    -p 9090:9090 \
    cosmtrek/air

配置文件使用

1. 创建配置文件：在本地项目根目录创建.air.conf文件
2. 配置内容：从https://github.com/cosmtrek/air/blob/master/air.conf.example%E5%A4%8D%E5%88%B6%E5%9F%BA%E7%A1%80%E9%85%8D%E7%BD%AE%EF%BC%8C%E6%A0%B9%E6%8D%AE%E9%A1%B9%E7%9B%AE%E9%9C%80%E6%B1%82%E4%BF%AE%E6%94%B9%EF%BC%88%E5%A6%82%E8%87%AA%E5%AE%9A%E4%B9%89%E6%9E%84%E5%BB%BA%E5%91%BD%E4%BB%A4%E3%80%81%E6%8E%92%E9%99%A4%E7%9B%AE%E5%BD%95%E7%AD%89%EF%BC%89
3. 指定配置文件运行：

bash
docker run -it --rm \
    -w "/go/src/your-go-project" \
    -v $(pwd):/go/src/your-go-project \
    -p 9090:9090 \
    cosmtrek/air -c .air.conf

调试模式

如需查看详细运行日志，可添加-d参数启用调试模式：

bash
docker run -it --rm \
    -w "/go/src/your-go-project" \
    -v $(pwd):/go/src/your-go-project \
    -p 9090:9090 \
    cosmtrek/air -d

许可证

https://github.com/cosmtrek/air/blob/master/LICENSE