github.com/shahidhk/glide@v0.13.2-0.20171214012703-3e13fd16ed5b/docs/getting-started.md (about)

     1  # Getting Started With Glide
     2  
     3  This is a quick start guide to using Glide once you have it installed.
     4  
     5  ## Initially Detecting Project Dependencies
     6  
     7  Glide can detect the dependencies in use on a project and create an initial `glide.yaml` file for you. This detection can import the configuration from Godep, GPM, Gom, and GB. To do this change into the top level directory for the project and run:
     8  
     9      $ glide init
    10  
    11  When this is complete you'll have a `glide.yaml` file populated with the projects being used. You can open up this file and even edit it to add information such as versions.
    12  
    13  Running `glide init` will also ask if you would like to use a wizard to discover information about your dependencies versions and use versions or ranges. Each decision is interactive and your choice.
    14  
    15  ## Updating Dependencies
    16  
    17  To fetch the dependencies and set them to any versions specified in the `glide.yaml` file use the following command:
    18  
    19      $ glide up
    20  
    21  The `up` is short for `update`. This will fetch any dependencies specified in the `glide.yaml` file, walk the dependency tree to make sure any dependencies of the dependencies are fetched, and set them to the proper version. While walking the tree it will make sure versions are set and configuration from Godep, GPM, Gom, and GB is imported.
    22  
    23  The fetched dependencies are all placed in the `vendor/` folder at the root of the project. The `go` toolchain will use the dependencies here prior to looking in the `GOPATH` or `GOROOT` if you are using Go 1.6+ or Go 1.5 with the Go 1.5 Vendor Experiment enabled.
    24  
    25  Glide will then create a `glide.lock` file. This file contains the entire dependency tree pinned to specific commit ids. This file, as we'll see in a moment, can be used to recreate the exact dependency tree and versions used.
    26  
    27  If you want to remove nested `vendor/` directories from within dependencies use the `--strip-vendor` or `-v` flag.
    28  
    29  ### Dependency Flattening
    30  
    31  All of the dependencies Glide fetches are into the top level `vendor/` folder for a project. Go provides the ability for each package to have a `vendor/` folder. Glide only uses a top level folder for two reasons:
    32  
    33  1. Each import location will be compiled into the binary. If the same dependency is imported into three `vendor/` folders it will be in the compiled binary three times. This can quickly lead to binary bloat.
    34  2. Instances of types created in a dependency in one `vendor/` folder are not compatible with the same dependency in other locations. Even if they are the same version. Go sees them as different packages because they are in different locations. This is a problem for database drivers, loggers, and many other things. If you [try to pass an instance created from one location of a package to another you'll encounter errors](https://github.com/mattfarina/golang-broken-vendor).
    35  
    36  If a dependency has a `vendor/` directory of its own Glide does not remove it by default. The resolution in the `go` toolchain will use these nested versions if they are present. To remove them use the `--strip-vendor` or `-v` flag on the `up` or `install` commands.
    37  
    38  ## Installing Dependencies
    39  
    40  If you want to install the dependencies needed by a project use the `install` command like so:
    41  
    42      $ glide install
    43  
    44  This command does one of two things:
    45  
    46  * If a `glide.lock` file is present it retrieves, if missing from the `vendor/` folder, the dependency and sets it to the exact version in the `glide.lock` file. The dependencies are fetched and versions set concurrently so this operation is fairly quick.
    47  * If there is no `glide.lock` file then an `update` will be performed.
    48  
    49  If you're not managing the dependency versions for a project but need to install the dependencies you should use the `install` command.
    50  
    51  ## Adding More Dependencies
    52  
    53  Glide can help you add more dependencies to the `glide.yaml` file with the `get` command.
    54  
    55      $ glide get github.com/Masterminds/semver
    56  
    57  The `get` command is similar to `go get` but instead fetches dependencies into the `vendor/` folder and adds them to the `glide.yaml` file. This command can take one or more dependencies to fetch.
    58  
    59  The `get` command can also work with versions.
    60  
    61      $ glide get github.com/Masterminds/semver#~1.2.0
    62  
    63  The `#` is used as a separator between the dependency name and a version to use. The version can be a semantic version, version range, branch, tag, or commit id.
    64  
    65  If no version or range is specified and the dependency uses Semantic Versions Glide will prompt you to ask if you want to use them.