onboard-repo

Scan repository code, history, and config to scaffold a .goodplan/ project.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/ian97531/goodplan --skill onboard-repo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: onboard-repo
Source: https://github.com/ian97531/goodplan/tree/main/skills/onboard-repo
Command: npx skills add https://github.com/ian97531/goodplan --skill onboard-repo

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Scan an existing repo with code but no .goodplan/ directory and scaffold a complete goodplan project. It extracts conventions, architecture, subsystem maturity, migrations, tech debt, and expertise from repo artifacts (README, git history, config files, gh CLI). Only asks about things that can't be inferred. Not for repos that already have .goodplan/ (use /migrate) or new projects without code (use /create-epic).

Core Features & Use Cases

  • Infers conventions, architecture, subsystem structure, and maturity signals from repo artifacts to scaffold a cohesive goodplan project.
  • Detects migrations and tech debt patterns to plan improvements and future work.
  • Generates actionable metadata and artifacts to bootstrap onboarding, migration planning, and epic creation.

Quick Start

Run onboard this repo to begin scanning code and scaffolding a .goodplan/ directory.

Frequently Asked Questions about onboard-repo

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

FAQPage Schema
How do I scaffold a project from an existing repo with code but no structure?

To scaffold a project from an existing repo, this Skill scans your code, git history, and config files to infer conventions and architecture, then generates a complete .goodplan/ directory with actionable onboarding metadata.

Can I extract architecture and subsystem structure from git history and config files?

Yes, architecture extraction and subsystem structure detection work by analyzing repo artifacts like README files, git history, and config files to identify maturity signals and generate a cohesive project scaffold.

Does this repo onboarding process require a specific goodplan version?

Repo onboarding requires goodplan version 1.0.0 or higher, running pre-flight checks before scanning code and scaffolding the .goodplan directory to ensure compatibility.

When should I not use repo scanning for project bootstrapping?

You should not use repo scanning if the repository already contains a .goodplan/ directory, or if it is a new project without code, as this tool is built exclusively for existing codebases lacking prior scaffolding.

How do I detect migrations and tech debt patterns from repository artifacts?

Migration and tech debt analysis detects patterns by scanning repository artifacts to identify structural debt and migration needs, then presents actionable guidance for planning improvements and future work.

What's the difference between onboarding a repo and migrating an existing goodplan project?

Onboarding a repo scaffolds a new .goodplan directory from raw code artifacts, while migration is for repos that already have a .goodplan directory and need updating rather than initial extraction.