github.com/go-goxm/goxm@v0.4.4/README.md (about)

     1  GOXM: GO proXy Manager
     2  =====================
     3  
     4  The `go` command loads dependencies from the public proxy server (proxy.golang.org) or directly from the source version control system (VCS).
     5  
     6  The `goxm` tool is a wrapper around the standard `go` command that can load (and publish) dependencies from alternate repositories or services like AWS CodeArtifact. All arguments are passed to the `go` command, except `publish` which is handled by `goxm`.
     7  
     8  ## Installation
     9  
    10  Install the `goxm` command using the following command:
    11  
    12  ```bash
    13  go install github.com/go-goxm/goxm
    14  ```
    15  
    16  ## Configuration
    17  
    18  An exmaple `.goxm.json` is below:
    19  
    20  ```json
    21  {
    22      "repos": {
    23          "github.com/example/*": {
    24              "type": "CodeArtfact",
    25              "repository": "example_repo",
    26              "domain": "example_domain",
    27              "domain_owner": "111111111111"
    28          }
    29      }
    30  }
    31  ```
    32  
    33  ## Usage
    34  
    35  ### Publish module to an artifact repository:
    36  
    37  ```sh
    38  git checkout $version
    39  goxm publish $version
    40  ```
    41  where `$version` in the Git tag to publish
    42  
    43  NOTE: There is a known limitation requiring the version being published to be currently checked out.
    44  
    45  ### Download module from an artifact repository:
    46  
    47  ```sh
    48  goxm mod download
    49  ```
    50  
    51  or
    52  
    53  ```sh
    54  goxm build ./...
    55  ```