aicommitter

One-Time Setup

1. Obtain your API Key
   Register and get an API key from the DeepSeek AI developer dashboard
   

   • Get DeepSeek API key from Deepseek Dashboard
   • Get Gemini API key from Gemini Dashboard

2. Set the Environment Variable
   Set your key as the DEEPSEEK_API_KEY environment variable
   

   export DEEPSEEK_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxx"
   

3. Verify the key is picked up
   Confirms a key is configured before you rely on it, and prints setup instructions if not
   

   aicommitter doctor
   

   It reports which keys are set, where each one came from, and which provider will be used. Add --live to ask the provider whether the key is actually accepted — a key can be present but expired or revoked, which otherwise only surfaces as an HTTP 401 at commit time:

   aicommitter doctor --live
   

   Exits non-zero when no usable key is found, so it can gate a setup script or CI step.

4. Install the Git Hook in your repository
   Navigate to the root of any Git project and run the install command
   

   aicommitter install
   

Daily Usage

For every commit after setup:

5. Stage your changes
   Add all or selected changes to the staging area
   

   git add .
   

6. Commit!
   Commit directly with confirmation
   

   aicommitter generate --commit
   

Building & Publishing

For maintainers cutting a release to PyPI.

Before you build, bump the version in all four places — they are not derived from each other: pyproject.toml, the release badge above, the Latest Release section, and a new CHANGELOG.md entry.

Requires the release toolchain: pip install --upgrade build twine

1. Clean stale artifacts Old builds in dist/ get picked up by twine upload dist/* and will publish the wrong version
   

   rm -rf dist/ build/ src/*.egg-info src/aicommitter/*.egg-info
   

2. Build the distributions Produces both an sdist and a wheel
   

   python -m build
   

3. Verify what was built Confirm only the new version is present, that resources/docs.md is bundled, and that the metadata is valid
   

   ls dist/
   python -m zipfile -l dist/aicommitter-*-py3-none-any.whl | grep docs.md
   twine check dist/*
   

   The docs.md check is not optional — it ships only via [tool.setuptools.package-data], and a missing copy is what broke aicommitter docs in 1.0.5.

4. Upload to TestPyPI first (recommended) PyPI versions are immutable, so each version number can only ever be uploaded once
   

   twine upload --repository testpypi dist/*
   pip install --index-url https://test.pypi.org/simple/ --no-deps aicommitter==<version>
   

5. Publish to PyPI Authenticate with __token__ as the username and a PyPI API token as the password
   

   twine upload dist/*
   

Create an API token at pypi.org/manage/account/token. To avoid re-entering it, store it in ~/.pypirc:

[pypi]
username = __token__
password = pypi-xxxxxxxxxxxx

error: externally-managed-environment
× This environment is externally managed

python3 -m venv .venv

.venv/bin/pip install --upgrade build twine

rm -rf dist/ build/ src/*.egg-info src/aicommitter/*.egg-info
.venv/bin/python -m build
.venv/bin/twine check dist/*
.venv/bin/twine upload dist/*

source .venv/bin/activate     # Windows: .venv\Scripts\activate
python -m build
twine check dist/*
twine upload dist/*
deactivate                    # when finished

.venv/bin/pip install dist/aicommitter-*-py3-none-any.whl
.venv/bin/aicommitter --version
.venv/bin/aicommitter docs

rm -rf .venv

Changelog

See CHANGELOG.md for a detailed history of changes. View on PyPI.

Latest Release

Version 1.3.0 (2026-09-28)

• Added aicommitter doctor to check API key configuration, with --live to verify the key against the provider

Version 1.2.0 (2026-09-28)

• Unified the Conventional Commit prompt across DeepSeek and Gemini
• Added an output sanitizer that strips markdown code fences and preambles
• Warn on stderr when a generated subject is not a Conventional Commit subject

Version 1.1.0 (2026-09-18)

• Removed the obsolete Gemini model; default is now gemini-2.5-flash-lite

Version 1.0.9 (2026-04-25)

• Add y flag to auto approve the commit message

Version 1.0.8 (2026-04-25)

• Fixed NotOpenSSLWarning by suppressing it before urllib3 is imported
• Added --version / -v flag to CLI

Version 1.0.7 (2026-04-25)

• Version bump

Version 1.0.6 (2026-01-25)

• Updated the version of aicommitter to 1.0.6
• Fixed the issue of NotOpenSSLWarning warning

Version 1.0.5 (2026-01-25)

• Updated the version of aicommitter to 1.0.5
• Fixed the issue of docs.md file not being found
• Fixed the timeout issue
• Swtiched to deepseek-chat model from deepseek-reasoner model

Version 1.0.4 (2025-12-07)

• Updated the version of aicommitter to 1.0.4
• Added support for long_description in pypi library

Version 1.0.4 (2025-12-07)

• Updated the version of aicommitter to 1.0.4
• Added support for long_description in pypi library

Version 1.0.3 (2025-12-05)

• Updated the version of aicommitter to 1.0.3
• Refactored exception handling
• Increased the session timeout to 180s for DEEPSEEK and GEMINI

For full details, see the CHANGELOG.

aicommitter generate -c -y        # generate, commit without confirmation
aicommitter generate -P -y        # generate, commit without confirmation, push to current branch
aicommitter generate --push       # generate, confirm commit, then push