onboard

Discover repository structure and classify project shape for AI-OS documentation.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/Z5Jonathan-maker/ai-coding-os --skill onboard-z5jonathan-maker
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: onboard
Source: https://github.com/Z5Jonathan-maker/ai-coding-os/tree/main/claude/skills/onboard
Command: npx skills add https://github.com/Z5Jonathan-maker/ai-coding-os --skill onboard-z5jonathan-maker

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It solves the problem of bringing an existing messy codebase onto the repo’s Claude Code “AI-OS” conventions without losing project-specific reality or overriding human edits.

Core Features & Use Cases

  • Project discovery + shape classification: Inspects the existing repository (stack, structure, presence of auth/DB/API patterns) and states the dominant shape (marketing, CRM, e-commerce, SaaS, API, library, monorepo, mobile).
  • Documentation that reflects the actual code: Generates scoped specialist guidance in CLAUDE.md and a durable project constitution in AGENTS.md, plus checkpoint docs like SESSION-HANDOFF.md and supporting memory scaffolding for /.ai and /docs/ai-memory/.
  • Idempotent updates with safety for user-edited files: Re-running updates docs by reading first and merging/appending rather than clobbering user-edited content.
  • Brownfield workflow for existing projects: Intended for rehabilitation tasks where the project already exists and may be outdated or inconsistent, unlike greenfield editorial setup.

Quick Start

Run this skill by saying: onboard this project.

Frequently Asked Questions about onboard

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate Claude Code documentation for an existing messy codebase?

To generate Claude Code documentation for an existing messy codebase, you can use an onboarding workflow that inspects your repository structure and creates scoped specialist docs like CLAUDE.md and AGENTS.md. This process rehabilitates your project into AI-OS conventions by reflecting the actual code rather than applying generic templates.

What is the best way to create a session handoff document for AI agents?

Creating a session handoff document for AI agents involves generating a SESSION-HANDOFF.md file alongside durable project constitutions like AGENTS.md. This establishes AI-OS memory scaffolding within directories such as docs/ai-memory and .ai, ensuring continuous context across different development sessions.

Can I update AI project documentation without overwriting my manual edits?

You can update AI project documentation without overwriting manual edits by using an idempotent update mechanism. This approach reads existing files first and performs merge-safe appending or merging rather than clobbering user-edited content during repository rehabilitation.

How do I classify the project shape of a brownfield repository?

Classifying the project shape of a brownfield repository requires inspecting the existing stack, structure, and presence of auth/DB/API patterns. This discovery process identifies the dominant shape, such as marketing, CRM, e-commerce, SaaS, API, library, monorepo, or mobile app.

Does repo onboarding work for backend APIs and monorepos?

Repo onboarding does work for backend APIs and monorepos, alongside marketing sites, CRMs, SaaS, libraries, and mobile apps. The system applies rehabilitation workflows to ensure the generated documentation and routing conventions accurately reflect the real code of these diverse project shapes.