elixir-code-review — Claude Code skill: what it does, how to install
elixir-code-review reviews Elixir files for OTP conventions, security caveats, and idiomatic style across .ex and .exs code.
Apache-2.0 124 installs ★ 89 updated 2026-09-15
npx skills add existential-birds/beagle --skill elixir-code-review -a claude-codeWhat elixir-code-review does
This skill supplies an inspection checklist tailored for Elixir codebases. It monitors function head destructuring, guard clauses, and error branches inside with statements. In concurrent code, it verifies that expensive initialization in GenServer offloads into handle_continue and flags synchronous calls where asynchronous casts belong.
Several accepted Elixir idioms are explicitly excluded from reporting. Single transformations via |> or missing @spec attributes on internal functions do not trigger alerts. The rules also spot risky functions like String.to_atom/1 and unvetted Code.eval_string/1 execution on outside payloads.
Every reported issue demands concrete anchors such as path:line identifiers. Substantive claims must include file search evidence before submitting findings.
What it helps with
- detect atom table exhaustion and unsanitized evaluation risks
- verify GenServer callbacks against blocking operations
- spot missing @moduledoc and @spec declarations on public functions
- refactor nested conditional branching into pattern matches
Example prompts for the agent
- Review
lib/account/supervisor.exusing the elixir-code-review checklist - Check
lib/parser.exfor pattern matching, guard usage, and doc coverage - Inspect
lib/server.exfor blocking calls in GenServer handlers
How to install elixir-code-review
1Skills CLI (Vercel)
npx skills add existential-birds/beagle --skill elixir-code-review -a claude-code2Manually: put the files in place
~/.claude/skills/elixir-code-review/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/elixir-code-review/
1Skills CLI (Vercel)
npx skills add existential-birds/beagle --skill elixir-code-review -a codex2Manually: put the files in place
.agents/skills/elixir-code-review/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add existential-birds/beagle --skill elixir-code-review -a cursor2Manually: put the files in place
.cursor/skills/elixir-code-review/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install existential-birds/beagle plugins/beagle-elixir/skills/elixir-code-review2Manually: put the files in place
.github/skills/elixir-code-review/SKILL.md1Skills CLI (Vercel)
npx skills add existential-birds/beagle --skill elixir-code-review -a gemini-cli2Platform CLI
gemini skills install https://github.com/existential-birds/beagle --path plugins/beagle-elixir/skills/elixir-code-reviewManually: put the files in place
.devin/skills/elixir-code-review/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add existential-birds/beagle --skill elixir-code-review -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about elixir-code-review
How to install elixir-code-review in Claude Code?
Run npx skills add existential-birds/beagle --skill elixir-code-review -a claude-code. The skill file lands in ~/.claude/skills/elixir-code-review/SKILL.md.
What does elixir-code-review do?
It equips the coding agent with guidelines to evaluate Elixir syntax, OTP lifecycle handling, doc coverage, and risky functions.
Which patterns does this skill deliberately ignore?
It preserves single-step pipe chains, empty function clauses used as guards, @doc false on behaviour callbacks, and private functions lacking type specs.
Source text
SKILL.md · Apache-2.0
--- name: elixir-code-review description: Reviews Elixir code for idiomatic patterns, OTP basics, and documentation. Use when reviewing .ex/.exs files, checking pattern matching, GenServer usage, or module documentation. --- # Elixir Code Review ## Quick Reference | Issue Type | Reference | |------------|-----------| | Naming, formatting, module structure | [references/code-style.md](references/code-style.md) | | With clauses, guards, destructuring | [references/pattern-matching.md](references/pattern-matching.md) | | GenServer, Supervisor, Application | [references/otp-basics.md](references/otp-basics.md) | | @moduledoc, @doc, @spec, doctests | [references/documentation.md](references/documentation.md) | ## Review Checklist ### Code Style - [ ] Module names are CamelCase, function names are snake_case - [ ] Pipe chains start with raw data, not function calls - [ ] Private functions grouped after public functions - [ ] No unnecessary parentheses in function calls without arguments ### Pattern Matching - [ ] Functions use pattern matching over conditionals where appropriate - [ ] With clauses have else handling for error cases - [ ] Guards used instead of runtime checks where possible - [ ] Destructuring used in function heads, not body ### OTP Basics - [ ] GenServers use handle_continue for expensive init work - [ ] Supervisors use appropriate restart strategies - [ ] No blocking calls in GenServer callbacks - [ ] Proper use of call vs cast (sync vs async) ### Documentation - [ ] All public functions have @doc and @spec - [ ] Modules have @moduledoc describing purpose - [ ] Doctests for pure functions where appropriate - [ ] No @doc false on genuinely public functions ### Security - [ ] No `String.to_atom/1` on user input (use `to_existing_atom/1`) - [ ] No `Code.eval_string/1` on untrusted input - [ ] No `:erlang.binary_to_term/1` without `:safe` option ## Valid Patterns (Do NOT Flag) - **Empty function clause for pattern match** - `def foo(nil), do: nil` is valid guard - **Using `|>` with single transformation** - Readability choice, not wrong - **`@doc false` on callback implementations** - Callbacks documented at behaviour level - **Private functions without @spec** - @spec optional for internals - **Using `Kernel.apply/3`** - Valid for dynamic dispatch with known module/function ## Context-Sensitive Rules | Issue | Flag ONLY IF | |-------|--------------| | Missing @spec | Function is public AND exported | | Generic rescue | Specific exception types available | | Nested case/cond | More than 2 levels deep | ## When to Load References - Reviewing module/function naming → code-style.md - Reviewing with/case/cond statements → pattern-matching.md - Reviewing GenServer/Supervisor code → otp-basics.md - Reviewing @doc/@moduledoc → documentation.md ## Gates — before reporting Do these **in order** for the review batch. Do not publish findings until each step passes. 1. **Protocol loaded** — Read [review-verification-protocol](../review-verification-protocol/SKILL.md) and apply its checks for each finding category you use (unused, validation, security, performance, etc.). **Pass:** For every substantive finding, you can name which protocol subsection you satisfied or state **N/A** with reason (pure style). 2. **Anchored evidence** — **Pass:** Each finding includes a concrete locator: `path:line` (or line range), or `Module.function/arity` plus a short quoted snippet from the file. 3. **Claims backed by artifacts** — For assertions like unused code, missing validation, or security risk, **Pass:** You attach the supporting artifact (e.g. search results, file read scope) or downgrade the item to an explicit **question** / **uncertain** with what you did not verify. ## Before Submitting Findings Complete **Gates — before reporting** (section above) first; the verification protocol is mandatory input to those gates.
© existential-birds · Apache-2.0 · existential-birds/beagle