Agent skill

Onboard

by Houseofmvps in Houseofmvps/ultraship

Instant Project Onboarding — generate a complete onboarding guide for any project.

MITAuto-check: notesDevelopment

Install Onboard

skills CLI
$ npx skills add Houseofmvps/ultraship --skill onboard -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install Houseofmvps/ultraship onboard --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/Houseofmvps/ultraship.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/onboard .claude/skills/onboard && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
onboard
GitHub stars
123
Token cost
~601 tokens
SKILL.md length
192 words
Files
1
Skills in repo
28
Repo updated
First seen
Licence
MIT

At a glance

Instant Project Onboarding — generate a complete onboarding guide for any project.

  • Works in 3 steps: Analyze → Present Onboarding Guide → Save Onboarding Doc
  • User wants to onboard a new developer
  • SKILL.md covers Process, Getting Started, Key Files and API Routes, plus 2 more sections
  • Calls node

What it does

Onboard is an agent skill from Houseofmvps/ultraship. 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.

Its SKILL.md is about 600 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Project scaffolding. The repository describes itself as: "ULTRASHIP" Claude Code plugin — 39 skills, 33 tools, 11 agents for ship-ready workflows: planning, review, pentesting, safety guardrails, canary monitoring, SEO/AI-readiness… The licence is MIT.

When your agent uses it

  • User wants to onboard a new developer
  • Understand a new codebase
  • Generate project documentation

Example prompts

  • “/onboard”

Requirements

  • Pre-approved tools (allowed-tools): Bash, Read, Grep, Glob, Write

Workflow steps

3 steps, taken from the step headings in SKILL.md.

  1. Analyze
  2. Present Onboarding Guide
  3. Save Onboarding Doc

What it can do on your machine

Read from SKILL.md and the folder at commit ed232cb. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Bash
    • Read
    • Grep
    • Glob
    • Write

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • node

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Onboard loads about 601 tokens when it runs. Until then it costs about 50 tokens; SKILL.md has 192 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~50
When it runs · the whole SKILL.md, loaded when a task matches
~601

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NoteMentions a .env fileSKILL.md:36
    3. Environment setup (.env vars with descriptions)
  • NotePre-approves every shell command (allowed-tools: Bash)SKILL.md
    allowed-tools: Bash, Read, Grep, Glob, Write

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from Houseofmvps/ultraship at commit ed232cb, republished under its MIT licence (© Houseofmvps). 192 words, ~601 tokens.

