Install & Compatibility
Where this runs
tested against v1.17 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.000s · 50.6MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 3.8s · import 0.000s · 51MB
48MB installed
● package 48MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
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.
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
git-remote-codecommit --version
Debug
Known issues
gotchaThis 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.fixUse it via Git commands (`git clone codecommit://...`), not Python `import` statements.
affects: All versions
breakingAWS CLI `v2.9.x` introduced new `~/.aws/config` file formats that `git-remote-codecommit` might fail to recognize, leading to authentication issues.fixCheck 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.
affects: Potentially older versions of `git-remote-codecommit` with AWS CLI v2.9.x and newer.
gotchaMany 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.fixPerform clone, push, and pull operations for CodeCommit repositories via the command line, then open the local repository in your IDE.
affects: All versions
gotchaEncountering '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.fixEnsure `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.
affects: All versions
gotchaIf `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.fixCreate and activate a Python virtual environment (`python -m venv .venv && source .venv/bin/activate`) before running `pip install git-remote-codecommit`.
affects: Python versions with PEP 668 implementation
gotchaAuthentication 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.fixRun `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.
affects: All versions
Upgrade
Version history
1.17latest on PyPI · released Aug 25, 2023
Audit
Dependencies
PythonrequiredRequired to run the remote helper (versions 3.8.x, 3.9.x, 3.10.x, 3.11.x are supported).
GitrequiredThe underlying version control system that utilizes this remote helper.
AWS CLIrequiredRequired for credential management and authentication with AWS CodeCommit. The latest version is recommended.