Onboard

Community

Houseofmvps

onboard

Instant Project Onboarding — generate a complete onboarding guide for any project. Use when user wants to onboard a new developer, understand a new codebase, or generate project documentation.

Overview

Publisher	Houseofmvps
Repository	`ultraship`
Skill name	`onboard`
Stars	122
Forks	14
Bundled files	Instructions only
License	MIT
Links	Skill source Repository Homepage

Markdown instructions
A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.
Works with any LLM
AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.
Self-contained
Everything the model needs lives in the instructions — no extra files to sync.
Open source
Published by Houseofmvps on GitHub. Read the source before you install it.

Installation

Install the Onboard AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

Open the app and go to Plugins → Skills.
Choose "Install from GitHub".
Paste the skill folder URL below and confirm.
Enable the skill in any chat where you want it available.

Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills

git clone --depth 1 https://github.com/Houseofmvps/ultraship.git /tmp/ultraship
mkdir -p .claude/skills
cp -r /tmp/ultraship/skills/onboard .claude/skills/onboard

Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Onboard in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Onboard on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Onboard is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

Loaded only when it is needed
The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.
Switch models mid-chat
Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Instant Project Onboarding

One command generates everything a new developer needs to be productive in your codebase.

Process

Phase 1: Analyze

bash
node ${CLAUDE_PLUGIN_ROOT}/tools/onboard-generator.mjs <project-directory>

Parse the JSON output.

Phase 2: Present Onboarding Guide

Format the output as a comprehensive onboarding document:

Project Overview:

Name, description, version
Tech stack (with version numbers)
Architecture type (monorepo, single app, fullstack)

Architecture Diagram: Display the Mermaid architecture diagram from the tool output. This gives new developers an instant visual understanding.

Getting Started:

Prerequisites (runtime, package manager, databases)
Clone and install steps
Environment setup (.env vars with descriptions)
Run the dev server
Run tests

Key Files: Table of the most important files and their roles. New developers should read these first.

API Routes: Table of all detected API routes with methods, paths, and source files.

Database:

ORM and migration tool
Schema file location
Table overview
How to run migrations

Recent Activity: Last 10 commits — gives context on what the team is currently working on.

Gotchas: Known issues and common problems new developers encounter.

Phase 3: Save Onboarding Doc

Save the onboarding guide to docs/ONBOARDING.md in the project:

markdown
# [Project Name] — Developer Onboarding

> Auto-generated by Ultraship on [date]

## Overview
...

## Architecture
```mermaid
[diagram]

Getting Started

...

Key Files

...

API Routes

...

Database

...

Gotchas

...



### Phase 4: Identify Knowledge Gaps

After generating the guide, identify areas that need human input:
- Undocumented environment variables
- Missing README sections
- No contributing guidelines
- No architecture decision records (ADRs)

Suggest creating these if they don't exist.

## Key Principle

**30-minute rule.** A new developer should be able to run the project locally within 30 minutes of reading this guide. If they can't, the guide is incomplete.

Frequently asked questions

What does the Onboard AI skill do?

Instant Project Onboarding — generate a complete onboarding guide for any project. Use when user wants to onboard a new developer, understand a new codebase, or generate project documentation.

Why use Onboard on TypingMind?

Because you install it once and use it with any model. Onboard is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Onboard in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/Houseofmvps/ultraship/tree/main/skills/onboard. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Onboard?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Onboard?

As many as you like. As long as a model supports skills, you can use Onboard with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Onboard AI skill free?

Yes. It is published on GitHub by Houseofmvps under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Triage

mattpocock

CommunityPopular

Move issues and external PRs through a state machine of triage roles, categorise, verify, grill if needed, and write agent-ready briefs.

Claude Handoff

Hand the current conversation off to a fresh background agent that picks up the work immediately.

Finishing A Development Branch

obra

CommunityPopular

Use when implementation is complete, all tests pass, and you need to decide how to integrate the work

Receiving Code Review

obra

CommunityPopular

Use when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative…

Overview

Installation

Install in TypingMind

Install in another agent

Use it in TypingMind

Works with any AI model

Skill instructions

Instant Project Onboarding

Process

Phase 1: Analyze

Phase 2: Present Onboarding Guide

Phase 3: Save Onboarding Doc

Getting Started

Key Files

API Routes

Database

Gotchas

Frequently asked questions

Related AI Skills

Set up your own AI workspace now