https://github.com/gembaadvantage/git-remote-codecommit
A git remote helper that removes the need for dedicated CodeCommit user credentials
https://github.com/gembaadvantage/git-remote-codecommit
aws cli clone codecommit git git-remote-helper go golang grc pull push
Last synced: 8 days ago
JSON representation
A git remote helper that removes the need for dedicated CodeCommit user credentials
- Host: GitHub
- URL: https://github.com/gembaadvantage/git-remote-codecommit
- Owner: gembaadvantage
- License: mit
- Created: 2021-09-06T08:43:27.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-20T14:14:30.000Z (over 1 year ago)
- Last Synced: 2024-06-21T03:15:01.462Z (over 1 year ago)
- Topics: aws, cli, clone, codecommit, git, git-remote-helper, go, golang, grc, pull, push
- Language: Go
- Homepage:
- Size: 131 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# git-remote-codecommit
A [git-remote-helper](https://git-scm.com/docs/gitremote-helpers) that supports basic push and pull functionality when working with CodeCommit repositories using the AWS `codecommit` protocol. When installed the helper acts as a transparent proxy, converting the `codecommit` protocol into AWS V4 authenticated HTTPS requests. Removing the need for dedicated AWS HTTPS credentials.
## Install
Binary downloads can be found on the [Releases](https://github.com/gembaadvantage/git-remote-codecommit/releases) page. Unpack the `git-remote-codecommit` binary and add it to your PATH.
### Homebrew
To use [Homebrew](https://brew.sh/):
```sh
brew tap gembaadvantage/tap
brew install gembaadvantage/tap/git-remote-codecommit
```
### GoFish
To use [Fish](https://gofi.sh/):
```sh
gofish rig add https://github.com/gembaadvantage/fish-food
gofish install github.com/gembaadvantage/fish-food/git-remote-codecommit
```
### Scoop
To use [Scoop](https://scoop.sh/):
```sh
scoop install git-remote-codecommit
```
### Script
To install using a shell script:
```sh
curl https://raw.githubusercontent.com/gembaadvantage/git-remote-codecommit/main/scripts/install | sh
```
## Quick Start
Clone the repository using your standard git syntax, but provide the clone URL using the `codecommit` protocol format of:
- `codecommit://repository`
- `codecommit://profile@repository`
- `codecommit::region://repository`
- `codecommit::region://profile@repository`
```sh
$ git clone codecommit::eu-west-1://repository
Cloning into 'repository'...
remote: Counting objects: 167, done.
Receiving objects: 100% (167/167), 96.07 KiB | 634.00 KiB/s, done.
Resolving deltas: 100% (31/31), done.
```
Both `git pull` and `git push` operations will behave as normal.
### AWS Named Profile
Depending on your chosen authentication mechanism, you may need to provide an AWS named profile to authenticate with CodeCommit. To do this, prefix your repository name with `profile@`.
```sh
git clone codecommit::eu-west-1://profile@repository
```