credo
Credo static code analysis for Elixir projects
Summary
ExDoc documentation validation plugin checks Elixir project documentation for issues before commits, ensuring that your code's documentation remains accurate and complete.
- It integrates with pre-commit hooks to catch missing docs, broken references, and formatting problems early in development.
Overview
[!NOTE]
This repository has changed significantly and may look quite different from before.
With the release of Claude Plugins, the previous implementation is now mostly irrelevant.
This new version adapts the earlier approach to align with the latest plugin architecture and conventions.
If you're looking for the previous version, please visit see version v0.5.3.
Claude Code Plugins for Elixir
Unofficial Claude Code plugin marketplace for Elixir and BEAM ecosystem development.
What is this?
This is a **Claude Code plugin marketplace** that provides Elixir and BEAM ecosystem development tools for Claude Code.
Quick Start
Install the Marketplace
claude
/plugin marketplace add bradleygolden/claude-marketplace-elixirInstall Plugin
# Recommended: Combined plugin with all features
/plugin install elixir@elixirAvailable Plugins
- •elixir - Recommended: Combined plugin with all Elixir development features (auto-formatting, compilation, testing, linting, security)
Legacy Plugins (Deprecated)
The following plugins are deprecated and will be removed in a future release. Use elixir@elixir instead.
- •core - Essential Elixir development support
- •ash - Ash Framework code generation validation
- •credo - Static code analysis
- •dialyzer - Static type analysis
- •ex_doc - Documentation quality validation
- •ex_unit - ExUnit testing automation
- •mix_audit - Dependency security audit
- •precommit - Phoenix 1.8+ precommit alias runner
- •sobelow - Security-focused static analysis
License
MIT License - see LICENSE for details.
Support
- •Issues: GitHub Issues
- •Discussions: GitHub Discussions
Made with ❤️ for the Elixir community
Install & Usage
/plugin marketplace add <org/repo>Add the configuration to /plugin install credo@<marketplace>
/pluginUse Cases
Usage Examples
/ex-doc validate --staged
Check documentation for all changed files before committing.
Run ex_doc validation on the entire project and report issues.
Security Audits
Frequently Asked Questions
What is credo?
ExDoc documentation validation plugin checks Elixir project documentation for issues before commits, ensuring that your code's documentation remains accurate and complete. It integrates with pre-commit hooks to catch missing docs, broken references, and formatting problems early in development.
How to install credo?
To install credo: add a marketplace (/plugin marketplace add <org/repo>), then add the config to /plugin install credo@<marketplace>. Finally, /plugin in Claude Code.
What is credo best for?
credo is a plugin categorized under Development. It is designed for: elixir, credo, linting, code-quality, static-analysis. Created by Bradley Golden.
What can I use credo for?
credo is useful for: Validate all public module and function documentation before committing new code.; Check for missing @doc annotations or incomplete documentation in Elixir projects.; Ensure cross-references in ExDoc documentation are valid and not broken.; Enforce documentation formatting standards as part of a pre-commit hook.; Automatically verify documentation coverage for new or modified functions.; Integrate documentation checks into CI pipelines for Elixir projects..