Skip to main content
skill CX Codex

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

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add justxor/claude-code-pro-course --skill onboard -a claude-code
Open on GitHub

What 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-code

2Manually: put the files in place

~/.claude/skills/onboard/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/onboard/

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.

onboard Donchitos Builds an onboarding document for a contributor or agent, covering project state, conventions, structure, and first tasks for a selected role. CX Codex +1 652installs onboard Alireza Rezvani onboard is a Claude Code skill that interviews founders with 12 questions and fills ~/.claude/company-context.md with business facts for virtual executive agents. CX Codex +1 361installs onboard parcadei onboard reads an unfamiliar repository and writes a starting ledger, so the agent knows the layout from the first session. CX Codex +1 489installs onboard aladicf onboard designs a product's first run: what a new user sees, in what order, and how they reach their first win. CX Codex +1 587installs understand-onboard Egonex-AI Turns a project's knowledge graph into an onboarding guide. You run it as /understand-onboard after the graph has been built. CX Codex +1 4,400installs openspec-onboard openspec This Claude Code skill guides a first OpenSpec cycle, from choosing a task to archiving a change. It starts when someone asks for “openspec onboard” or “opsx onboard”. CX Codex +1 4,400installs gsd-onboard open-gsd The gsd-onboard Claude Code skill maps an existing codebase, brings in project docs, and sets up GSD planning. It ends with an onboarding summary and a next command. CX Codex +1 550installs groove-utilities-onboard andreadellacorte groove-utilities-onboard writes a GROOVE.md at the project root so a new contributor knows which commands to run and where logs live. Handy when someone joins a groove project. CX Codex +1 506installs smb-onboard official anthropics smb-onboard onboards small business owners by connecting their first two tools, running a recipe on live data, capturing business context, and setting up weekly check-ins. CX Codex +1 1,700installs w-onboard blockmatic-icebox The w-onboard Claude Code skill takes a developer from cloning a repository to a running local app. It follows project setup instructions and checks that the app can reach its API. CX Codex +1 647installs

From the same set15

The whole set →
pr-description pr-description generates clear pull request titles and descriptions by inspecting branch commits and diffs against main. CX Codex +1 ★ 353repo stars architect The architect subagent examines a project before implementation, compares design options, and lays out a change plan. Use it to scope a feature or a major refactor. CX Codex ★ 353repo stars code-reviewer code-reviewer reads your diff, flags security holes, missing tests and edge cases, then returns a severity-sorted report with a file and line for each fix. CX Codex ★ 353repo stars write-tests write-tests generates unit tests for a chosen file or function while matching existing project patterns. It runs new checks and flags discovered bugs instead of bending assertions. CX Codex +1 ★ 353repo stars commit This skill reviews your working changes and creates a git commit in Conventional Commits format. Use it when you want an agent to make a commit that follows the repository’s message style. CX Codex +1 ★ 353repo stars refactor Runs refactoring as a sequence of small, behavior-preserving steps. Use it when you ask the agent to split a module or remove duplication. CX Codex +1 ★ 353repo stars release-notes Generates release notes and CHANGELOG entries between Git tags or from the latest tag to HEAD using Conventional Commits. CX Codex +1 ★ 353repo stars code-review The code-review skill checks changes in the current branch against main and produces a report with notes on correctness, security, tests, and readability. CX Codex +1 ★ 353repo stars

Project sponsors

Companies that keep this analytics open