# Onboard

> Generates project onboarding guides by analyzing the codebase. Produces architecture overview, key file map, common workflows, and "where to look" reference. Use when someone new joins the project or when you need a codebase overview.

- **Type:** Skill
- **Install:** `agentstack add skill-pvnarp-agent-skills-onboard`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [pvnarp](https://agentstack.voostack.com/s/pvnarp)
- **Installs:** 0
- **Category:** [Cloud & Infrastructure](https://agentstack.voostack.com/c/cloud-infrastructure)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [pvnarp](https://github.com/pvnarp)
- **Source:** https://github.com/pvnarp/agent-skills/tree/main/skills/onboard

## Install

```sh
agentstack add skill-pvnarp-agent-skills-onboard
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

# Project Onboarding

Analyze the codebase and produce a guide that answers: "I just cloned this repo. What do I need to know?"

## Step 1: Project Overview

Determine from the codebase:
- **What is this?** (product, library, service, CLI tool, etc.)
- **Who uses it?** (end users, other developers, internal teams)
- **What language/framework?** (detect from files, config, dependencies)
- **How is it structured?** (monorepo, single app, microservices)

## Step 2: Key File Map

Identify the most important files/directories:

```
ENTRY POINTS:
  [file] - [what starts here]

CONFIGURATION:
  [file] - [what it configures]

CORE LOGIC:
  [directory/file] - [what it does]

DATA LAYER:
  [directory/file] - [storage, schemas, migrations]

TESTS:
  [directory] - [test structure]

BUILD / DEPLOY:
  [file] - [how it builds/deploys]
```

## Step 3: Architecture Snapshot

```
[Component A] → [Component B] → [Component C]
                      ↓
               [Data Store]
```

- What are the major components?
- How do they communicate?
- Where does data flow?
- What are the external dependencies?

## Step 4: Common Workflows

### "I want to add a new feature"
1. Where to create files
2. What patterns to follow (look at existing examples)
3. How to test
4. How to submit for review

### "I want to fix a bug"
1. How to reproduce (run locally, logs)
2. Where to look (key modules, common sources of bugs)
3. How to verify the fix

### "I want to understand a feature"
1. Start at [entry point]
2. Follow the call chain through [key files]
3. Data is stored in [data layer]

## Step 5: Gotchas

Things that aren't obvious from reading the code:
- Non-obvious environment requirements
- Implicit dependencies between modules
- Known quirks or workarounds
- "Don't touch this because..." warnings
- Patterns that look wrong but are intentional

## Output Format

```
# [Project Name] - Onboarding Guide

## What Is This
[1-2 sentences]

## Quick Start
[Exact commands to clone, install, run, test]

## Architecture
[Diagram + brief explanation]

## Key Files
[Table of important files and what they do]

## Common Tasks
[Step-by-step for typical workflows]

## Gotchas
[Non-obvious things to know]
```

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [pvnarp](https://github.com/pvnarp)
- **Source:** [pvnarp/agent-skills](https://github.com/pvnarp/agent-skills)
- **License:** MIT

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-pvnarp-agent-skills-onboard
- Seller: https://agentstack.voostack.com/s/pvnarp
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.