phx-init
/phx-init
Initialize plugin in a project — install Iron Laws, auto-activation rules, and reference auto-loading into CLAUDE.md. Use when setting up or updating the plugin.
- Author
- oliver-kriska ↗
- Repository
- claude-elixir-phoenix ↗
- Licence
- MIT
- Last repository change
- 22.10.2026
Assessment and security
- Files in this package
- 3
- Scripts
- 0
- HTML comments
- 5
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 22.10.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
- SKILL.md zawiera komentarze HTML (5). Nie widać ich w podglądzie Markdown, a model je czyta.
What it does and when to use it
Initialize plugin in a project — install Iron Laws, auto-activation rules, and reference auto-loading into CLAUDE.md. Use when setting up or updating the plugin.
Original author description
Initialize plugin in a project — install Iron Laws, auto-activation rules, and reference auto-loading into CLAUDE.md. Use when setting up or updating the plugin.
How it works
- Usage
- Iron Laws
- Workflow
- Content Template
- Validation
- Error Handling
- Relationship to Other Commands
SKILL.md preview
---
name: phx-init
description: Initialize plugin in a project — install Iron Laws, auto-activation rules,
and reference auto-loading into CLAUDE.md. Use when setting up or updating the plugin.
---
# Plugin Initialization
Install the Elixir/Phoenix plugin's behavioral instructions into the project's CLAUDE.md.
## Usage
```
phx-init # First-time installation
phx-init --update # Update existing installation with latest rules
```
## Iron Laws
1. **NEVER overwrite content outside plugin markers** — User-written CLAUDE.md rules must be preserved verbatim
2. **Always detect stack before generating** — Never assume Phoenix/Ecto versions
3. **Always validate after installation** — Verify markers present and stack correct
## Workflow
### Step 1: Check Existing CLAUDE.md
Use Glob to check if `CLAUDE.md` exists. Then use Grep to check for existing `ELIXIR-PHOENIX-PLUGIN:START` marker in `CLAUDE.md`.
### Step 2: Detect Project Stack
Scan the project to customize the injected instructions:
Read `mix.exs` and use Grep to extract:
- Phoenix version: search for `phoenix.*"~>` in `mix.exs`
- Ecto version: search for `ecto.*"~>` in `mix.exs`
- Oban: search for `"oban"` and `"oban_pro"` in `mix.exs`
- Frameworks: search for `"ash"`, `"surface"` in `mix.exs`
- Tidewave: search for `"tidewave"` in `mix.exs`
- Project size: use Glob to count `lib/**/*.ex` files
### Step 3: Handle Installation Modes
**Mode A: Fresh Install** (no CLAUDE.md or no markers)
1. Create/append to CLAUDE.md
2. Insert full behavioral instructions between markers
3. Include only relevant sections based on detected stack
**Mode B: Update** (`--update` flag or markers exist)
1. Find content between `<!-- ELIXIR-PHOENIX-PLUGIN:START -->` and `<!-- ELIXIR-PHOENIX-PLUGIN:END -->`
2. Replace with latest behavioral instructions
3. Preserve everything outside the markers
In both modes, CLAUDE.md content outside the plugin markers — user-written rules, project conventions, other plugin sections — stays verbatim (Iron Law 1)
### Step 4: Generate Content
Write the following structure to CLAUDE.md:
```markdown
<!-- ELIXIR-PHOENIX-PLUGIN:START -->
<!-- Last updated: {date} | Plugin version: 1.0 | Stack: Phoenix {version}, Ecto {version}, {optional: Oban, Tidewave} -->
# Elixir/Phoenix Plugin - Auto-Activation Rules
{Include all sections from the Content Template below, filtered by detected stack}
<!-- ELIXIR-PHOENIX-PLUGIN:END -->
```
### Step 4b: Offer Codex Review Guidelines (optional)
If `command -v codex` succeeds (or the user asks): offer to install a
managed `## Review guidelines` block into the project's `AGENTS.md` —
honored by BOTH `codex exec review` locally and the Codex cloud PR
reviewer. Follow the install rules and exact block in
`references/codex-review-guidelines.md`: markers
`ELIXIR-PHOENIX-REVIEW-GUIDELINES:START/END`, upsert in place on
`--update`, never touch content outside markers, and STOP to ask if an
unmanaged `## Review guidelines` section already exists. When codex is
absent and not requested, skip silently — never mention codex to users
who don't have it.
### Step 5: Output Summary
```
✅ Elixir/Phoenix plugin initialized
Detected stack:
- Phoenix {version}
- Ecto {version}
- {Oban standard | Oban Pro | not detected}
- {Tidewave ✓ | Tidewave not detected}
- {Ash Framework detected - Ecto patterns disabled | not detected}
Added to CLAUDE.md:
- Auto-activation rules (complexity detection, interview mode)
- Agent trigger patterns ({n} agents available)
- Reference auto-loading ({n} reference docs)
- Iron Laws enforcement ({n} laws)
- Verification rules
{- Codex review guidelines → AGENTS.md (only if installed in Step 4b)}
Run phx-init --update after plugin updates.
Run phx-audit for a full project health check.
```
## Content Template
The exact content to inject is in `references/injectable-template.md`.
**Key structure:**
1. **Routing table** — which `phx-*` command fits which kind of request
2. **Iron Laws** — STOP behavior on violations
3. **Conditional Sections** — Include based on detected stack:
- `{OBAN_SECTION}` — If Oban detected (not Pro)
- `{OBAN_PRO_SECTION}` — If Oban Pro detected
- `{ASH_SECTION}` — If Ash Framework detected
- `{TIDEWAVE_SECTION}` — If Tidewave detected
4. **Verification** — Mandatory after code changes
5. **Quick Reference** — Skill routing table
**Placeholder substitution:**
| Placeholder | Source |
|-------------|--------|
| `{DATE}` | Current date |
| `{PHOENIX_VERSION}` | From mix.exs |
| `{ECTO_VERSION}` | From mix.exs |
| `{OPTIONAL_STACK}` | Detected optional deps |
See `references/injectable-template.md` for full template with all placeholders and conditional sections.
## Validation
After running `phx-init`:
1. Check CLAUDE.md contains markers
2. Verify detected stack matches actual project
3. New session should:
- Auto-detect complexity when given tasks
- Stop on Iron Law violations
- Offer relevant workflows based on task
## Error Handling
| Scenario | Action |
|----------|--------|
| CLAUDE.md read-only | Error: "Cannot modify CLAUDE.md - check permissions" |
| Markers corrupted | Warn, offer to remove and reinstall |
| Unknown Phoenix version | Use conservative defaults (all features enabled) |
| Not an Elixir project | Error: "No mix.exs found - is this an Elixir project?" |
## Relationship to Other Commands
| Command | When to Use |
|---------|-------------|
| `phx-init` | First time, or after plugin updates |
| `phx-audit` | Periodic project health check |
| `phx-verify` | After code changes |
Files in this package (3)
- SKILL.md 5 KB
- references/codex-review-guidelines.md 4 KB
- references/injectable-template.md 6 KB
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · oliver-kriska/claude-elixir-phoenix | 100 | MIT |
| oliver-kriska/claude-elixir-phoenix | 100 | MIT |
| oliver-kriska/claude-elixir-phoenix | 100 | MIT |
| oliver-kriska/claude-elixir-phoenix | 100 | MIT |
Database snapshot: 13.11.2026 · package version 2e95ce720847 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100init
Initialize plugin in a project — install Iron Laws, auto-activation rules, and reference auto-loading into CLAUDE.md. Use when setting up or updating the plugin. - 100phx-help
Recommend the right $elixir-phoenix:phx-* workflow. Use when choosing a plugin skill, not for Codex /help. - 100cc-spex-init
Install or refresh Spex specification-driven workflows in the current project from the Spex source bundled with the cc-spex plugin. Use when a Codex user asks to initialize Spex, configure Spex extensions or security, or update an existing Spex project through the cc-spex plugin. - 100sdlc-init
Codex-native initializer for Evo Talos. Use when the user asks for /sdlc-init, sdlc-init, initialize the SDLC kit, install the kit into the current project, or update the project's AGENTS.md from the plugin. Runs the plugin script, which auto-detects the active agent tool and… - 100init-project
Use this skill for \"initialize project\", \"set up project\", \"scaffold project\", \"create AGENTS.md\", \"create CLAUDE.md\", \"set up rules\", \"create context directory\", \"vibe rules\", \"project templates\", \"init new project\", \"set up development structure\",… - 100openspec-init
Initialize OpenSpec in a project. Use when: user says 'init openspec', 'setup openspec', or asks to add OpenSpec to a project.