onboard
Analyze brownfield codebase and create initial continuity ledger
Security Assessment
About onboard
The 'onboard' skill is designed to help developers get up to speed quickly when starting work on an existing or brownfield project. It automates the process of analyzing a project's codebase and generating an initial continuity ledger, providing a structured overview of the project. This eliminates the need for manual exploration and documentation, allowing developers to focus on understanding the project context and moving forward with the work. By creating a continuity ledger, the onboard skill helps users grasp the project’s structure, technology stack, and goals right from the start.
Main features include automated exploration of the codebase, detection of key technologies, and the generation of a YAML handoff file that provides an overview of the project, its architecture, and its current status. The onboard agent runs a series of commands to examine the project structure, identify dependencies, and interact with the user to clarify the goals of the project. It then generates a handoff that can be used for future reference. This agent ensures that the project is understood in its entirety without overwhelming the user with raw code dumps or excessive information.
This skill is ideal for developers and teams who are working on an existing codebase for the first time. It is particularly useful for those taking over a project or working in a brownfield environment where the codebase has already been developed. Common use cases include onboarding new team members, analyzing a codebase before starting to work on new features, or quickly understanding the project’s tech stack and architecture. The onboard skill helps users gain a clear understanding of the project, set priorities, and begin working efficiently.
FAQ
How do I use the onboard skill?
To use the onboard skill, spawn the onboard agent by using the Task tool with the `subagent_type: 'onboard'` and the appropriate prompt. The agent will analyze the codebase, detect the tech stack, and create a YAML handoff file with essential project details.
Can I use the onboard skill for greenfield projects?
No, the onboard skill is specifically designed for brownfield projects (existing code). For greenfield projects, you should use the '/create_plan' skill instead.
What does the onboard skill generate?
The onboard skill generates two main outputs: directories for project handoff (`thoughts/shared/handoffs/<project>/` and `.claude/`), and a YAML handoff file containing details like the project’s tech stack, architecture, goals, and the first suggested action.
Does the onboard skill require any specific file types?
The onboard skill detects the tech stack by searching for common project files such as `package.json`, `requirements.txt`, `Cargo.toml`, and `go.mod`. It works with various project types, including JavaScript, Python, and Go projects.
Can the onboard handoff be updated?
Yes, the onboard handoff can be updated anytime using the `/create_handoff` skill.
Install onboard
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
parcadei/Continuous-Claude-v2