Git Remote CodeCommit

1.17 · active · verified Sun Apr 12

git-remote-codecommit is a Git remote helper that simplifies interaction with AWS CodeCommit repositories by enabling a `codecommit://` URL prefix. It leverages existing AWS CLI credential profiles for authentication, supporting features like multiple AWS accounts and temporary credentials without caching them in the operating system's credential store. This tool is the recommended approach for connecting to CodeCommit with federated access or IAM roles. The current version is 1.17, with irregular but ongoing releases indicating active maintenance.

Warnings

gotcha This is a Git remote helper, not a Python library for direct `import`. It extends Git's capabilities rather than providing Python APIs for programmatic interaction.
Fix: Use it via Git commands (`git clone codecommit://...`), not Python `import` statements.
breaking AWS CLI `v2.9.x` introduced new `~/.aws/config` file formats that `git-remote-codecommit` might fail to recognize, leading to authentication issues.
Fix: Check the official GitHub issues for workarounds or ensure you are on the latest compatible version of `git-remote-codecommit` and AWS CLI. Consider using a virtual environment for isolated installations.
gotcha Many IDEs (Integrated Development Environments) may not fully support Git remote helpers like `git-remote-codecommit` for cloning, pushing, or pulling. This can result in 'invalid URL' or connection errors within the IDE.
Fix: Perform clone, push, and pull operations for CodeCommit repositories via the command line, then open the local repository in your IDE.
gotcha Encountering 'fatal: Unable to find remote helper for 'codecommit'' indicates that the `git-remote-codecommit` executable is not correctly installed or not in your system's PATH.
Fix: Ensure `pip install git-remote-codecommit` completed successfully. Verify that Python and the `git-remote-codecommit` executable's location are included in your system's PATH environment variable. Restart your terminal or command prompt after installation.
gotcha If `pip install git-remote-codecommit` fails with an 'externally managed environment' error, it's typically because you're trying to install into a system-managed Python installation.
Fix: Create and activate a Python virtual environment (`python -m venv .venv && source .venv/bin/activate`) before running `pip install git-remote-codecommit`.
gotcha Authentication errors (e.g., 403 Forbidden) often stem from misconfigured or expired AWS CLI credentials, or a mismatch between the configured AWS region and the CodeCommit repository's region.
Fix: Run `aws configure` to verify and update your AWS CLI profile. Ensure the AWS region specified in your `codecommit://` URL (or implied by your profile) matches the repository's region. Check for expired temporary credentials if using SSO or roles.

Install

pip install git-remote-codecommit Install with pip (Python environments)
brew install git-remote-codecommit Install on macOS with Homebrew

Imports

N/A
```
This is a Git remote helper, not a Python library designed for direct import into Python code.
```
git-remote-codecommit installs an executable that Git invokes internally. It does not expose Python modules for direct programmatic use.

Quickstart

The quickstart demonstrates installing `git-remote-codecommit`, configuring an AWS CLI profile (which `git-remote-codecommit` relies on for authentication), and then cloning a CodeCommit repository using the special `codecommit://` URL format. Subsequent Git operations (pull, push, commit) then work seamlessly.

# 1. Ensure AWS CLI is installed and configured (e.g., 'aws configure')
# For specific profiles:
aws configure --profile my-codecommit-profile

# 2. Clone a CodeCommit repository using the 'codecommit://' protocol
# Syntax: git clone codecommit::[region]://[profile@]repository-name

# Example with default profile (configured in ~/.aws/credentials)
git clone codecommit://MyDemoRepo

# Example with a named profile and specific region
git clone codecommit::us-east-1://my-codecommit-profile@MyAnotherRepo

# After cloning, standard git pull/push commands work as usual
cd MyDemoRepo
git pull origin main
echo "Hello from CodeCommit!" > README.md
git add README.md
git commit -m "Add README"
git push origin main

view raw JSON →