airダウンロード - airソースコードのダウンロード

air

その他のソースコード

v1.61.1

ダウンロード

☁️ Air - Go アプリのライブリロード

英語 | 简体中文 | 繁体中文

モチベーション

Go で Web サイトを開発し、gin フレームワークを使用し始めたとき、gin にライブリロード機能がないのは残念でした。それでいろいろ調べて新しく試してみましたが、あまり柔軟性がないようなので、より良く書き直すつもりでした。ついにAirが誕生しました。さらに、ピルにも感謝します。新鮮なものも空気もありません:)

Air は、Go アプリケーションを開発するためのもう 1 つのライブリロードコマンドラインユーティリティです。プロジェクトのルートディレクトリでair実行し、そのままにして、コードに集中します。

注: このツールは、本番環境へのホットデプロイとは何の関係もありません。

特徴

カラフルなログ出力
ビルドまたは任意のコマンドをカスタマイズする
サブディレクトリの除外をサポート
Air の開始後に新しいディレクトリの監視を許可する
より良い構築プロセス

引数から指定された構成を上書きする

air config フィールドを引数としてサポートします。

ビルドコマンドと実行コマンドを設定したい場合は、設定ファイルなしで次のコマンドのように使用できます。

air --build.cmd " go build -o bin/api cmd/run.go " --build.bin " ./bin/api "

リストを入力として受け取る引数の項目を区切るには、コンマを使用します。

air --build.cmd " go build -o bin/api cmd/run.go " --build.bin " ./bin/api " --build.exclude_dir " templates,build "

インストール

`go install`経由 (推奨)

go 1.23 以降の場合:

go install github.com/air-verse/air@latest

install.sh経由

 # binary will be $(go env GOPATH)/bin/air
curl -sSfL https://raw.githubusercontent.com/air-verse/air/master/install.sh | sh -s -- -b $( go env GOPATH ) /bin

# or install it into ./bin/
curl -sSfL https://raw.githubusercontent.com/air-verse/air/master/install.sh | sh -s

air -v

goblin.run経由

 # binary will be /usr/local/bin/air
curl -sSfL https://goblin.run/github.com/air-verse/air | sh

# to put to a custom path
curl -sSfL https://goblin.run/github.com/air-verse/air | PREFIX=/tmp sh

ドッカー/ポッドマン

この Docker イメージ cosmtrek/air をプルしてください。

docker/podman run -it --rm 
    -w " <PROJECT> " 
    -e " air_wd=<PROJECT> " 
    -v $( pwd ) : < PROJECT > 
    -p < PORT > : < APP SERVER PORT > 
    cosmtrek/air
    -c < CONF >

Docker/Podman .${SHELL}rc

通常のアプリのように air を継続的に使用したい場合は、${SHELL}rc で関数を作成できます (Bash、Zsh など)。

 air () {
  podman/docker run -it --rm 
    -w " $PWD " -v " $PWD " : " $PWD " 
    -p " $AIR_PORT " : " $AIR_PORT " 
    docker.io/cosmtrek/air " $@ "
}

<PROJECT>はコンテナ内のプロジェクトパスです。例: /go/example コンテナに入る場合は、--entrypoint=bash を追加してください。

例えば

私のプロジェクトの 1 つは Docker で実行されます。

docker run -it --rm 
  -w " /go/src/github.com/cosmtrek/hub " 
  -v $( pwd ) :/go/src/github.com/cosmtrek/hub 
  -p 9090:9090 
  cosmtrek/air

別の例:

 cd /go/src/github.com/cosmtrek/hub
AIR_PORT=8080 air -c " config.toml "

これにより、 $PWD現在のディレクトリに置き換えられます。 $AIR_PORTは公開先のポート、 $@はアプリケーション自体の引数 (例: -c) を受け入れることになります。

使用法

入力を減らすために、 alias air='~/.air' .bashrcまたは.zshrcに追加できます。

まずプロジェクトに入ります

 cd /path/to/your_project

最も単純な使用法が実行されます

 # firstly find `.air.toml` in current directory, if not found, use defaults
air -c .air.toml

次のコマンドを実行すると、 .air.toml構成ファイルをデフォルト設定で現在のディレクトリに初期化できます。

air init

この後は、追加の引数を指定せずにairコマンドを実行するだけで、構成に.air.tomlファイルが使用されます。

air

設定を変更するには、air_example.toml ファイルを参照してください。

実行時引数

air コマンドの後に引数を追加することで、ビルドされたバイナリを実行するための引数を渡すことができます。

 # Will run ./tmp/main bench
air bench

# Will run ./tmp/main server --port 8080
air server --port 8080

air コマンドに渡される引数とビルドされたバイナリを--引数で区切ることができます。

 # Will run ./tmp/main -h
air -- -h

# Will run air with custom config and pass -h argument to the built binary
air -c .air.toml -- -h

Docker Compose

 services :
  my-project-with-air :
    image : cosmtrek/air
    # working_dir value has to be the same of mapped volume
    working_dir : /project-package
    ports :
      - <any>:<any>
    environment :
      - ENV_A=${ENV_A}
      - ENV_B=${ENV_B}
      - ENV_C=${ENV_C}
    volumes :
      - ./project-relative-path/:/project-package/

デバッグ

air -dすべてのログを出力します。

air イメージを使用したくない Docker ユーザーのためのインストールと使用方法

Dockerfile

 # Choose whatever you want, version >= 1.16
FROM golang:1.23-alpine

WORKDIR /app

RUN go install github.com/air-verse/air@latest

COPY go.mod go.sum ./
RUN go mod download

CMD [ "air" , "-c" , ".air.toml" ]

docker-compose.yaml

 version : " 3.8 "
services :
  web :
    build :
      context : .
      # Correct the path to your Dockerfile
      dockerfile : Dockerfile
    ports :
      - 8080:3000
    # Important to bind/mount your codebase dir to /app dir for live reload
    volumes :
      - ./:/app

Q&A

「コマンドが見つかりません: air」または「そのようなファイルまたはディレクトリはありません」

 export GOPATH= $HOME /xxxxx
export PATH= $PATH : $GOROOT /bin: $GOPATH /bin
export PATH= $PATH : $( go env GOPATH ) /bin # Confirm this line in your .profile and make sure to source the .profile if you add it!!!

' がビンに含まれている場合、wsl でエラーが発生する

ビン内の `' をエスケープするにはを使用する必要があります。関連問題: #305

質問: 何も実行せずにホットコンパイルのみを実行するにはどうすればよいですか?

#365

[ build ]
  cmd = " /usr/bin/true "

静的ファイルの変更時にブラウザを自動的にリロードする方法

詳細については、問題 #512 を参照してください。

静的ファイルがinclude_dir 、 include_ext 、またはinclude_fileにあることを確認します。
HTML に</body>タグがあることを確認してください
次の構成を構成してプロキシをアクティブ化します。

[ proxy ]
  enabled = true
  proxy_port = < air proxy port>
  app_port = < your server port>

発達

依存関係を管理するためにgo mod使用しているため、Go 1.16 以降が必要であることに注意してください。

 # Fork this project

# Clone it
mkdir -p $GOPATH /src/github.com/cosmtrek
cd $GOPATH /src/github.com/cosmtrek
git clone [email protected]: < YOUR USERNAME > /air.git

# Install dependencies
cd air
make ci

# Explore it and happy hacking!
make install

プルリクエストは大歓迎です。

リリース

 # Checkout to master
git checkout master

# Add the version that needs to be released
git tag v1.xx.x

# Push to remote
git push origin v1.xx.x

# The CI will process and release a new version. Wait about 5 min, and you can fetch the latest version