skills/onboard/SKILL.md
Generate a codebase overview for new team members. Produces an architecture summary, key files guide, and conventions reference. Use when someone is new to a project, when the user asks "give me an overview", "explain the architecture", "where do I start?", or "onboard me to this codebase".
npx skillsauth add codewithbehnam/cc-docs onboardInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
git rev-parse --show-toplevel 2>/dev/null || pwdfind . -maxdepth 2 -not -path './.git/*' -not -path './node_modules/*' -not -path './.venv/*' | sortgit shortlog -sn --no-merges -10 2>/dev/null || echo "Not a git repo"git log --oneline -15 2>/dev/null || echo "No git history"find . -maxdepth 2 -name "package.json" -o -name "pyproject.toml" -o -name "go.mod" -o -name "Gemfile" -o -name "pom.xml" | head -10Generate a comprehensive onboarding guide for this codebase. Cover all of the following:
Read key entry points: README.md, CLAUDE.md, main entry files (main.py, index.ts, main.go, app.py, server.js, etc.), and any architecture or design docs
Understand the architecture:
Map the directory structure: Read 2-3 levels deep and explain what each major directory contains and why it exists
Find the key files: For each major layer, identify the 3-5 most important files a new developer should read first
Extract conventions: Look for linting configs, test patterns, naming conventions, and any rules in CLAUDE.md or similar
Identify the development workflow: Check Makefile, scripts/, package.json scripts, CI config for how to build, test, and run the project locally
Produce a guide with these sections:
One paragraph. What problem does this solve? Who uses it?
ASCII diagram of major components and their relationships.
Table: directory path, what it contains, when you would touch it.
Ordered list of files (with paths) and why each one matters.
Step-by-step: install dependencies, configure environment, start the app, run tests.
Bullet list of coding conventions, naming rules, and any "gotchas" unique to this project.
Practical guide: "To add a new API endpoint, edit X. To add a new database table, edit Y. To change the UI theme, look in Z."
tools
macOS GUI automation CLI. Use steer to see the screen, click elements, type text, send hotkeys, scroll, drag, manage windows and apps, run OCR on Electron apps, and wait for UI conditions.
testing
Ship workflow: merge main, run tests, review diff, bump VERSION, update CHANGELOG, commit, push, create PR.
testing
Import cookies from your real browser (Comet, Chrome, Arc, Brave, Edge) into the headless browse session. Opens an interactive picker UI where you select which cookie domains to import. Use before QA testing authenticated pages.
development
Weekly engineering retrospective. Analyzes commit history, work patterns, and code quality metrics with persistent history and trend tracking. Team-aware: breaks down per-person contributions with praise and growth areas.