onboard · justxor — Claude Code skill: project tour and installation
The onboard skill gives a new developer a guided introduction to a codebase, from its layout to its main workflows. Use it when someone needs to get oriented and find a first task.
MIT ★ 353 updated 2026-10-01
npx skills add justxor/claude-code-pro-course --skill onboard -a claude-codeWhat onboard does
onboard builds a concise project guide. It describes the product, maps key directories, and checks CLAUDE.md, package.json, or Makefile for setup, development, and test instructions when those files are present.
The skill traces two or three core workflows through the relevant files, calls out conventions that are easy to miss, and suggests three starter tasks in increasing difficulty. It also uses git log to identify active contributors by area, taking names from the history. Its response should link to code as file:line. Available tools are limited to reading and searching files, plus specific git log and ls commands.
What it helps with
- Understand an unfamiliar project
- Locate its key directories and files
- Find the development and test commands
- Trace core workflows through the code
- Choose a first task for a new contributor
Example prompts for the agent
- Give me a tour of this codebase: explain its structure, startup steps, and main workflows.
- Help me get oriented in this project and suggest three starter tasks.
- Show me the tricky conventions and who works on each area.
How to install onboard
1Skills CLI (Vercel)
npx skills add justxor/claude-code-pro-course --skill onboard -a claude-code2Manually: put the files in place
~/.claude/skills/onboard/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/onboard/
1Skills CLI (Vercel)
npx skills add justxor/claude-code-pro-course --skill onboard -a codex2Manually: put the files in place
.agents/skills/onboard/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add justxor/claude-code-pro-course --skill onboard -a cursor2Manually: put the files in place
.cursor/skills/onboard/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install justxor/claude-code-pro-course starter-kit/.claude/skills/onboard2Manually: put the files in place
.github/skills/onboard/SKILL.md1Skills CLI (Vercel)
npx skills add justxor/claude-code-pro-course --skill onboard -a gemini-cli2Platform CLI
gemini skills install https://github.com/justxor/claude-code-pro-course --path starter-kit/.claude/skills/onboardManually: put the files in place
.devin/skills/onboard/SKILL.mdThe legacy .windsurf/skills/ path still works
Claude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about onboard
How do I install onboard in Claude Code?
Run npx skills add justxor/claude-code-pro-course --skill onboard -a claude-code. The skill file is at ~/.claude/skills/onboard/SKILL.md.
What does onboard do?
It creates a short guide to a project's structure, setup, and main workflows, then suggests starter tasks for learning the codebase.
How does onboard identify active contributors?
It checks git log and groups contributors by area, using names found in the repository history.
Source text
SKILL.md · MIT
--- name: onboard description: Проводит онбординг нового разработчика в проект - обзор архитектуры, запуск, ключевые потоки и первая задача. Используй, когда просят объяснить проект, ввести в курс дела или помочь новичку. allowed-tools: Read, Grep, Glob, Bash(git log:*), Bash(ls:*) --- # Onboarding Цель — за 10 минут дать человеку рабочую ментальную модель проекта. 1. **Одним абзацем:** что это за продукт и для кого. 2. **Карта:** дерево ключевых директорий (до 15 строк) с пояснением каждой. 3. **Запуск:** установка, dev, тесты, один тест — проверь по CLAUDE.md/package.json/Makefile. 4. **Главные потоки:** 2–3 ключевых сценария (например, «запрос → ответ», «фоновая задача») — путь по файлам. 5. **Грабли:** неочевидные места, соглашения, то, что легко сломать. 6. **Кто что знает:** по `git log` — самые активные авторы по областям (только имена из истории). 7. **Первая задача:** предложи 3 небольшие задачи для знакомства (good first issue), от простой к сложной. Пиши кратко, со ссылками `файл:строка`. В конце спроси, какую часть разобрать подробнее.
© justxor · MIT · justxor/claude-code-pro-course
Similar skills
All skills for Writing and docs →onboard by other authors comes first.