onboarding-unknown-codebase

onboarding-unknown-codebase is a skill for Claude Code from Lion-1209/Lion-Skills. It costs 21 tokens per session (1,294 once invoked), scanned A, a copy of onboarding-unknown-codebase, MIT.

A method for quickly understanding an unfamiliar codebase, meaning a software project whose structure and behavior you do not yet know. It builds a project map by examining overview files, directories, and one main execution path.

In plain words
What is it for?
Use it when joining a new project, taking over someone else’s code, explaining an architecture, or tracing the main request or command flow.
Why use it?
It prevents getting lost in individual files before understanding what the project does, how it runs, and how its parts connect.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin.

Part of the lion-skills plugin — 13 skills shipped together

Good fit Use it when joining a new project, taking over someone else’s code, explaining an architecture, or tracing the main request or command flow.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/lion-1209/lion-skills/onboarding-unknown-codebase
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add Lion-1209/Lion-Skills --skill onboarding-unknown-codebase
Clone the repo
git clone --depth 1 https://github.com/Lion-1209/Lion-Skills

Made for: Claude Code.

Or install lion-skills, the plugin that ships this one along with the rest of its 13 skills.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for onboarding-unknown-codebase

README.md
[![agentmods](https://agentmods.dev/badge/skills/lion-1209/lion-skills/onboarding-unknown-codebase/github.svg)](https://agentmods.dev/skills/lion-1209/lion-skills/onboarding-unknown-codebase)
Your own site
<a href="https://agentmods.dev/skills/lion-1209/lion-skills/onboarding-unknown-codebase"><img src="https://agentmods.dev/badge/skills/lion-1209/lion-skills/onboarding-unknown-codebase/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for onboarding-unknown-codebase

Your own site · 80×15
<a href="https://agentmods.dev/skills/lion-1209/lion-skills/onboarding-unknown-codebase"><img src="https://agentmods.dev/badge/skills/lion-1209/lion-skills/onboarding-unknown-codebase.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 21 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,294 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin 86% copy Near-identical to another mod in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00021 $0.01294
Opus 5 $0.00010 $0.00647
Sonnet 5 $0.00004 $0.00259
Haiku 4.5 $0.00002 $0.00129

Measured 9d ago against content hash daf80e422a69, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

onboarding-unknown-codebase scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 9d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

This is a copy

86% identical to onboarding-unknown-codebase — 5 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

skills/onboarding-unknown-codebase/SKILL.md · 91 lines

How it starts

The opening of the file, as written. The whole thing — 91 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Onboarding Unknown Codebase

概述

用一套分层流程把陌生代码库变成一张"项目地图",而不是一头扎进某个文件读细节。核心:先建立全局心智模型,再按需深入。

何时使用

  • clone 了新项目,不知从哪读起
  • 接手别人的代码(同事离职、新入职)
  • 要给别人讲清楚一个项目
  • 想搞清某个项目的整体架构/数据流

不该用:只想找某个具体函数/bug(直接搜);项目你已经熟了。

核心内容

先确认对象(前置)

三遍法假设你已经拿到目标代码库。但用户常只说"帮我梳理这个项目""讲讲这个代码库"却没给路径——这是高频形态。开跑前先确认对象:

  • 有明确本地路径或 git 地址 → 直接进入三遍法
  • 没给 → 先向用户要:本地路径、git 地址、或至少 README.md + 包管理清单(package.json/go.mod 等)+ 顶层目录树(tree -L 2)。拿到这三样就能完成第一遍宏观 + 第二遍结构骨架
  • 不要默认当前工作目录就是目标,更不要凭空臆造一个项目来梳理——那会跑题

三遍法

第一遍·宏观(5-10 分钟,别读代码) 读"元信息"文件,搞清"这是什么、技术栈、怎么跑"(按项目实际有的读,没有的就跳过):

  • README.md —— 项目用途、怎么跑起来
  • 包管理清单:package.json / go.mod / Cargo.toml / requirements.txt —— 技术栈、依赖
  • Dockerfile / docker-compose.yml —— 怎么部署(库/CLI 项目通常没有)
  • CI 配置:.github/workflows/ —— 怎么构建测试
  • 配置:.env.exampleconfig/ —— 运行时配置

第二遍·结构(10-15 分钟) 看目录布局和分层,建立"地图骨架":

  • 顶层目录各自负责什么?(src/ 源码、tests/ 测试、docs/ 文档)
  • 分层模式:前后端分离?MVC?分层架构?
  • 入口在哪?(mainindexappserver;库/CLI 项目最快的方式是看 package.jsonbinexports 字段)
  • 模块之间怎么依赖(谁调用谁)

第三遍·主线(15-30 分钟) 从入口顺一条核心调用链读到底,不求全:

  • 入口启动后,处理一个典型请求/操作,经过哪些模块?
  • 只读主干,遇到分支先标记跳过
  • 这条链路走通,就理解了项目的"骨架动力"

不同项目类型的主线形态不同——别用同一把尺子:

类型 入口找法 主线追踪什么
服务型(web/api) server.listen / app.run / 路由表 一次请求的链路:HTTP 进来 → 中间件 → controller/handler → service → 数据层 → 响应
库 / SDK package.jsonexportsgo.mod 主包、__init__.py 暴露的符号 一次典型函数调用:公开 API 入口 → 内部参数校验 → 核心算法/数据变换 → 返回值组装
CLI bin 字段、main 函数、命令注册表 一次典型命令的执行:参数解析 → 子命令分发 → 业务逻辑 → 输出/副作用

库项目的常见坑是"没有明显的请求入口"——这时从**公开 API(exports/导出符号)**切入,挑一个最常用的函数,顺它的调用栈读到底,等价于服务型项目的"一次请求"。

产出:项目地图

给用户一份结构化地图(不是流水账):

## 这是什么        <一两句:项目用途>
## 技术栈          <语言、框架、关键依赖>
## 目录结构        <顶层目录职责 + 入口位置>
## 核心流程        <从入口出发的主调用链,逐步>
## 关键文件        <最重要的 3-5 个文件及职责>
## 怎么跑起来      <安装、配置、启动命令>

边界

  • 先地图后细节:别一上来读某个函数实现
  • 不求全:80/20,先懂主干
  • 产出要结构化:口头散讲不如一份地图

常见错误

问题 修法
一上来深挖某文件 先宏观再结构,最后才深入
不看配置就猜架构 第一遍先读 README 和包清单
只口头讲不产出 给用户一份结构化地图
试图读完所有文件 只读主干,标记跳过分支

Read the full file on GitHub · 91 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 9d ago First seen · 91 lines · 21 tokens per session scan A daf80e422a69

Subscribe to this mod's changes

onboarding-unknown-codebase is a skill published in the GitHub repository Lion-1209/Lion-Skills (5 stars, last pushed 2mo ago), licensed MIT. It adds 21 tokens to every session and 1,294 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. It is 86% identical to onboarding-unknown-codebase, differing in 5 lines, and is treated as a copy.

Related

Other skills, from other repositories

cosmosdb-datamodeling

Step-by-step guide for capturing key application requirements for NoSQL use-case and produce Azure Cosmos DB Data NoSQL Model design using best practices and common patterns, artifactsproduced: "cosmosdbrequirements.md" file and "cosmosdbdatamodel.md" file.

boshi-xixixi/TraeSkill · 62 tokens

geofeed-tuner

Use this skill whenever the user mentions IP geolocation feeds, RFC 8805, geofeeds, or wants help creating, tuning, validating, or publishing a self-published IP geolocation feed in CSV format. Intended user audience is a network operator, ISP, mobile carrier, cloud provider, hosting company, IXP, or satellite…

boshi-xixixi/TraeSkill · 136 tokens

arize-evaluator

INVOKE THIS SKILL for LLM-as-judge evaluation workflows on Arize: creating/updating evaluators, running evaluations on spans or experiments, tasks, trigger-run, column mapping, and continuous monitoring. Use when the user says: create an evaluator, LLM judge, hallucination/faithfulness/correctness/relevance, run eval…

boshi-xixixi/TraeSkill · 112 tokens

copilot-cli-quickstart

Use this skill when someone wants to learn GitHub Copilot CLI from scratch. Offers interactive step-by-step tutorials with separate Developer and Non-Developer tracks, plus on-demand Q&A. Just say "start tutorial" or ask a question! Note: This skill targets GitHub Copilot CLI specifically and uses CLI-specific tools…

boshi-xixixi/TraeSkill · 85 tokens

fireworks-tech-graph

A generator for technical diagrams that exports them as SVG and PNG images. It is intended for architecture, data-flow, flowchart, sequence, agent, memory, and concept-map diagrams.

boshi-xixixi/TraeSkill · 105 tokens

adobe-illustrator-scripting

Write, debug, and optimize Adobe Illustrator automation scripts using ExtendScript (JavaScript/JSX). Use when creating or modifying scripts that manipulate documents, layers, paths, text frames, colors, symbols, artboards, or any Illustrator DOM objects. Covers the complete JavaScript object model, coordinate system…

boshi-xixixi/TraeSkill · 80 tokens