> ## Documentation Index
> Fetch the complete documentation index at: https://lunr-f6858e75.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# HelixCommit

> Turn Git history into polished, publish-ready release notes

<Note>
  **HelixCommit** transforms your Git commit history into professional release notes automatically. It understands Conventional Commits, enriches entries with GitHub pull requests, and can generate AI-powered summaries.
</Note>

## Get started in seconds

<Steps>
  <Step title="Install HelixCommit" icon="download">
    ```bash theme={}
    pip install helixcommit
    ```
  </Step>

  <Step title="Generate release notes" icon="play">
    ```bash theme={}
    helixcommit generate --unreleased --format markdown
    ```
  </Step>
</Steps>

<Check>
  Works completely offline with no GitHub API calls or external dependencies required.
</Check>

***

## Explore the documentation

<CardGroup cols={2}>
  <Card title="Quick start" icon="bolt" href="/quickstart" color="#F26419">
    Generate your first release notes in under 5 minutes
  </Card>

  <Card title="Installation" icon="download" href="/installation" color="#0A6ACB">
    Install HelixCommit using pip or from source
  </Card>

  <Card title="CLI reference" icon="terminal" href="/cli-reference" color="#0A6ACB">
    Complete guide to all CLI commands and options
  </Card>

  <Card title="Python API" icon="code" href="/api-reference/python-api" color="#F6A02D">
    Integrate HelixCommit programmatically in your Python projects
  </Card>

  <Card title="Community" icon="discord" href="/community" color="#5865F2">
    Join our Discord server and connect with other users
  </Card>
</CardGroup>

***

## Key features

<CardGroup cols={3}>
  <Card title="Automated changelog" icon="list-check" color="#0A6ACB">
    Build structured release notes from commits and tags automatically.
  </Card>

  <Card title="AI summaries" icon="sparkles" color="#F26419">
    Generate intelligent, context-aware summaries with OpenAI or OpenRouter.
  </Card>

  <Card title="Conventional Commits" icon="code-branch" color="#F6A02D">
    Automatically detects commit types, scopes, and breaking changes.
  </Card>

  <Card title="GitHub enrichment" icon="github" color="#0A6ACB">
    Resolves pull requests and links for richer context.
  </Card>

  <Card title="Multiple formats" icon="file-export" color="#F26419">
    Export as Markdown, HTML, or plain text.
  </Card>

  <Card title="Fast & resilient" icon="bolt" color="#F6A02D">
    Uses GitPython with automatic CLI fallback.
  </Card>
</CardGroup>

***

## Common use cases

<AccordionGroup>
  <Accordion title="Generate release notes between two tags" icon="tags">
    ```bash theme={}
    helixcommit generate \
      --since-tag v1.2.0 \
      --until-tag v1.2.1 \
      --format markdown \
      --out release-v1.2.1.md
    ```

    Perfect for creating release notes when cutting a new version.
  </Accordion>

  <Accordion title="Create release notes for unreleased changes" icon="clock">
    ```bash theme={}
    helixcommit generate \
      --unreleased \
      --format html \
      --out preview.html
    ```

    Preview what's changed since your last release before tagging.
  </Accordion>

  <Accordion title="Generate AI-enhanced summaries" icon="wand-magic-sparkles">
    ```bash theme={}
    export OPENAI_API_KEY=sk-...

    helixcommit generate \
      --unreleased \
      --use-llm \
      --openai-model gpt-4o-mini \
      --format markdown
    ```

    Let AI summarize your changes with intelligent, context-aware descriptions.
  </Accordion>

  <Accordion title="Integrate with CI/CD pipelines" icon="rotate">
    ```yaml theme={}
    - name: Generate release notes
      run: |
        pip install helixcommit
        helixcommit generate \
          --since-tag ${{ github.event.release.target_commitish }} \
          --until-tag ${{ github.event.release.tag_name }} \
          --format markdown \
          --out RELEASE_NOTES.md
    ```

    Automate release note generation in your GitHub Actions workflows.
  </Accordion>
</AccordionGroup>

***

## Next steps

<CardGroup cols={2}>
  <Card title="Follow the quickstart" icon="play" href="/quickstart" color="#F26419">
    Generate your first release notes and explore the basic features
  </Card>

  <Card title="Explore examples" icon="lightbulb" href="/examples" color="#0A6ACB">
    See real-world examples and common usage patterns
  </Card>

  <Card title="Configure for your workflow" icon="gear" href="/configuration" color="#F6A02D">
    Customize HelixCommit to match your team's needs
  </Card>

  <Card title="GitHub integration" icon="github" href="/github-integration" color="#F26419">
    Enrich release notes with PR data and links
  </Card>
</CardGroup>