pilinux/gorest · Archived

explain-code

Produce concise, citation-backed explanations of module behavior, data flow, and important types/APIs.

First seen Mar 2, 2026

Installation

$ npx skills add pilinux/gorest --skill explain-code

Stronger alternatives

This repository is archived — consider an actively maintained alternative.

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from pilinux/gorest · top by installs.

npx skills add pilinux/gorest

Browse all from pilinux/gorest

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 502
License LICENSE
Default branch main
Open issues 0
Status Archived

Skill metadata

Parsed from SKILL.md frontmatter.

LicenseMIT
More metadata
mode
read-only
purpose
explanation

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 973 B
  • docs SUMMARY.md 122 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 2 installs

SKILL.md

Explain Code

When to Use

  • The user asks "how does X work?" or needs a human-readable overview tied to exact code locations.

Rules

  • Read-only and source-cited: every non-trivial claim must include path:line.
  • Keep summaries short and pragmatic. Focus on inputs/outputs, side effects, and error handling.

Output

  • What it does: 1-4 sentences.
  • How it works: 3-6 bullets with path:line citations for key statements.
  • Key types/APIs: short list with path:line.
  • Edge cases / invariants: 1-3 bullets.

Examples

  • "Explain handler.Login behavior and where passwords are hashed."
  • "How does the JWT blacklist work end-to-end?"

Related Skills

  • file-reader (low-level excerpts), code-navigation (impact mapping)