Download SKILL.mdSave it as .claude/skills/onboard/SKILL.md (or your agent's skills folder).
name
onboard
description
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.
allowed-tools
Bash, Read, Grep, Glob, Write

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:

  1. Prerequisites (runtime, package manager, databases)
  2. Clone and install steps
  3. Environment setup (.env vars with descriptions)
  4. Run the dev server
  5. 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.

© Houseofmvps, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in skills/onboard of Houseofmvps/ultraship.

Open the folder on GitHubat commit ed232cb

Compare with similar skills

Onboard next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Onboard compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Onboard this skillHouseofmvps/ultraship123—~601Automated safety check: NotesMIT
Nx Generatenomcopter/react-mosaic4.8k7 repos~1.9kAutomated safety check: PassCustom licence
PonytailDavidObando/gsharp5648 repos~1.7kAutomated safety check: PassMIT
Run Nx Generatornrwl/nx29k2 repos~592Automated safety check: NotesMIT
Conductor Setupgemini-cli-extensions/conductor3.8k—~4.2kAutomated safety check: PassApache-2.0
Mirage VFS Adapter Authoringstrukto-ai/mirage3.7k—~2.5kAutomated safety check: PassApache-2.0

Similar skills

  • Nx Generate

    nomcopter/react-mosaic

    Generate code using nx generators. An agent skill from nomcopter/react-mosaic.

    4.8k GitHub starsUsed in 7 repos~1.9k tokens
    DevelopmentAuto-check passed
  • Ponytail

    DavidObando/gsharp

    Forces the laziest solution that actually works, simplest, shortest, most minimal.

    564 GitHub starsUsed in 8 repos~1.7k tokens
    DevelopmentAuto-check passed
  • Run Nx generators with prioritization for workspace-plugin generators.

    29k GitHub starsUsed in 2 repos~592 tokens
    DevelopmentAuto-check: notes
  • Conductor Setup

    gemini-cli-extensions/conductor

    Scaffolds the project and sets up the Conductor environment.

    3.8k GitHub stars~4.2k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed
  • Builds or extends a custom Mirage virtual filesystem adapter for an API, database, object store or app data, with a working mount configuration and filesystem tests.

    3.7k GitHub stars~2.5k tokensUpdated today
    DevelopmentAuto-check passed
  • Enforces this repository's TypeScript backend module architecture under server/: feature folders, barrel exports, and where shared types and utilities belong.

    14k GitHub stars~1.2k tokensUpdated yesterday
    DevelopmentAuto-check passed

More from Houseofmvps/ultraship

All 28 skills in this repo
  • Using Ultraship

    Houseofmvps/ultraship

    A skill your agent uses when starting any conversation - establishes how to find and use skills, requiring Skill tool invocation before ANY response including clarifying questions

    123 GitHub stars~2.2k tokensUpdated 3 mo ago
    Auto-check passed
  • A11y

    Houseofmvps/ultraship

    Accessibility audit + auto-fix (WCAG 2.2 A/AA). An agent skill from Houseofmvps/ultraship.

    123 GitHub stars~1.2k tokensUpdated 3 mo ago
    Auto-check: notes
  • Architecture

    Houseofmvps/ultraship

    Living Architecture Map — auto-generate Mermaid diagrams of your codebase.

    123 GitHub stars~708 tokensUpdated 3 mo ago
    Auto-check: notes
  • Clone Patterns

    Houseofmvps/ultraship

    Learn From the Best — analyze patterns from any codebase and apply them to yours.

    123 GitHub stars~682 tokensUpdated 3 mo ago
    Auto-check: notes
  • Code Review

    Houseofmvps/ultraship

    Code review with principal-engineer-level depth. An agent skill from Houseofmvps/ultraship.

    123 GitHub stars~1.5k tokensUpdated 3 mo ago
    Auto-check passed
  • Compete

    Houseofmvps/ultraship

    Competitive X-Ray — analyze any competitor URL vs your site.

    123 GitHub stars~1.1k tokensUpdated 3 mo ago
    Auto-check: notes

Categories

Questions about Onboard

What does Onboard do?

Instant Project Onboarding — generate a complete onboarding guide for any project. Onboard is an agent skill from Houseofmvps/ultraship. Instant Project Onboarding — generate a complete onboarding guide for any project.

When should I use Onboard?

Onboard fits situations like: user wants to onboard a new developer; understand a new codebase; generate project documentation.

How do I install Onboard in Claude Code?

Run `npx skills add Houseofmvps/ultraship --skill onboard -a claude-code`. Or copy the skill folder (skills/onboard in Houseofmvps/ultraship) into .claude/skills/onboard in your project. Claude Code loads it when a task matches its description.

How do I install Onboard in Codex?

Run `npx skills add Houseofmvps/ultraship --skill onboard -a codex`. Or copy the skill folder (skills/onboard in Houseofmvps/ultraship) into .agents/skills/onboard in your project. Codex loads it when a task matches its description.

Can I use Onboard in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add Houseofmvps/ultraship --skill onboard -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/onboard, .gemini/skills/onboard, .github/skills/onboard and .opencode/skills/onboard in your project.

What does Onboard need to run?

Going by SKILL.md and its folder, Onboard needs the command-line tools its instructions call (node). Its frontmatter pre-approves these tools: Bash, Read, Grep, Glob, Write.

Does Onboard access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Onboard safe to install?

Our automated static check of SKILL.md found notes only (mentions a .env file; pre-approves every shell command (allowed-tools: bash)), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does Onboard use?

Onboard is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Onboard use?

About 601 tokens (SKILL.md is roughly 2.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Onboard?

Skills that share tags, products or a category with Onboard: Nx Generate (nomcopter/react-mosaic, 4.8k stars), Ponytail (DavidObando/gsharp, 564 stars), Run Nx Generator (nrwl/nx, 29k stars) and Conductor Setup (gemini-cli-extensions/conductor, 3.8k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Onboard?

Houseofmvps (a GitHub user) maintains it in Houseofmvps/ultraship, which has 123 GitHub stars. The repository holds 28 skills in this directory. The repository was last updated on July 8, 2026.

Source: Houseofmvps/ultraship on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.