github.com/buildtool/build-tools@v0.2.29-0.20240322150259-6a1d0a553c23/www/docs/installation.md (about)

     1  # Installation
     2  
     3  You can install the pre-compiled binary (in several different ways), use Docker or compile from source.
     4  
     5  ## Installation pre-built binaries
     6  **Homebrew tap**
     7  
     8  ```sh
     9  $ brew install buildtool/taps/build-tools
    10  ```
    11  
    12  **Shell script**
    13  ```sh
    14  $ curl -sfL https://raw.githubusercontent.com/buildtool/build-tools/main/install.sh | sh
    15  ```
    16  **Manually**
    17  
    18  Download the pre-compiled binaries from the [releases](https://github.com/buildtool/build-tools/releases) page and copy to the desired location.
    19  
    20  ## Running with Docker
    21  You can also use it within a Docker container. To do that, you’ll need to execute something more-or-less like the following:
    22  ```sh
    23  $ docker run --rm --privileged \
    24    -v $PWD:/repo \
    25    -v /var/run/docker.sock:/var/run/docker.sock \
    26    -w /repo \
    27    -e DOCKER_USERNAME \
    28    -e DOCKER_PASSWORD \
    29    buildtool/build-tools build
    30  ```
    31  
    32  ## Compiling from source
    33  
    34  Here you have two options:
    35  
    36  If you want to contribute to the project, please follow the
    37  steps on our [contributing guide](/contributing).
    38  
    39  If you just want to build from source for whatever reason, follow these steps:
    40  
    41  **Clone:**
    42  
    43  ```sh
    44  git clone https://github.com/buildtool/build-tools
    45  cd build-tools
    46  ```
    47  
    48  **Get the dependencies:**
    49  
    50  ```sh
    51  go get ./...
    52  ```
    53  
    54  **Build:**
    55  
    56  ```sh
    57  go build  ./cmd/build/build.go
    58  ```
    59  
    60  **Verify it works:**
    61  
    62  ```sh
    63  ./build --version
    64  ```