explain

Name: explain
Availability: InStock
Author: fallguyconsulting

Displays canonical definitions and examples for Plumbline lint concepts via the vendored plumbline binary.

1|Updated Jul 21, 2026

Search Tags:#documentation #citations #lint #explain #comment hygiene #plumbline #check codes

Ready to run

npx skills add https://github.com/fallguyconsulting/ok-plugins --skill explain-fallguyconsulting

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: explain
Source: https://github.com/fallguyconsulting/ok-plugins/tree/main/plugins/ok/families/ok-plumbline/skills/explain
Command: npx skills add https://github.com/fallguyconsulting/ok-plugins --skill explain-fallguyconsulting

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? When a Plumbline lint check flags your code with an unfamiliar check code or config term, you need the authoritative definition and examples without digging through source files or outdated documentation. ## Core Features & Use Cases - Concept Lookup: Shows the canonical definition and examples for any Plumbline concept, including check codes like comment-hygiene, citation-unresolved, and no-tests. - Config Reference: Explains the citations configuration and the @plumbline:allow-docstrings opt-in marker. - Project-Aligned Output: Prefers the project's vendored plumbline binary so explanations match the exact rules the project lints against, falling back to the plugin payload copy with a warning. - Use Case: A lint run reports a citation-unresolved violation; run /ok-plumbline:explain citation-unresolved to see what the check means and how to fix it. ## Quick Start Ask the assistant to run /ok-plumbline:explain with a topic such as comment-hygiene to see its canonical definition and examples.

Frequently Asked Questions about explain

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I look up what a Plumbline check code means?▼

Run /ok-plumbline:explain followed by the check code, such as /ok-plumbline:explain citation-unresolved. The skill runs the plumbline binary's explain command and surfaces the canonical definition and examples directly.

What topics can the Plumbline explain command cover?▼

It covers check codes like comment-hygiene, citation-unresolved, and no-tests, plus the citations configuration and the @plumbline:allow-docstrings opt-in marker. Running it with no argument lists all available topics.

Does the explain output match my project's lint rules?▼

Yes, when possible. The skill prefers the project's vendored binary at .ok-plumbline/bin/plumbline so explanations match the rules the project actually lints against. If none exists, it falls back to the plugin payload copy and prints a note.

Why does the explain command print a note about the vendored binary?▼

The note appears when no vendored binary exists at .ok-plumbline/bin/plumbline, meaning the explanation comes from the plugin payload copy instead. Running /ok pins a vendored binary to the project to resolve this.

Can the explain skill trigger automatically during conversation?▼

No. It is only activated by the explicit /ok-plumbline:explain slash command and never auto-triggers based on conversation content, per its frontmatter description.