github.com/chenbh/concourse/v6@v6.4.2/fly/README.md (about)

     1  # fly
     2  
     3  A command line interface that runs a build in a container with [ATC](https://github.com/concourse/atc).
     4  
     5  [The documentation](https://concourse-ci.org/fly.html) is hosted together with Concourse's docs.
     6  
     7  A good place to start learning about Concourse is [its documentation](https://concourse-ci.org/index.html)
     8  or its [BOSH release](https://github.com/concourse/concourse).
     9  
    10  ## Reporting Issues and Requesting Features
    11  
    12  Please report all issues and feature requests in [concourse/concourse](https://github.com/concourse/concourse/issues).
    13  
    14  ## Building
    15  
    16  Fly is built using [Go](http://golang.org/). Building and testing fly is most easily done from a checkout of [concourse](https://github.com/concourse/concourse).
    17  
    18  1. Check out concourse and update submodules:
    19  
    20    ```bash
    21    git clone --recursive https://github.com/concourse/concourse.git
    22    cd concourse
    23    ```
    24  
    25  2. You can now build the fly binary with go build:
    26  
    27    ```bash
    28    cd fly
    29    go build
    30    ```
    31  
    32    If you are using Go 1.10 and below, run `go get ./...` before `go build`.
    33  
    34  3. You can also now run tests by installing and running [ginkgo](http://onsi.github.io/ginkgo/):
    35  
    36    ```bash
    37    go get github.com/onsi/ginkgo/ginkgo
    38    ginkgo -r
    39    ```
    40  
    41  ## Installing from the Concourse UI for Project Development
    42  
    43  Fly is available for download in the lower right-hand corner of the concourse UI.
    44  
    45  ![fly download links](images/fly_download_ui.png)
    46  
    47  1. Navigate to your Concourse instance in the browser, and click the button corresponding to your OS
    48  
    49  1. Move the downloaded file onto your PATH
    50  
    51    ```bash
    52    install ~/Downloads/fly /usr/local/bin
    53    ```
    54  
    55  1. Confirm availability with `which fly`
    56  
    57  ## Upgrading Fly
    58  Fly is not available for upgrade independently of Concourse. You can download the corresponding upgraded version of Fly via the following: 
    59  * using the [Concourse UI](#installing-from-the-concourse-ui-for-project-development) 
    60  * running `fly -t example sync` if you already have fly locally
    61