# commitlint

> Lint commit messages

helps your team adhere to a commit convention

## Table of Contents

### Guides

- [Getting started](/guides/getting-started.md)
- [Guide: Local setup](/guides/local-setup.md)
- [Guide: CI Setup](/guides/ci-setup.md)
- [Guide: Use prompt](/guides/use-prompt.md)
- [Guide: AI Agents](/guides/ai-agents.md)

### Reference

- [CLI](/reference/cli.md)
- [Configuration](/reference/configuration.md)
- [Rules configuration](/reference/rules-configuration.md)
- [Rules](/reference/rules.md)
- [Working with Plugins](/reference/plugins.md)
- [Prompt](/reference/prompt.md)
- [Examples](/reference/examples.md)
- [Projects from the community](/reference/community-projects.md)

### API

- [@commitlint/load](/api/load.md)
- [@commitlint/read](/api/read.md)
- [@commitlint/lint](/api/lint.md)
- [@commitlint/format](/api/format.md)

### Concepts

- [Concept: Commit conventions](/concepts/commit-conventions.md)
- [Concept: Shareable configuration](/concepts/shareable-config.md)

### Support

- [Troubleshooting](/support/troubleshooting.md)
- [Releases](/support/releases.md)
- [Upgrade Guides](/support/upgrade.md)

### Other

- [Attributions](/attributions.md)