learn-codebase

Scans root-level configs and reports conventions and security concerns in codebases.

Updated Apr 4, 2026
One-click install
npx skills add https://github.com/peerasak-u/pi-config --skill learn-codebase-peerasak-u
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: learn-codebase
Source: https://github.com/peerasak-u/pi-config/tree/main/skills/learn-codebase
Command: npx skills add https://github.com/peerasak-u/pi-config --skill learn-codebase-peerasak-u

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Discover project conventions and surface security concerns when starting work in a new or unfamiliar project, scanning agent config files (.claude/, .cursor/, CLAUDE.md, etc.) and running a security/smell sweep for hardcoded secrets, insecure patterns, suspicious dependencies, and dangerous configurations.

Core Features & Use Cases

  • Scan root-level convention files and agent configs (CLAUDE.md, AGENTS.md, and directories such as .claude, .cursor, .pi, etc.), then summarize and surface conventions.
  • Read and summarize discovered conventions, with an option to register discovered skills in .pi/settings.json to extend the agent’s workspace.
  • Conduct a quick security/smell sweep to surface potential issues like hardcoded secrets, insecure patterns, suspicious dependencies, and dangerous configurations.

Quick Start

Run the learn-codebase skill at the project root to surface conventions and potential security concerns.

Frequently Asked Questions about learn-codebase

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

FAQPage Schema
How do I discover project conventions in a new codebase?▼

To discover project conventions, scan root-level instruction files and config directories like CLAUDE.md, AGENTS.md, .claude/, and .cursor/. Summarizing these configurations surfaces coding rules and project guidelines for onboarding.

How do I scan for hardcoded secrets and insecure patterns during onboarding?▼

Scanning for hardcoded secrets and insecure patterns requires a security and smell sweep across the codebase. This process surfaces suspicious dependencies, dangerous configurations, and potential vulnerabilities in a concise report.

What is the best way to surface security concerns in an unfamiliar project?▼

Surfacing security concerns in unfamiliar projects requires a quick security sweep targeting hardcoded secrets, insecure patterns, and suspicious dependencies. This identifies dangerous configurations before code modifications begin.

Can I register discovered agent skills in .pi/settings.json?▼

Yes, discovered skills can be registered in .pi/settings.json. When scanning agent config directories like .pi/skills, the tool summarizes conventions and registers discovered skills to extend the agent workspace.

Does the convention scan work with .cursor and .claude config directories?▼

Yes, the convention scan supports .cursor and .claude directories. It reads root-level agent configurations including CLAUDE.md, AGENTS.md, .claude/, and .cursor/ to summarize project rules and coding conventions.